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.

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

Testscenario /core/http-methods #629

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

Testscenario /core/http-methods #629

dvh opened this issue Oct 24, 2024 · 0 comments
Assignees
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

Comments

@dvh
Copy link
Collaborator

dvh commented Oct 24, 2024

Stap 1 van alle 3 scenario's gaat uit van een valid OAS. Zoals ook in de Note beschreven is, staat OAS alleen GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS en TRACE toe. Als een andere method als scope van de API wordt gedefinieerd is de OAS niet valid, dus kan stap 2 van de scenario's niet uitgevoerd worden.

Genoemde RFC 7231 gaat over het HTTP protocol an sich, en is niet per se onderdeel van de scope van de API. Een request buiten de scope van de API zegt dus niets over de API Design Rules; we mogen niet verwachten dat bijvoorbeeld een bovenliggende infrastructuur laag wordt aangepast om een ADR test te kunnen laten slagen die bovendien niets zegt over het doel van de regel, in dit geval "gebruik geen exotische methods, maar gewoon de gangbare" (zelfde motivatie als OAS hanteert).

"How to test" is in deze context dan ook niets anders dan "zorg ervoor dat OAS valid is", en dit kan ook automatisch zo getest worden door de ADR validator.

Zie ook #628

@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 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
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
Development

No branches or pull requests

2 participants