-
Notifications
You must be signed in to change notification settings - Fork 9.2k
Update guidelines for v3 and Swagger --> OAS #1280
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.
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
Conversation
guidelines/v2.0/EXTENSIONS.md
Outdated
| * within the [responses object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#responses-object) | ||
| * within the [tag object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#tag-object) | ||
| * within the [security-scheme object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#security-scheme-object) | ||
| * within the [info object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/2.0.md#info-object) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Link to master instead of OpenAPI.next.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should not need to include the branch - just use relative links instead of absolute links, such as :
within the [info object](2.0.md#info-object)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We're the file links to the spec versions which are in a different folder, @DavidBiesack , but maybe an absolute path will work (/versions/2.0.md#info-object)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed - changed them to links like /versions/2.0.md#info-object and that seems to work.
guidelines/v2.0/EXTENSIONS.md
Outdated
| # OpenAPI Extensions | ||
|
|
||
| The Swagger 2.0 specification allows for custom properties to be added at several places within a Swagger definition, allowing | ||
| The OpenAPI Specification version 2.0 allows for custom properties to be added at several places within an OpenAPI definition, allowing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be OpenAPI document
|
Please add extensions.md file at the root of the guidelines folder linking to the moved file under the new directory (to avoid link breakage). |
|
Added the EXTENSIONS.md at the root, linking to the one in 2.0. |
Create v2.0 folder, move the files there, and update them to reflect OAS wherever that reflects the up to date name of the spec.