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/version-header #627

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

Testscenario /core/version-header #627

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 1: A request to the base url MUST give a response and include the header "API-Version".

Er wordt hier uitgegaan van de base url, welke mogelijk niet in scope is van de API zelf en derhalve ingewikkeld kan zijn om te voorzien van een custom response header. Bovendien garandeert dit niet dat alle responses zijn voorzien van deze header en in semver formaat wordt teruggegeven.

"How to test" zou kunnen zijn dat elke call binnen scope van de API de API-Version header bevat en voldoet aan het semver formaat. Dit is de verantwoordelijkheid van de provider zelf.

"How the ADR Validator tests this" kan middels de aanwezigheid van de API-Version header bij elke operatie in de OAS, en of deze het semver formaat hanteert.

Zie ook #628 en #626.
@mrtn78 mrtn78 added this to the ADR v2.0.1 milestone Nov 8, 2024
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 added WG: Normatieve rules issues regarding the normative part of the API design rules Status: proposal proposal for change, to be discussed in wg labels Nov 26, 2024
@mrtn78 mrtn78 self-assigned this Nov 26, 2024
@mrtn78 mrtn78 added the STD: ADR Standaard: API Design Rules label 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