Skip to content

added version clarification #901

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

Merged
merged 2 commits into from
Feb 22, 2017
Merged

added version clarification #901

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a9f40e
added version clarification
fehguy Feb 21, 2017
58a57ff
clarified FID
fehguy Feb 22, 2017
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
15 changes: 8 additions & 7 deletions versions/3.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,13 @@ Additional utilities can also take advantage of the resulting files, such as tes
## Revision History

Version | Date | Notes
--- | --- | ---
2.0 | 2015-12-31 | Donation of Swagger 2.0 to the Open API Initiative
2.0 | 2014-09-08 | Release of Swagger 2.0
1.2 | 2014-03-14 | Initial release of the formal document.
1.1 | 2012-08-22 | Release of Swagger 1.1
1.0 | 2011-08-10 | First release of the Swagger Specification
--- | --- | ---
3.0.0-rc0 | 2017-02-28 | Implementor's draft of the 3.0 specification
2.0 | 2015-12-31 | Donation of Swagger 2.0 to the Open API Initiative
2.0 | 2014-09-08 | Release of Swagger 2.0
1.2 | 2014-03-14 | Initial release of the formal document.
1.1 | 2012-08-22 | Release of Swagger 1.1
1.0 | 2011-08-10 | First release of the Swagger Specification

## Definitions

Expand Down Expand Up @@ -221,7 +222,7 @@ Field Name | Type | Description
<a name="infoTermsOfService"></a>termsOfService | `string` | A URL to the Terms of Service for the API.
<a name="infoContact"></a>contact | [Contact Object](#contactObject) | The contact information for the exposed API.
<a name="infoLicense"></a>license | [License Object](#licenseObject) | The license information for the exposed API.
<a name="infoVersion"></a>version | `string` | **Required** Provides the version of the application API (not to be confused with the specification version).
<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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"?) Instead, I suggest rephrasing, introducing fewer new/undefined/ambiguous terms:

Required Provides the version of the API (not to be confused with the OpenAPI specification version or the implementation version which may evolve at different rates).

Copy link
Contributor

@RobDolinMS RobDolinMS Feb 22, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DavidBiesack Would you please consider opening this as a separate issue or PR?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@RobDolinMS - sure, see #905


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

Expand Down