Skip to content

Voeg expliciete velden toe aan info.contact regel #326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TimvdLippe wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Voeg expliciete velden toe aan info.contact regel #326

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4675a53
Voeg expliciete velden toe aan `info.contact` regel
TimvdLippe May 6, 2026
63b75f6
Voeg testinstructies toe
TimvdLippe May 6, 2026
c495046
Update sections/designRules.md
TimvdLippe May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions sections/designRules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -687,7 +687,9 @@ An API is as good as the accompanying documentation. The documentation has to be
<dl>
<dt>Statement</dt>
<dd>
OpenAPI definition document SHOULD include the <a href="https://spec.openapis.org/oas/v3.0.1.html#contact-object"><code>info.contact</code></a> object for publicly available APIs. Contact information SHOULD NOT be a generic contact address for the whole organisation.
OpenAPI definition document SHOULD include the <a href="https://spec.openapis.org/oas/v3.0.1.html#contact-object"><code>info.contact</code></a> object for publicly available APIs.
The <code>info.contact</code> object MUST include the fields <code>name</code>, <code>url</code> and <code>email</code>.
Contact information SHOULD NOT be a generic contact address for the whole organisation.
</dd>
<dt>Rationale</dt>
<dd>
Expand All @@ -703,7 +705,10 @@ An API is as good as the accompanying documentation. The documentation has to be
</dd>
<dt>How to test</dt>
<dd>
Parse the OpenAPI Description to confirm the <code>info.contact</code> object is present.
<ul>
<li>Step 1. Parse the OpenAPI Description to confirm the <code>info.contact</code> object is present.
<li>Step 2. Confirm <code>info.contact</code> contains the fields <code>name</code>, <code>url</code> and <code>email</code>.
</ul>
</dd>
</dl>
</div>
Expand Down
Loading