Voeg meer http methods toe aan core/http-methods #223
Conversation
Hiermee maken we het expliciet dat ook de HTTP methods die enkel (metadata) informatie ophalen toegestaan zijn. Deze methoden maken geen wijzigingen of lezen resources uit, maar kunnen gebruikt worden om informatie over het endpoint zelf uit te lezen.
TimvdLippe
added
Scope: Klein
|
De regel is geen white list van toegestane methods. Enkel onjuist gebruik van methods is niet toegestaan (lastig te testen met enkel openapi.json). Als we toch overgaan naar een white list lijkt |
|
Op basis van ons gesprek heb ik de lijst nu optioneel gemaakt en non-exhaustive. Daarmee laten we het open, maar geven we ook expliciet de meest gebruikte methodes aan. Tevens heb ik wat informatie die in de "note" stond in het statement gezet, om zo de normatieve regels en de verduidelijking te scheiden van elkaar. |
TimvdLippe
added
Status: Ter goedkeuring
…onal-http-methods
|
Actiepunt van TO: @sanderke HTTP RFC opnieuw lezen en kijken wat de intentie is. Tevens inlezen op OpenAPI 3.2 waar meer methoden worden toegevoegd (OAI/OpenAPI-Specification#1747) |
| <div class="note"> | ||
| <p>The HTTP specification [[rfc9110]] offers a set of standard methods, where every method is designed with explicit semantics. | ||
| The OpenAPI Specification 3.0 <a href="https://spec.openapis.org/oas/v3.0.1#path-item-object">Path Item Object</a> also supports these methods, except for <code>CONNECT</code>. | ||
| <p>In addition to the standard HTTP methods, a server may support other optional methods as well, e.g. <code>PROPFIND</code>, <code>COPY</code>, <code>PURGE</code>, <code>VIEW</code>, <code>LINK</code>, <code>UNLINK</code>, <code>LOCK</code>, <code>UNLOCK</code>, etc. |
There was a problem hiding this comment.
| <p>In addition to the standard HTTP methods, a server may support other optional methods as well, e.g. <code>PROPFIND</code>, <code>COPY</code>, <code>PURGE</code>, <code>VIEW</code>, <code>LINK</code>, <code>UNLINK</code>, <code>LOCK</code>, <code>UNLOCK</code>, etc. | |
| <p>In addition to the standard HTTP methods, a server may support other optional methods as well, e.g. <code>PROPFIND</code>, <code>COPY</code>, <code>PURGE</code>, <code>VIEW</code>, <code>LINK</code>, <code>UNLINK</code>, <code>LOCK</code>, <code>UNLOCK</code>, etc. Additional methods MAY be documented using OpenAPI 3.2 while preserving these semantics defined in [rfc9110]. |
There was a problem hiding this comment.
Ik weet niet of we hier al kunnen verwijzen naar 3.2. Misschien kunnen we dit in een niet-normatieve noot toevoegen van "dit komt er in de toekomst aan"?
Co-authored-by: Alexander Green <[email protected]>
Hiermee maken we het expliciet dat ook de HTTP methods die enkel (metadata) informatie ophalen toegestaan zijn. Deze methoden maken geen wijzigingen of lezen resources uit, maar kunnen gebruikt worden om informatie over het endpoint zelf uit te lezen.
Fixes Geonovum/KP-APIs#633