From eb08aa84c1f8a63b3e0dc30f32a5a62dc63d2113 Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Wed, 3 Jun 2026 10:41:20 +0200 Subject: [PATCH 1/7] Publiceer definitieve versie 2.2.0 Deze is goedgekeurd door de Programmeringstafel Gegevensuitwisseling op 2026-06-02. --- js/config.mjs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/js/config.mjs b/js/config.mjs index 47245f13..c3089ef8 100644 --- a/js/config.mjs +++ b/js/config.mjs @@ -104,7 +104,7 @@ loadRespecWithConfiguration({ previousPublishDate: "2025-08-27", previousPublishVersion: "2.1.0", shortName: "adr", - specStatus: "VV", + specStatus: "DEF", specType: "ST", pluralize: true, From 919d873333fe4c909c9aaf3752ade5f788c5af8c Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Tue, 12 May 2026 16:16:46 +0200 Subject: [PATCH 2/7] Beheer: fix build met laatste versie van Respec (#332) Vereist met Respec 37 --- js/config.mjs | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/js/config.mjs b/js/config.mjs index c3089ef8..e63a7f25 100644 --- a/js/config.mjs +++ b/js/config.mjs @@ -4,9 +4,8 @@ import { generateMermaidFigures } from "https://logius-standaarden.github.io/pub async function initializeHighlightJSYaml() { //this is the function you call in 'preProcess', to load the highlighter - const worker = await new Promise(resolve => { - require(["core/worker"], ({ worker }) => resolve(worker)); - }); + const worker = await document.respec.worker; + const action = "highlight-load-lang-self-registration"; const langURL = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/yaml.min.js"; const lang = "yaml"; @@ -31,9 +30,7 @@ async function fetchLinterConfiguration() { async function highlightLinterCode(config, document) { //this is the function you call in 'postProcess', to load the highlighter - const worker = await new Promise(resolve => { - require(["core/worker"], ({ worker }) => resolve(worker)); - }); + const worker = await document.respec.worker; const action = "highlight"; const code = linterConfiguration; From ad7cd4c00f2b4f1086190c0a312ffb644709a531 Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Fri, 12 Jun 2026 11:14:31 +0200 Subject: [PATCH 3/7] Beheer: zet alle relevante linter regels op error (#339) Hiermee zijn er geen warnings meer. Dit maakt het mogelijk voor developer.overheid.nl om warnings te genereren voor toekomstige linter versies. Ze willen namelijk regels die nieuw zijn in versie 2.X toevoegen als warnings aan versie 2.(X - 1). --- media/linter.yaml | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) diff --git a/media/linter.yaml b/media/linter.yaml index c096d7b8..bf06d18f 100644 --- a/media/linter.yaml +++ b/media/linter.yaml @@ -171,20 +171,8 @@ rules: functionOptions: match: ^\$?[a-z][a-z\d]*([A-Z][a-z\d]*)*$ - nlgov:schema-camel-case: - severity: warn - message: "Schema name should be UpperCamelCase in {{path}}" - given: >- - $.components.schemas[*]~ - then: - function: casing - functionOptions: - type: pascal - separator: - char: "" - nlgov:servers-use-https: - severity: warn + severity: error message: "Server URL {{value}} {{error}}." given: - $.servers[*] @@ -244,7 +232,7 @@ rules: - "400" nlgov:property-casing: - severity: warn + severity: error given: - "$.*.schemas[*].properties.[?(@property && @property.match(/_links/i))]" then: From bd2d9b5c8d80e8542a5c27692f4c2461ba834ca0 Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Thu, 18 Jun 2026 09:45:05 +0200 Subject: [PATCH 4/7] Beheer: haal property casing schema rule weg (#342) Er is een rule voor het gebruik van camelCase van query keys: `nlgov:query-keys-camel-case`. Ik ging er onterecht vanuit dat deze regel ook hiervoor is. Dat is echter niet zo, want deze regel gaat over het beschrijven van schema's in een OpenAPI specificatie. Dat is niet als regel in de ADR opgenomen en moeten we daarom ook niet checken. --- media/linter.yaml | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/media/linter.yaml b/media/linter.yaml index bf06d18f..207652a0 100644 --- a/media/linter.yaml +++ b/media/linter.yaml @@ -231,17 +231,6 @@ rules: required: - "400" - nlgov:property-casing: - severity: error - given: - - "$.*.schemas[*].properties.[?(@property && @property.match(/_links/i))]" - then: - function: casing - functionOptions: - type: camel - field: "@key" - message: Properties must be lowerCamelCase. - #/core/date-time/timezone nlgov:date-time-ensure-timezone: severity: error From 75fb4bd722df3234b59d408361fd81c22835c212 Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Thu, 18 Jun 2026 13:47:15 +0200 Subject: [PATCH 5/7] Publiceer patch versie 2.2.1 --- js/config.mjs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/js/config.mjs b/js/config.mjs index e63a7f25..e1f770e5 100644 --- a/js/config.mjs +++ b/js/config.mjs @@ -96,10 +96,10 @@ loadRespecWithConfiguration({ ], github: "https://github.com/Logius-standaarden/API-Design-Rules", pubDomain: "api", - publishDate: "2026-06-02", - publishVersion: "2.2.0", - previousPublishDate: "2025-08-27", - previousPublishVersion: "2.1.0", + publishDate: "2026-06-18", + publishVersion: "2.2.1", + previousPublishDate: "2026-06-02", + previousPublishVersion: "2.2.0", shortName: "adr", specStatus: "DEF", specType: "ST", From c829cfc1a47871042d43d211a8a1ce7dac51d3cf Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Tue, 29 Sep 2026 11:31:12 +0200 Subject: [PATCH 6/7] Beheer: update referenties van normatieve modules naar definitieve URL Deze modules zijn gepubliceerd, maar we verwezen nog naar de (inhoudelijk identieke) werkversies van die modules. Co-authored-by: Alexander Green --- index.html | 2 +- js/config.mjs | 8 ++------ sections/introduction.md | 3 ++- 3 files changed, 5 insertions(+), 8 deletions(-) diff --git a/index.html b/index.html index bd6e3c81..115a9add 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ - NLGov REST API Design Rules + NLgov REST API Design Rules diff --git a/js/config.mjs b/js/config.mjs index e1f770e5..30464456 100644 --- a/js/config.mjs +++ b/js/config.mjs @@ -111,19 +111,15 @@ loadRespecWithConfiguration({ localBiblio: { "ADR-encryption": { authors: ["P. Haasnoot"], - href: "https://logius-standaarden.github.io/API-mod-encryption/", + href: "https://gitdocumentatie.logius.nl/publicatie/api/mod-encryption/1.0/", publisher: "Logius", title: "API Design Rules Module: Encryption", - // TODO: verwijder voor publicatie - status: "Draft", }, "ADR-signing": { authors: ["P. Haasnoot"], - href: "https://logius-standaarden.github.io/API-mod-signing/", + href: "https://gitdocumentatie.logius.nl/publicatie/api/mod-signing/1.0/", publisher: "Logius", title: "API Design Rules Module: Signing", - // TODO: verwijder voor publicatie - status: "Draft", }, } }); diff --git a/sections/introduction.md b/sections/introduction.md index 480978a9..75629582 100644 --- a/sections/introduction.md +++ b/sections/introduction.md @@ -30,7 +30,8 @@ The Nederlandse API Strategie consists of [a set of distinct documents](https:// | Normative | [NL GOV OAuth profiel](https://gitdocumentatie.logius.nl/publicatie/api/oauth/) | | Normative | [Digikoppeling REST API koppelvlak specificatie](https://gitdocumentatie.logius.nl/publicatie/dk/restapi/) | | Normative module | [GEO module v1.0](https://gitdocumentatie.logius.nl/publicatie/api/mod-geo/1.0.2/) | -| Normative module | [Transport Security module v1.0](https://gitdocumentatie.logius.nl/publicatie/api/mod-ts/1.0.2/) | +| Normative module | [Signing module v1.0](https://gitdocumentatie.logius.nl/publicatie/api/mod-signing/1.0/) | +| Normative module | [Encryption module v1.0](https://gitdocumentatie.logius.nl/publicatie/api/mod-encryption/1.0/) | 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/). From cf8dc317be05b440a8ca785be8fbe5f2f449f0aa Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Tue, 29 Sep 2026 11:32:15 +0200 Subject: [PATCH 7/7] Publiceer patch versie 2.2.2 Co-authored-by: Alexander Green --- js/config.mjs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/js/config.mjs b/js/config.mjs index 30464456..02d5779d 100644 --- a/js/config.mjs +++ b/js/config.mjs @@ -96,10 +96,10 @@ loadRespecWithConfiguration({ ], github: "https://github.com/Logius-standaarden/API-Design-Rules", pubDomain: "api", - publishDate: "2026-06-18", - publishVersion: "2.2.1", - previousPublishDate: "2026-06-02", - previousPublishVersion: "2.2.0", + publishDate: "2026-09-29", + publishVersion: "2.2.2", + previousPublishDate: "2026-06-18", + previousPublishVersion: "2.2.1", shortName: "adr", specStatus: "DEF", specType: "ST",