Skip to content

Commit 1089243

Browse files
authored
Merge pull request OAI#1154 from krishahn/edit-filestruc-datatypes
edit-filestruc-datatypes
2 parents 866847b + c65cc65 commit 1089243

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

versions/3.0.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ The OAS representation of the API is made of a single file.
124124
However, parts of the definitions can be split into separate files, at the discretion of the user.
125125
This is applicable for `$ref` fields in the specification as follows from the [JSON Schema](http://json-schema.org) definitions.
126126

127-
By convention, it is RECOMMENDED that the OpenAPI Specification (OAS) file be named `openapi.json` or `openapi.yaml`.
127+
It is RECOMMENDED that the OpenAPI definition file be named following convention: `openapi.json` or `openapi.yaml`.
128128

129129
### <a name="dataTypes"></a>Data Types
130130

@@ -134,10 +134,10 @@ Note that `integer` as a type is also supported and is defined as a JSON number
134134
Models are described using the [Schema Object](#schemaObject) which is an extended subset of JSON Schema Specification Wright Draft 00.
135135

136136
<a name="dataTypeFormat"></a>Primitives have an optional modifier property: `format`.
137-
OAS uses several known formats to more finely define the data type being used.
138-
However, the `format` property is an open `string`-valued property, and can have any value to support documentation needs.
139-
Formats such as `"email"`, `"uuid"`, etc., can be used even though they are not defined by this specification.
140-
Types that are not accompanied by a `format` property follow their definition from the JSON Schema. Tools that do not recognize a specific `format` MAY default back to the `type` alone, as if the `format` was not specified.
137+
OAS uses several known formats to define in fine detail the data type being used.
138+
However, to support documentation needs, the `format` property is an open `string`-valued property, and can have any value.
139+
Formats such as `"email"`, `"uuid"`, and so on, can be used even though undefined by this specification.
140+
Types that are not accompanied by a `format` property follow the type definition in the JSON Schema. Tools that do not recognize a specific `format` MAY default back to the `type` alone, as if the `format` is not specified.
141141

142142
The formats defined by the OAS are:
143143

@@ -154,7 +154,7 @@ binary | `string` | `binary` | any sequence of octets
154154
boolean | `boolean` | | |
155155
date | `string` | `date` | As defined by `full-date` - [RFC3339](http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14)
156156
dateTime | `string` | `date-time` | As defined by `date-time` - [RFC3339](http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14)
157-
password | `string` | `password` | Used to hint UIs the input needs to be obscured.
157+
password | `string` | `password` | A hint to UIs to obscure input.
158158

159159
### <a name="richText"></a>Rich Text Formatting
160160
Throughout the specification `description` fields are noted as supporting CommonMark markdown formatting.

0 commit comments

Comments
 (0)