Merge pull request #146 from Logius-standaarden/develop

Publicatie van ADR 2 Versie ter vaststelling naar de main branche
Logius-standaarden · Dec 13, 2023 · 05999d0 · 05999d0
2 parents 7c92501 + 0a8bd54
commit 05999d0
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 41 deletions.
diff --git a/DesignRules.md b/DesignRules.md
@@ -104,7 +104,7 @@ A resource describing a single thing is called a [=singular resource=]. Resource
       </dd>
       <dt>Implications</dt>
       <dd>
-         This rule is included in the automatic tests on <a href="https://developer.overheid.nl/">developer.overheid.nl</a>. The source code of the technical test can be found <a href="https://gitlab.com/commonground/don/adr-validator/-/blob/v0.3.0/pkg/adr/rules.go#L213">here</a>. The specific tests are published in the [[ADR-Validator]] repository.
+         This rule is included in the automatic tests on <a href="https://developer.overheid.nl/">developer.overheid.nl</a>. The source code of the technical test can be found <a href="https://gitlab.com/commonground/don/adr-validator/-/blob/v0.5.0/pkg/rulesets/core/rules.go#L203">here</a>. The specific tests are published in the [[ADR-Validator]] repository.
       </dd>      
       <dt>How to test</dt>
       <dd>
@@ -199,7 +199,7 @@ Although the REST architectural style does not impose a specific protocol, REST
       </dd>
       <dt>Implications</dt>
       <dd>
-         This rule is included in the automatic tests on <a href="https://developer.overheid.nl/">developer.overheid.nl</a>. The source code of the technical test can be found <a href="https://gitlab.com/commonground/don/adr-validator/-/blob/v0.3.0/pkg/adr/rules.go#L43">here</a>. The specific testscripts are published in the [[ADR-Validator]] repository.
+         This rule is included in the automatic tests on <a href="https://developer.overheid.nl/">developer.overheid.nl</a>. The source code of the technical test can be found <a href="https://gitlab.com/commonground/don/adr-validator/-/blob/v0.5.0/pkg/rulesets/core/rules.go#L60">here</a>. The specific testscripts are published in the [[ADR-Validator]] repository.
       </dd>
    <div class="example">The following table shows some examples of the use of standard HTTP methods:
       <table>
@@ -444,7 +444,7 @@ An API is as good as the accompanying documentation. The documentation has to be
       </dd>
       <dt>Implications</dt>
       <dd>
-         This rule is included in the automatic tests on <a href="https://developer.overheid.nl/">developer.overheid.nl</a>. The source code of the technical test can be found <a href="https://gitlab.com/commonground/don/adr-validator/-/blob/v0.3.0/pkg/adr/rules.go#L119">here</a>. The specific tests are published in the [[ADR-Validator]] repository.
+         This rule is included in the automatic tests on <a href="https://developer.overheid.nl/">developer.overheid.nl</a>. The source code of the technical test can be found <a href="https://gitlab.com/commonground/don/adr-validator/-/blob/v0.5.0/pkg/rulesets/core/rules.go#L123">here</a>. The specific tests are published in the [[ADR-Validator]] repository.
       </dd>
       <dt>How to test</dt>
       <dd>
@@ -496,7 +496,7 @@ An API is as good as the accompanying documentation. The documentation has to be
       </dd>
       <dt>Implications</dt>
       <dd>
-         This rule is included in the automatic tests on <a href="https://developer.overheid.nl/">developer.overheid.nl</a>. The source code of the technical test can be found <a href="https://gitlab.com/commonground/don/adr-validator/-/blob/v0.3.0/pkg/adr/rules.go#L282">here</a>. The specific tests are published in the [[ADR-Validator]] repository.
+         This rule is included in the automatic tests on <a href="https://developer.overheid.nl/">developer.overheid.nl</a>. The source code of the technical test can be found <a href="https://gitlab.com/commonground/don/adr-validator/-/blob/v0.5.0/pkg/rulesets/core/rules.go#L257">here</a>. The specific tests are published in the [[ADR-Validator]] repository.
       </dd>
       <dt>How to test</dt>
       <dd>
@@ -573,7 +573,7 @@ Changes in APIs are inevitable. APIs should therefore always be versioned, facil
       </dd>
       <dt>Implications</dt>
       <dd>
-         This rule is included in the automatic tests on <a href="https://developer.overheid.nl/">developer.overheid.nl</a>. The source code of the technical test can be found <a href="https://gitlab.com/commonground/don/adr-validator/-/blob/v0.3.0/pkg/adr/rules.go#L165">here</a>. The specific tests are published in the [[ADR-Validator]] repository.
+         This rule is included in the automatic tests on <a href="https://developer.overheid.nl/">developer.overheid.nl</a>. The source code of the technical test can be found <a href="https://gitlab.com/commonground/don/adr-validator/-/blob/v0.5.0/pkg/rulesets/core/rules.go#L164">here</a>. The specific tests are published in the [[ADR-Validator]] repository.
       </dd>
       <dt>How to test</dt>
       <dd>
@@ -617,7 +617,7 @@ Changes in APIs are inevitable. APIs should therefore always be versioned, facil
       </dd>
       <dt>Implications</dt>
       <dd>
-         This rule is included in the automatic tests on <a href="https://developer.overheid.nl/">developer.overheid.nl</a>. The source code of the technical test can be found <a href="https://gitlab.com/commonground/don/adr-validator/-/blob/v0.3.0/pkg/adr/rules.go#L354">here</a>. The specific tests are published in the [[ADR-Validator]] repository.
+         This rule is included in the automatic tests on <a href="https://developer.overheid.nl/">developer.overheid.nl</a>. The source code of the technical test can be found <a href="https://gitlab.com/commonground/don/adr-validator/-/blob/v0.5.0/pkg/rulesets/core/rules.go#L322">here</a>. The specific tests are published in the [[ADR-Validator]] repository.
       </dd>
       <dt>How to test</dt>
       <dd>
@@ -649,7 +649,7 @@ Changes in APIs are inevitable. APIs should therefore always be versioned, facil
       </dd>
       <dt>Implications</dt>
       <dd>
-         This rule is included in the automatic tests on <a href="https://developer.overheid.nl/">developer.overheid.nl</a>. The source code of the technical test can be found <a href="https://gitlab.com/commonground/don/adr-validator/-/blob/v0.3.0/pkg/adr/rules.go#L393">here</a>. The specific tests are published in the [[ADR-Validator]] repository.
+         This rule is included in the automatic tests on <a href="https://developer.overheid.nl/">developer.overheid.nl</a>. The source code of the technical test can be found <a href="https://gitlab.com/commonground/don/adr-validator/-/blob/v0.5.0/pkg/rulesets/core/rules.go#L354">here</a>. The specific tests are published in the [[ADR-Validator]] repository.
       </dd>
       <dt>How to test</dt>
       <dd>

diff --git a/README.md b/README.md
@@ -1,40 +1,24 @@
-## API Design Rules
+## API Design Rules versie 2
 
-### NEWS!! - 6 oktober 2023 start de openbare consultatie van de API Design Rules v2 - !!NEWS
-
-- De consultatie versie 2.0.0-rc.1 is beschikbaar op: https://logius-standaarden.github.io/API-Design-Rules/
+De consultatie versie 2.0.0-rc.2 is beschikbaar op: https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0-rc.2
 
 ### Links
 
-**API Design Rules** -- normative standard for the design of APIs for the Dutch Public Sector
-
-Bekijk hier de **laatste vastgestelde versie** van de standaard:  
-
-- [NLGov API Design Rules v1](https://gitdocumentatie.logius.nl/publicatie/api/adr/)
+| Formele standaard                                            | Gepubliceerde versie                                         | Werk versie                                                  | Repository                                                   |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| 🏛️[NLGov API Design Rules (ADR)](https://forumstandaardisatie.nl/open-standaarden/rest-api-design-rules) | 🍿 [ADR v1 (definitief)](https://gitdocumentatie.logius.nl/publicatie/api/adr/) | ✍️ [ADR v2.0.0-rc.2 (versie ter vaststelling)](https://logius-standaarden.github.io/API-Design-Rules/) | 🤓 [API-Design-Rules](https://github.com/Logius-standaarden/API-Design-Rules) |
+| 🏛️[NLGov OAuth 2.0 profile (OAuth)](https://forumstandaardisatie.nl/open-standaarden/nl-gov-assurance-profile-oauth-20) | 🍿[OAuth v1 (definitief)](https://gitdocumentatie.logius.nl/publicatie/api/oauth/) | ✍️[OAuth v1.1.0 (werkversie)](https://logius-standaarden.github.io/OAuth-NL-profiel/) | 🤓[OAuth-NL-profiel](https://github.com/Logius-standaarden/OAuth-NL-profiel) |
+| 🏛️[NLGov OpenID Connect profile (OIDC)](https://forumstandaardisatie.nl/open-standaarden/nl-gov-assurance-profile-oidc) | 🍿[OIDC v1.0.1 (definitief)](https://gitdocumentatie.logius.nl/publicatie/api/oidc/) | ✍️[OIDC v1.0.1 (werkversie)](https://logius-standaarden.github.io/OIDC-NLGOV/) | 🤓[OIDC-NLGOV](https://github.com/Logius-standaarden/OIDC-NLGOV) |
 
-Bekijk hier **de laatste werkversie** van de standaard:  
+Het **Beheermodel** voor deze standaard is gepubliceerd op: https://publicatie.centrumvoorstandaarden.nl/api/adr-beheer/
 
-- https://Logius-standaarden.github.io/API-Design-Rules/
+### Versie 2.0.0 (dec 2023)
+
+Versie 2 van de API designrules is gereed. Onderdeel van het besluitvormingsproces om deze versie als de nieuwe standaard vast te stellen is dat we deze versie eerst met de werkgroep API-designrules is besproken. Na dit positieve advies vanuit de werkgroep is het vaststellingsproces verder in gang gezet.
 
-Het **Beheermodel** voor deze standaard is gepubliceerd op:  
+De stuurgroep van het Kennisplatform heeft ingestemd met de publieke consultatie in oktober/november 2023. Inmiddels is de feedback hieruit ook verwerkt.
 
-- https://publicatie.centrumvoorstandaarden.nl/api/adr-beheer/
+Vervolgstappen zijn nu het aanmelden van de standaard voor goedkeuring door het MIDO en de aanmelding bij het Forumstandaardisatie.
 
-### Versie 2.0.0 (juli 2023)
-
-Versie 2 van de API designrules is  gereed. Onderdeel van het besluitvormingsproces om deze versie als de nieuwe standaard vast te stellen is dat we deze versie eerst met de werkgroep API-designrules bespreken. Bij een positief advies vanuit de werkgroep kan het vaststellingsproces verder in gang gezet worden. Op 5 september is tijdens de digitale werkgroepbijeenkomst de nieuwe versie van de designrules besproken en is besloten welke wijzigingen akkoord zijn. Eventuele feedback kun je ook voor de bijeenkomst al doorgeven via een issue op [de github van het Kennisplatform.](https://github.com/Geonovum/KP-APIs/issues)
-
-Een overzicht van de nog te bespreken wijzigingen is te vinden op:
-- https://github.com/Logius-standaarden/API-Design-Rules/pulls?q=is%3Apr+is%3Aopen+label%3A%22Status%3A+In+review%22
->Hierbij kan men indien gewenst nog direct feedback geven op de voorgestelde change.
- 
-Een overzicht van reeds besproken wijzigingen is te vinden op:
-- https://github.com/Logius-standaarden/API-Design-Rules/pulls?q=is%3Apr+is%3Aclosed+label%3A%22Status%3A+In+review%22
->Hier heeft de werkgroep eerder over gesproken en feedback kan als issue worden vastgelegd.
- 
-Ook is er een concept van de releasenotes beschikbaar waarin alle wijzigingen zijn opgesomd. zie hiervoor:
+Een overzicht van de releasenotes is beschikbaar waarin alle wijzigingen zijn opgesomd. zie hiervoor:
 - https://github.com/Geonovum/KP-APIs/blob/master/overleggen/Werkgroep%20API%20design%20rules/Verslagen/20230905/Releasenotes_ADR2.md
-
-### Deze repository:  
-
-https://github.com/Logius-standaarden/API-Design-Rules/
diff --git a/index.html b/index.html
@@ -6,7 +6,7 @@
   <meta content="width=device-width, initial-scale=1, shrink-to-fit=no" name="viewport"/>
   <!-- Invullen: de titel van de standaard of het document ==================================== -->
   <title>
-   NLGov API Design Rules
+   NLGov REST API Design Rules
   </title>
   <!-- Invullen: de naam van de lokale CSS file =============================================== -->
   <link href="./media/style.css" rel="stylesheet" type="text/css"/>

diff --git a/js/config.js b/js/config.js
@@ -39,12 +39,12 @@ var respecConfig = {
     ],
   github: "https://github.com/Logius-standaarden/API-Design-Rules",
   pubDomain: "api",
-  publishDate: "2023-09-20",
-  publishVersion: "2.0.0-rc.1",
+  publishDate: "2023-12-12",
+  publishVersion: "2.0.0-rc.2",
   previousPublishDate: "2020-07-09",
   previousPublishVersion: "1.0",
   shortName: "adr",
-  specStatus: "CV",
+  specStatus: "VV",
   specType: "ST",
   pluralize: true,
 };