Feil i dokumentasjonen

[tuxbear]

Heisann!

Det er en lenke som heter "Teknisk API-dokumentasjon for tjenesteeiere" på denne siden:
https://altinn.github.io/docs/api/tjenesteeiere/rest/

Den lenken peker på denne siden: https://www.altinn.no/api/serviceowner/Help
som er ufullstending sammenlignet med https://www.altinn.no/api/Help
( På den siden er det ikke noe informasjon om begresningene på endepunktene, for eksempel)

Vær så snill å drep denne siden: https://www.altinn.no/api/serviceowner/Help

[SandGrainOne]

Hei @tuxbear.
Altinn har to APIer tilpasset hver sin brukergruppe. https://www.altinn.no/api/serviceowner/Help dokumenterer et API laget for tjenesteeiere mens https://www.altinn.no/api/Help dokumenterer et API for sluttbrukere. De to APIene har derfor store forskjeller selv om de ofte benytter de samme begrepene og resursbetegnelsene.

Håper det forklarer behovet for begge sidene.

[tuxbear]

Da forstår jeg behovet for de to sidene, de er så like at jeg forvekslet dem (et problem i seg selv). Men når dette er tilfelle må dokumentasjonen for tjenesteeiere utbedres. Beskrivelsen av begrensningene i APIet er ikke beskrevet der, så man blir villedet til å tro at disse ikke gjelder for tjenesteeiere. Men det gjør de altså, som flere på NAV har fått oppleve å bruke unødig tid på å finne ut av.

Det er ugreit å lukke denne saken uten å utbedre dokumentasjonen for tjenesteeiere.

[altinnadmin]

@SandGrainOne @erlendoksvoll Er det noen god grunn til at begrensningene ikke er dokumentert for tjenesteeier-APIet? Hvis ikke så har @tuxbear et poeng.

Når det er sagt så skal vi jo i følge vår egen roadmap erstatte denne dokumentasjonen med OpenAPI/swagger ganske snart...?
https://altinn.github.io/docs/ny-funksjonalitet/roadmap/2020/#erstatte-api-help-med-dokumentasjon-på-altinn-docs

[erlendoksvoll]

Det er litt uklart for meg hva som er problemet her. Er det noe spesifikt som mangler på serviceowner/help? Eller i github-doken?

[tuxbear]

Heisann, beklager sent svar. Det kritiske som mangler er den nederste delen

Operations with support for OData queries will be set to a maximum page size of 50 elements, and to display all elements the external application using the api must enable paging. Paging in OData is done by passing the parameter $skip={number of elements to skip}.

Det er inkludert helt nederst på denne siden https://www.altinn.no/api/Help
Men ikke på denne siden: https://www.altinn.no/api/serviceowner/Help

Våre brukere fikk dermed bare opp de første 50 rettighetene sine i Altinn, og i alt koronakaoset var det ikke mye tid til testing på vår side så vi hadde ikke testet med brukere med mange rettigheter.

[altinnadmin]

@erlendoksvoll How do you want to handle this?
I guess this issue should be closed (since this is not a bug in the docs-repo), and an internal issue should be created for https://www.altinn.no/api/serviceowner/Help ?

[altinnadmin]

Og beklager at det plutselig ble engelsk, gammel vane fra https://github.com/Altinn/altinn-studio/issues :)

[erlendoksvoll]

Dette burde vi jo klare å fikse :)