Repository navigation
Enforceer informatie van servers #208
Description
Voor developer.overheid.nl is het relevant om te weten welke servers voor productie bedoeld zijn en welke voor testing/staging. We geven hier nu eigenlijk al een hint voor in https://logius-standaarden.github.io/API-Design-Rules/#/core/uri-version waar het voorbeeld al dit toevoegt aan de description.
Helaas staat OpenAPI niets anders toen dan de URL, description en parameters. Dus deze informatie zou enkel passen in de description. Als we dit een enum maken (dus de string moet een van geselecteerde opties zijn), dan kan dit automatisch worden gededuceerd.
Veel API's doen dit al, maar de string is niet standaard en daardoor niet te analyseren.
Activity
Beheer: voeg extra testcase toe voor servers die missen
Beheer: voeg extra testcase toe voor servers die missen (#274)
TimvdLippe commentedon Jan 28, 2026
Een eerste stap kan worden gemaakt met #294 Bij het doorlezen van de OpenAPI specification kwam ik ook tegen dat een server object extensies toe staat: https://spec.openapis.org/oas/v3.2.0.html#specification-extensions We zouden dus met een
x-notatie extra informatie kunnen vastleggen over production/pre-production, etc... Of we kunnen onderzoeken of we dit kunnen upstreamen naar OpenAPI zelf.