Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatic info-page (metadata) for apps #760

Open
Tracked by #84
altinnadmin opened this issue Sep 10, 2024 · 1 comment
Open
Tracked by #84

Automatic info-page (metadata) for apps #760

altinnadmin opened this issue Sep 10, 2024 · 1 comment
Assignees
Labels

Comments

@altinnadmin
Copy link
Member

altinnadmin commented Sep 10, 2024

Description

When an app is deployed, it should expose a new page /info or /metadata that does not require authentication, and that is cached in memory.

This page should display information that is relevant for systems (SBS) that needs to use the app API.

  • Documentation from service owner relevant for clients (SBS) (README.md or a special info file in repo)
  • Swagger UI for APIs relevant for end user systems
  • Metadata (app name, required security level, last updated, etc)
  • Links to data models, auth policy (XACML), process (BPMN), Studio repo, etc

Future expansions of this page could be rendering of process, automatic generation of documentation for how to use the APIs based on process steps, strongly typed Swagger (based on data models).

Why?

  • Self-serve. Service owner can maintain the documentation for their apps. Simple link from service catalog in info.altinn.no, no need for stuff in altinndigital
  • Important for the project and SBS that documentation is good, updated and easily available
  • Solves Simplified app swagger and documentation for end user systems #692 in a better way

Additional Information

No response

@altinnadmin
Copy link
Member Author

@lvbachmann Ref. task in project

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: No status
Development

No branches or pull requests

2 participants