Pagination bevat geen informatie over totale set van apis

[TimvdLippe]

Voor het v1/apis endpoint is er gebruik gemaakt van pagination. Dit geeft een array terug van alle API definities uit het register. Echter kan ik niet zien hoeveel er in totaal in de set staan. Ik kan wel met de query parameter aangeven dat ik er 50 per keer terug wil krijgen en welke page specifiek, maar het totaal aantal pagina's staat er niet.

Kan dit worden toegevoegd aan een object, waar de array in data staat en de informatie over pagination in pagination?

[TimvdLippe]

De Python code die ik nu moet gebruiken om ze te downloaden:

page = 0
apis_in_api_register = []
while True:
    try:
        apis_in_page = requests.get(API_REGISTER_API_ENDPOINT, verify=False, headers=API_REGISTER_HEADERS, params={'perPage': '50', 'page': page})
        page += 1
        apis = apis_in_page.json()
        if len(apis) is 0:
            break
        apis_in_api_register.extend(apis)
    except urllib.error.HTTPError as http_error:
        break

[MrSkippy]

In de Headers staat:

Name	Value
x-current-page	1
x-per-page	10
x-total-count	223
x-total-pages	23

en een link met de pagination links

Kan je daar wat mee?

[TimvdLippe]

Ah die stonden niet in de openapi.json (https://redocly.github.io/redoc/?url=https://api.don.apps.digilab.network/api-register/v1/openapi.json#tag/Publieke-endpoints/operation/listApis) dus ik wist niet dat dat kon. Ik zal mijn scriptjes volgende week updaten en testen met die headers 👍

[TimvdLippe]

Yes die headers werken en ik heb de scripts geupdate: Logius-standaarden/api-linter-impactanalyse@8671d7c Kunnen jullie de openapi.json updaten zodat dit in de documentatie staat?

[MrSkippy]

@pasibun Kan je de openapi.json updaten?

[dvh]

@TimvdLippe in het verlengde hiervan denk ik dat het goed is om in de ADR op te nemen dat custom headers voor consumers (zoals deze paginerings headers) expliciet te vermelden in OAS. Eerder is er discussie geweest over het wel of niet teruggeven van de api-version header in de spec (met de overgang van validator naar oas checker) onder het mom "maar dan moeten we alle headers van teruggeven". M.i. hoeft dat niet, tenzij het specifiek bedacht is voor de consumer die er tegenaan moet programmeren, zoals nu.

[TimvdLippe]

Goed idee, daar heb ik Logius-standaarden/API-Design-Rules#282 voor aangemaakt.