Skip to content

Voeg regel toe voor het documenteren van custom headers #282

@TimvdLippe

Description

@TimvdLippe

Op basis van developer-overheid-nl/don-api-register#32 (comment)

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.

Als je niet van het bestaan weet van de custom headers, dan kan dat ervoor zorgen dat consumers er om heen gaan werken of aparte oplossingen bedenken.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions