From 4675a53699f4f4f0b2593373516e4bac3e20553d Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Wed, 6 May 2026 10:39:17 +0200 Subject: [PATCH 1/3] Voeg expliciete velden toe aan `info.contact` regel De linter checkt hier al op en het staat ook correct in het voorbeeld, maar de tekst zelf miste de expliciete velden. Dit is naar mijn weten ook zo afgesproken en vastgesteld bij het TO toendertijd, maar is over het hoofd gezien bij het schrijven van de tekst. --- sections/designRules.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/sections/designRules.md b/sections/designRules.md index 3cf9fe3d..1650ed7d 100644 --- a/sections/designRules.md +++ b/sections/designRules.md @@ -687,7 +687,9 @@ An API is as good as the accompanying documentation. The documentation has to be
Statement
- OpenAPI definition document SHOULD include the info.contact object for publicly available APIs. Contact information SHOULD NOT be a generic contact address for the whole organisation. + OpenAPI definition document SHOULD include the info.contact object for publicly available APIs. + The info.contact object MUST include the fields name, url and email. + Contact information SHOULD NOT be a generic contact address for the whole organisation.
Rationale
From 63b75f6d9e6fd91c0ea00840a3466c05cd25f729 Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Wed, 6 May 2026 10:42:31 +0200 Subject: [PATCH 2/3] Voeg testinstructies toe --- sections/designRules.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/sections/designRules.md b/sections/designRules.md index 1650ed7d..089b95bb 100644 --- a/sections/designRules.md +++ b/sections/designRules.md @@ -705,7 +705,10 @@ An API is as good as the accompanying documentation. The documentation has to be
How to test
- Parse the OpenAPI Description to confirm the info.contact object is present. +
    +
  • Step 1. Parse the OpenAPI Description to confirm the info.contact object is present. +
  • Step 2. The info.contact MUST contain the fields name, url and email +
From c495046d429859e607a62f219575dedd00f554aa Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Thu, 7 May 2026 08:30:19 +0200 Subject: [PATCH 3/3] Update sections/designRules.md Co-authored-by: Alexander Green --- sections/designRules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sections/designRules.md b/sections/designRules.md index 089b95bb..662dc60e 100644 --- a/sections/designRules.md +++ b/sections/designRules.md @@ -707,7 +707,7 @@ An API is as good as the accompanying documentation. The documentation has to be
  • Step 1. Parse the OpenAPI Description to confirm the info.contact object is present. -
  • Step 2. The info.contact MUST contain the fields name, url and email +
  • Step 2. Confirm info.contact contains the fields name, url and email.