Simplified app swagger and documentation for end user systems - Githubissues

Altinn / app-lib-dotnet

Libraries used in Altinn Apps

BSD 3-Clause "New" or "Revised" License

8 stars 10 forks source link

Simplified app swagger and documentation for end user systems #692

Open altinnadmin opened 3 months ago

altinnadmin commented 3 months ago

Description

Currently we provide one huge swagger for apps, and for end user systems this can be a little daunting.

I propose the following improvements:

[ ] Create a simplified swagger with only the APIs relevant for SBS, and expose this in docs.altinn.studio alongside the complete swagger
[ ] Translate the SBS guide and expose it on both Norwegian and English docs.altinn.studio. Currently it´s in Norwegian but only exposed in the English site. VERY confusing... :)
[ ] Display the simplified swagger inline in the guide (for both languages)

Additional Information

This is important for SBS and the project, I guess we should link to the guide from here as well? @lvbachmann https://samarbeid.digdir.no/altinn/sluttbrukersystem/2340

lvbachmann commented 3 months ago

This is important for SBS and the project, I guess we should link to the guide from here as well? @lvbachmann https://samarbeid.digdir.no/altinn/sluttbrukersystem/2340

The page in question is due for a rehaul within the next few days. Adding the guide will be part of said rehaul.