Uh oh!
There was an error while loading. Please reload this page.
edit-filestruc-datatypes - #1154
Conversation
RobDolinMS
left a comment
There was a problem hiding this comment.
All looks reasonable to me. Thanks @krishahn
| 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).
There was a problem hiding this comment.
Per @darrelmiller this should be an Open API Definition File (OADF)
| 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".
There was a problem hiding this comment.
Use the phrase "OpenAPI definition file" with no acronym.
RobDolinMS
commented
Jun 9, 2017
#TDC: Thumbs-up |
minor wordsmithing