Skip to content

Enforceer informatie van servers #208

@TimvdLippe

Description

@TimvdLippe

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Scope: KleinKleine wijzigingen met beperkte scopeStatus: In onderzoekTer voorbereiding van uitwerking is onderzoek nodig.Type: WijzigingInhoudelijke wijziging op een standaard

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions