Skip to content

Commit b01451a

Browse files
authored
Beheer: gebruik hoofdletters for RFCs (#306)
Dit is consistent met hoe IETF refereert naar RFCs
1 parent c1a91f9 commit b01451a

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

sections/designRules.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -216,15 +216,15 @@ https://api.example.org/v1/vergunningen/d285e05c-6b01-45c3-92d8-5e19a946b66f</pr
216216

217217
## HTTP methods
218218

219-
Although the REST architectural style does not impose a specific protocol, REST APIs are typically implemented using HTTP [[rfc9110]].
219+
Although the REST architectural style does not impose a specific protocol, REST APIs are typically implemented using HTTP [[RFC9110]].
220220

221221
<span id="api-03"></span>
222222
<div class="rule" id="/core/http-methods" data-type="functional">
223223
<p class="rulelab">Only apply standard HTTP methods</p>
224224
<dl>
225225
<dt>Statement</dt>
226226
<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]].
228228
</dd>
229229
<dt>Rationale</dt>
230230
<dd>
@@ -302,7 +302,7 @@ Although the REST architectural style does not impose a specific protocol, REST
302302
</tbody>
303303
</table>
304304
</aside>
305-
<p class="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+
<p class="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>
306306
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>.<br>
307307
According to <a href="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>
308308
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
372372
<dt>Rationale</dt>
373373
<dd>
374374
<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.
376376
</p>
377377
<p>
378378
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
386386
<dl>
387387
<dt>Statement</dt>
388388
<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.
390390
</dd>
391391
<dt>Rationale</dt>
392392
<dd>
@@ -772,7 +772,7 @@ This section contains elements that apply to the generic classes of clients list
772772
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.
773773

774774
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.
776776
For browser-based applications a subsection is included with additional details and information.
777777
System-to-system (sometimes called machine-to-machine) may have a need for the listed specifications as well.
778778
Note that different usage patterns may be applicable in contexts with system-to-system clients, see above under Client Authentication.

sections/glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<dfn>URI</dfn>
2424
</dt>
2525
<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.
2727
</dd>
2828
<dt>
2929
<dfn>OGC</dfn>

0 commit comments

Comments
 (0)