You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pclass="rulelab">Only apply standard HTTP methods</p>
224
224
<dl>
225
225
<dt>Statement</dt>
226
226
<dd>
227
-
An API MUST adhere to the HTTP method semantics defined in [[rfc9110]].
227
+
An API MUST adhere to the HTTP method semantics defined in [[RFC9110]].
228
228
</dd>
229
229
<dt>Rationale</dt>
230
230
<dd>
@@ -302,7 +302,7 @@ Although the REST architectural style does not impose a specific protocol, REST
302
302
</tbody>
303
303
</table>
304
304
</aside>
305
-
<pclass="note">The HTTP specification [[rfc9110]] offers a set of standard methods, where every method is designed with explicit semantics. HTTP also defines other methods, e.g. <code>HEAD</code>, <code>OPTIONS</code>, <code>TRACE</code>, and <code>CONNECT</code>.<br>
305
+
<pclass="note">The HTTP specification [[RFC9110]] offers a set of standard methods, where every method is designed with explicit semantics. HTTP also defines other methods, e.g. <code>HEAD</code>, <code>OPTIONS</code>, <code>TRACE</code>, and <code>CONNECT</code>.<br>
306
306
The OpenAPI Specification 3.0 <ahref="https://spec.openapis.org/oas/v3.0.1#path-item-object">Path Item Object</a> also supports these methods, except for <code>CONNECT</code>.<br>
307
307
According to <ahref="https://www.rfc-editor.org/rfc/rfc9110#name-overview">RFC 9110 9.1</a> the <code>GET</code> and <code>HEAD</code> HTTP methods MUST be supported by the server, all other methods are optional.<br>
308
308
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.<br>
@@ -372,7 +372,7 @@ Although the REST architectural style does not impose a specific protocol, REST
372
372
<dt>Rationale</dt>
373
373
<dd>
374
374
<p>
375
-
The HTTP protocol [[rfc9110]] specifies whether an HTTP method SHOULD be considered safe and/or idempotent. These characteristics are important for clients and middleware applications, because they SHOULD be taken into account when implementing caching and fault tolerance strategies.
375
+
The HTTP protocol [[RFC9110]] specifies whether an HTTP method SHOULD be considered safe and/or idempotent. These characteristics are important for clients and middleware applications, because they SHOULD be taken into account when implementing caching and fault tolerance strategies.
376
376
</p>
377
377
<p>
378
378
Request methods are considered <i>safe</i> if their defined semantics are essentially read-only; i.e., the client does not request, and does not expect, any state change on the origin server as a result of applying a safe method to a target resource. A request method is considered <i>idempotent</i> if the intended effect on the server of multiple identical requests with that method is the same as the effect for a single such request.
@@ -386,7 +386,7 @@ Although the REST architectural style does not impose a specific protocol, REST
386
386
<dl>
387
387
<dt>Statement</dt>
388
388
<dd>
389
-
An API MUST use the semantically appropriate HTTP <a href="https://www.rfc-editor.org/rfc/rfc9110#name-status-codes">status code</a> ([[rfc9110]]) for the response.
389
+
An API MUST use the semantically appropriate HTTP <a href="https://www.rfc-editor.org/rfc/rfc9110#name-status-codes">status code</a> ([[RFC9110]]) for the response.
390
390
</dd>
391
391
<dt>Rationale</dt>
392
392
<dd>
@@ -772,7 +772,7 @@ This section contains elements that apply to the generic classes of clients list
772
772
Although not every client implementation has a need for all the specifications referenced below, a client agnostic API SHOULD provide these to facilitate any client to implement relevant security controls.
773
773
774
774
Most specifications referenced in this section are applicable to the first three classes of clients listed above.
775
-
Security considerations for native applications are provided in [[[rfc8252]]], much of which can help non-OAuth2 based implementations as well.
775
+
Security considerations for native applications are provided in [[[RFC8252]]], much of which can help non-OAuth2 based implementations as well.
776
776
For browser-based applications a subsection is included with additional details and information.
777
777
System-to-system (sometimes called machine-to-machine) may have a need for the listed specifications as well.
778
778
Note that different usage patterns may be applicable in contexts with system-to-system clients, see above under Client Authentication.
Copy file name to clipboardExpand all lines: sections/glossary.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@
23
23
<dfn>URI</dfn>
24
24
</dt>
25
25
<dd>
26
-
A URI [[rfc3986]] (Uniform Resource Identifier) is a string that identifies a resource. URIs are intended to be unique across the web, allowing resources to be unambiguously referenced.
26
+
A URI [[RFC3986]] (Uniform Resource Identifier) is a string that identifies a resource. URIs are intended to be unique across the web, allowing resources to be unambiguously referenced.
0 commit comments