Skip to content

Commit e1a7894

Browse files
committed
API Version-header en SemVer
verbetering van de how to test in relatie tot Geonovum/KP-APIs#626 Geonovum/KP-APIs#627
1 parent a69a5c1 commit e1a7894

File tree

1 file changed

+3
-10
lines changed

1 file changed

+3
-10
lines changed

DesignRules.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -621,12 +621,8 @@ Changes in APIs are inevitable. APIs should therefore always be versioned, facil
621621
</dd>
622622
<dt>How to test</dt>
623623
<dd>
624-
<ul>
625-
<li> Step 1: The API MUST meet the prerequisets to be tested. These include that an OAS file (openapi.json) is publicly available, parsable, all $refs are resolvable and paths are defined.</li>
626-
<li> Step 2: In the open api specification the info and version object MUST be available.</li>
627-
<li> Step 3: The version MUST comply with Semantic Versioning.</li>
628-
</ul>
629-
</dd>
624+
The "API-Version" response header MUST comply with Semantic Versioning.
625+
</dd>
630626
</dl>
631627
</div>
632628

@@ -653,10 +649,7 @@ Changes in APIs are inevitable. APIs should therefore always be versioned, facil
653649
</dd>
654650
<dt>How to test</dt>
655651
<dd>
656-
<ul>
657-
<li> Step 1: A request to the base url MUST give a response and include the header "API-Version".</li>
658-
<li> Step 2: The value of the header "API-Version" MUST have a valid Semantic Versioning number.</li>
659-
</ul>
652+
A response MUST include the header "API-Version".
660653
</dd>
661654
</dl>
662655
</div>

0 commit comments

Comments
 (0)