Skip to content

Commit 18f041c

Browse files
David BiesackDavid Biesack
authored andcommitted
Remove ambiguity about info.version
In [OpenAPI.next versions/3.0.md](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#infoObject) `info.version` is marked **Requried**, then the second sentence starts "While not required, ". Some may be confused and think this starts a contradiction. I suggest not adding this sentence at all, as it only raises additional questions (is "application API === "API definition"?) I propose more concise rephrasing.
1 parent d78e003 commit 18f041c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

versions/3.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ Field Name | Type | Description
221221
<a name="infoTermsOfService"></a>termsOfService | `string` | A URL to the Terms of Service for the API.
222222
<a name="infoContact"></a>contact | [Contact Object](#contactObject) | The contact information for the exposed API.
223223
<a name="infoLicense"></a>license | [License Object](#licenseObject) | The license information for the exposed API.
224-
<a name="infoVersion"></a>version | `string` | **Required** Provides the version of the application API (not to be confused with the specification version). While not required, is it suggested that the `info.version` value correspond to the version of the API definition. In practice, the version of the API _implementation_ may evolve at an entirely different rate.
224+
<a name="infoVersion"></a>version | `string` | **Required** The version of the API (not to be confused with the OpenAPI specification version or the implementation version which may evolve at different rates).
225225

226226
This object can be extended with [Specification Extensions](#specificationExtensions).
227227

0 commit comments

Comments
 (0)