Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Testscenario /core/semver klopt niet #626

Open
dvh opened this issue Oct 24, 2024 · 0 comments
Open

Testscenario /core/semver klopt niet #626

dvh opened this issue Oct 24, 2024 · 0 comments
Assignees
@mrtn78
Labels
Status: proposal proposal for change, to be discussed in wg STD: ADR Standaard: API Design Rules WG: Normatieve rules issues regarding the normative part of the API design rules
Milestone
ADR v2.0.1

Comments

@dvh
Copy link
Collaborator

dvh commented Oct 24, 2024 •
edited
Loading

Step 2: In the open api specification the info and version object MUST be available.
Step 3: The version MUST comply with Semantic Versioning.

In dit testscenario wordt uitgegaan van info.version als API versie. Dit is echter onjuist; info.version gaat over de versie van het OAS document zèlf (zie: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-1). Deze kan bijvoorbeeld geüpdate worden als er extra examples toegevoegd worden of descriptions gewijzigd worden.

Informatie over de (huidige) versie van de API is nog niet geborgd, en zou m.i. onderdeel moeten uitmaken van #622.

De enige manier om automatisch te kunnen testen of Semantic Versioning is toegepast is via de API-Version header. Dit kan automatisch getest worden door de aanwezigheid van deze header in OAS, en te kijken of de response string aan een semver regex voldoet.

Zie ook #628
@dvh dvh mentioned this issue Oct 24, 2024
Open
@mrtn78 mrtn78 added this to the ADR v2.0.1 milestone Nov 8, 2024
@dvh dvh mentioned this issue Nov 25, 2024
Open
mrtn78 added a commit to Logius-standaarden/API-Design-Rules that referenced this issue Nov 26, 2024
@mrtn78
API Version-header en SemVer
e1a7894 
verbetering van de how to test in relatie tot
Geonovum/KP-APIs#626
Geonovum/KP-APIs#627
@mrtn78 mrtn78 self-assigned this Nov 26, 2024
@mrtn78 mrtn78 added WG: Normatieve rules issues regarding the normative part of the API design rules Status: proposal proposal for change, to be discussed in wg STD: ADR Standaard: API Design Rules labels Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mrtn78 mrtn78

Labels
Status: proposal proposal for change, to be discussed in wg STD: ADR Standaard: API Design Rules WG: Normatieve rules issues regarding the normative part of the API design rules
Projects
None yet
Milestone
ADR v2.0.1
Development

No branches or pull requests
2 participants
@mrtn78 @dvh