Skip to content

Commit d21194a

Browse files
mrtn78TimvdLippe
andcommitted
Beheer: update links naar standaarden en modules (#152)
Hiermee specificeren we de exacte minor versie van de modules die in de core zitten. Daarmee voldoen we aan de eis dat standaarden op de PTOLU lijst enkel vastgestelde documenten verwijzen en geen werkversies of versies gepubliceerd in de toekomst. Tevens refereren we naar OpenApis 3.0, dus zonder de patch versie, om zo consistent te zijn met de huidige staat van de PTOLU. --------- Co-authored-by: Tim van der Lippe <TimvdLippe@users.noreply.github.com>
1 parent 5e48b03 commit d21194a

3 files changed

Lines changed: 22 additions & 21 deletions

File tree

DesignRules.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ Although the REST architectural style does not impose a specific protocol, REST
234234
</table>
235235
</div>
236236
<p class="note">The HTTP specification [[rfc7231]] and the later introduced <code>PATCH</code> method specification [[rfc5789]] offer 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>
237-
The OpenAPI Specification 3.x <a href="https://spec.openapis.org/oas/v3.0.3#path-item-object">Path Item Object</a> also supports these methods, except for <code>CONNECT</code>.<br>
237+
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>
238238
According to <a href="https://datatracker.ietf.org/doc/html/rfc7231#section-4.1">RFC 7231 4.1</a> the <code>GET</code> and <code>HEAD</code> HTTP methods MUST be supported by the server, all other methods are optional.<br>
239239
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>
240240
If an optional HTTP request method is sent to a server and the server does not support that HTTP method for the target resource, an HTTP status code <code>405 Method Not Allowed</code> shall be returned and a list of allowed methods for the target resource shall be provided in the <code>Allow</code> header in the response as stated in <a href="https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.5">RFC 7231 6.5.5</a>.</p>
@@ -640,7 +640,7 @@ Transport security is essential to safeguard the confidentiality, integrity, and
640640
<dl>
641641
<dt>Statement</dt>
642642
<dd>
643-
The [[[ADR-TS]]] MUST be applied.
643+
The [[[ADR-TS]]] version 1.0.x MUST be applied.
644644
</dd>
645645
<dt>Rationale</dt>
646646
<dd>
@@ -666,7 +666,7 @@ Geospatial data refers to information that is associated with a physical locatio
666666
<dl>
667667
<dt>Statement</dt>
668668
<dd>
669-
The [[[ADR-GEO]]] MUST be applied when providing geospatial data or functionality.
669+
The [[[ADR-GEO]]] version 1.0.x MUST be applied when providing geospatial data or functionality.
670670
</dd>
671671
<dt>Rationale</dt>
672672
<dd>

Introduction.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ The Nederlandse API Strategie consists of [a set of distinct documents](https://
2525
| Informative | [Inleiding NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Inleiding/) |
2626
| Informative | [Architectuur NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Architectuur/) |
2727
| Informative | [Gebruikerswensen NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Gebruikerswensen/) |
28-
| Normative | [API Design Rules (ADR)](https://publicatie.centrumvoorstandaarden.nl/api/adr/) |
29-
| Normative | [Open API Specification (OAS)](https://forumstandaardisatie.nl/open-standaarden/openapi-specification) |
30-
| Normative | [NL GOV OAuth profiel](https://publicatie.centrumvoorstandaarden.nl/api/oauth/) |
31-
| Normative | [Digikoppeling REST API koppelvlak specificatie](https://publicatie.centrumvoorstandaarden.nl/dk/restapi/) |
32-
| Normative module | [GEO module](https://docs.geostandaarden.nl/api/API-Strategie-mod-geo/) |
33-
| Normative module | [Transport Security module](https://geonovum.github.io/KP-APIs/API-strategie-modules/transport-security/) |
28+
| Normative | [API Design Rules (ADR v2.0)](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0/) |
29+
| Normative | [Open API Specification (OAS 3.0)](https://spec.openapis.org/oas/v3.0.1.html) |
30+
| Normative | [NL GOV OAuth profiel](https://gitdocumentatie.logius.nl/publicatie/api/oauth/) |
31+
| Normative | [Digikoppeling REST API koppelvlak specificatie](https://gitdocumentatie.logius.nl/publicatie/dk/restapi/) |
32+
| Normative module | [GEO module v1.0](https://gitdocumentatie.logius.nl/publicatie/api/mod-geo/1.0.2/) |
33+
| Normative module | [Transport Security module v1.0](https://gitdocumentatie.logius.nl/publicatie/api/mod-ts/1.0.2/) |
3434

3535
Before reading this document it is advised to gain knowledge of the informative documents, in particular the [Architecture](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Architectuur/).
3636

SOTD.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11

2-
3-
| Organization / Committee | Version number | Official status | Date |
4-
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ---------- |
5-
| [Forum Standaardisatie](https://www.forumstandaardisatie.nl/open-standaarden/rest-api-design-rules) | [1.0]( https://gitdocumentatie.logius.nl/publicatie/api/adr/1.0) | reported | 15-10-2019 |
6-
| [Forum Standaardisatie](https://www.forumstandaardisatie.nl/open-standaarden/rest-api-design-rules) | [1.0]( https://gitdocumentatie.logius.nl/publicatie/api/adr/1.0) | ['comply of explain' standard (mandatory open standard)](https://gitdocumentatie.logius.nl/publicatie/api/adr/) | 09-07-2020 |
7-
| [Working group](https://github.com/Geonovum/KP-APIs/tree/03d7fd61b3f25eef5d3242c7beee688e0d2d9623/overleggen/Werkgroep%20API%20design%20rules/Verslagen/20230905) | [2.0.0-rc.1](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0-rc.1/) | working version / final draft by 'Working Group' | 05-09-2023 |
8-
| [KP API Steering committee](https://github.com/Geonovum/KP-APIs/tree/master/overleggen/Stuurgroep/Verslagen) | [2.0.0-rc.1](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0-rc.1/) | approved consultation version / adopted by 'KP API' | 21-09-2024 |
9-
| [MIDO programmeringstafel](https://pgdi.nl/groups/view/c9a77467-7118-42c4-ad27-d0da773bc7dc/programmeringstafels-en-financiele-commissie-pgdi/files/82ac7589-ce2a-4c39-aabd-99eb9a6cf43a) | [2.0.0-rc.2](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0-rc.2) | release candidate 2 / definitief concept | 14-02-2024 |
10-
| [MIDO PGDI Committee](https://pgdi.nl/groups/view/fa975d80-05e2-4f9e-89d6-6a053295c97b/programmeringsraad-gdi/files) | [2.0.0-rc.2](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0-rc.2) | definitive version / approved by 'PGDI' | 07-03-2024 |
11-
| [Forum Standaardisatie](https://www.forumstandaardisatie.nl/open-standaarden/rest-api-design-rules) | [2.0.0-rc.2](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0-rc.2) | reported | 25-01-2024 |
12-
| [Forum Standaardisatie](https://www.forumstandaardisatie.nl/open-standaarden/rest-api-design-rules) | [2.0.0](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0) | intake pending | 18-04-2024 |
13-
| [Forum Standaardisatie](https://www.forumstandaardisatie.nl/open-standaarden/rest-api-design-rules) | [2.0.0](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0) | definitive version / approved by Forum Standaardisatie | tbd |
2+
| Organization / Committee | Version number | Official status | Date |
3+
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ----------- |
4+
| [Geonovum](https://www.geonovum.nl/themas/kennisplatform-apis) | [17-01-2020](https://docs.geostandaarden.nl/api/vv-st-API-Designrules-20200117/) | proposed version | 17-01-2020 |
5+
| [Forum Standaardisatie](https://www.forumstandaardisatie.nl/open-standaarden/rest-api-design-rules) | [1.0]( https://gitdocumentatie.logius.nl/publicatie/api/adr/1.0) | reported | 15-10-2019 |
6+
| [Forum Standaardisatie](https://www.forumstandaardisatie.nl/open-standaarden/rest-api-design-rules) | [1.0]( https://gitdocumentatie.logius.nl/publicatie/api/adr/1.0) | 'comply of explain' standard (mandatory open standard) | 09-07-2020 |
7+
| [Working group](https://github.com/Geonovum/KP-APIs/tree/03d7fd61b3f25eef5d3242c7beee688e0d2d9623/overleggen/Werkgroep%20API%20design%20rules/Verslagen/20230905) | [2.0.0-rc.1](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0-rc.1/) | working version / final draft by 'Working Group' | 05-09-2023 |
8+
| [KP API Steering committee](https://github.com/Geonovum/KP-APIs/tree/master/overleggen/Stuurgroep/Verslagen) | [2.0.0-rc.1](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0-rc.1/) | approved consultation version / adopted by 'KP API' | 21-09-2024 |
9+
| [MIDO programmeringstafel](https://pgdi.nl/groups/view/c9a77467-7118-42c4-ad27-d0da773bc7dc/programmeringstafels-en-financiele-commissie-pgdi/files/82ac7589-ce2a-4c39-aabd-99eb9a6cf43a) | [2.0.0-rc.2](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0-rc.2) | release candidate 2 / definitief concept | 14-02-2024 |
10+
| [MIDO PGDI Committee](https://pgdi.nl/groups/view/fa975d80-05e2-4f9e-89d6-6a053295c97b/programmeringsraad-gdi/files) | [2.0.0-rc.2](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0-rc.2) | definitive version / approved by 'PGDI' | 07-03-2024 |
11+
| [Forum Standaardisatie](https://www.forumstandaardisatie.nl/open-standaarden/rest-api-design-rules) | [2.0.0-rc.2](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0-rc.2) | reported | 25-01-2024 |
12+
| [Forum Standaardisatie](https://www.forumstandaardisatie.nl/open-standaarden/rest-api-design-rules) | [2.0.0](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0) | intake started | 18-04-2024 |
13+
| [Forum Standaardisatie](https://www.forumstandaardisatie.nl/open-standaarden/rest-api-design-rules) | 2.0.1 | updated version with fixes in permalinks and <br>fixes in the how-to-test descriptions | end of 2024 |
14+
| [Forum Standaardisatie](https://www.forumstandaardisatie.nl/open-standaarden/rest-api-design-rules) | 2.0.1 | definitive version / approved by Forum Standaardisatie | [Currently in progress](https://www.forumstandaardisatie.nl/open-standaarden/in-behandeling) |
1415

0 commit comments

Comments
 (0)