Merged
Conversation
RobDolinMS
approved these changes
Jun 8, 2017
Contributor
RobDolinMS
left a comment
There was a problem hiding this comment.
All looks reasonable to me. Thanks @krishahn
DavidBiesack
suggested changes
Jun 9, 2017
versions/3.0.md
Outdated
| This is applicable for `$ref` fields in the specification as follows from the [JSON Schema](http://json-schema.org) definitions. | ||
|
|
||
| By convention, it is RECOMMENDED that the OpenAPI Specification (OAS) file be named `openapi.json` or `openapi.yaml`. | ||
| It is RECOMMENDED that the OpenAPI Specification (OAS) file be named following convention: `openapi.json` or `openapi.yaml`. |
There was a problem hiding this comment.
reads a little stiff to me. Suggest "named using convention openapi.json ... (without the colon).
Contributor
There was a problem hiding this comment.
Per @darrelmiller this should be an Open API Definition File (OADF)
versions/3.0.md
Outdated
| This is applicable for `$ref` fields in the specification as follows from the [JSON Schema](http://json-schema.org) definitions. | ||
|
|
||
| By convention, it is RECOMMENDED that the OpenAPI Specification (OAS) file be named `openapi.json` or `openapi.yaml`. | ||
| It is RECOMMENDED that the OpenAPI Specification (OAS) file be named following convention: `openapi.json` or `openapi.yaml`. |
There was a problem hiding this comment.
Also, this page is the OpenAPI Specification. The openapi.json file is not the specification, it is the OpenAPI definition.
I suggest we define that as a term - "an OpenAPI definition is a document that describes an OpenAPI using the OAS".
Member
There was a problem hiding this comment.
Use the phrase "OpenAPI definition file" with no acronym.
Merged
webron
approved these changes
Jun 9, 2017
darrelmiller
approved these changes
Jun 9, 2017
Contributor
|
#TDC: Thumbs-up |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
minor wordsmithing