You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: versions/3.0.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -126,7 +126,7 @@ The OAS representation of the API is made of a single file.
126
126
However, parts of the definitions can be split into separate files, at the discretion of the user.
127
127
This is applicable for `$ref` fields in the specification as follows from the [JSON Schema](http://json-schema.org) definitions.
128
128
129
-
By convention, it is RECOMMENDED that the OpenAPI Specification (OAS) file be named `openapi.json` or `openapi.yaml`.
129
+
It is RECOMMENDED that the OpenAPI Specification (OAS) file be named following convention:`openapi.json` or `openapi.yaml`.
130
130
131
131
### <aname="dataTypes"></a>Data Types
132
132
@@ -136,10 +136,10 @@ Note that `integer` as a type is also supported and is defined as a JSON number
136
136
Models are described using the [Schema Object](#schemaObject) which is an extended subset of JSON Schema Specification Wright Draft 00.
137
137
138
138
<aname="dataTypeFormat"></a>Primitives have an optional modifier property: `format`.
139
-
OAS uses several known formats to more finely define the data type being used.
140
-
However, the `format` property is an open `string`-valued property, and can have any value to support documentation needs.
141
-
Formats such as `"email"`, `"uuid"`, etc., can be used even though they are not defined by this specification.
142
-
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.
139
+
OAS uses several known formats to define in fine detail the data type being used.
140
+
However, to support documentation needs, the `format` property is an open `string`-valued property, and can have any value.
141
+
Formats such as `"email"`, `"uuid"`, and so on, can be used even though undefined by this specification.
142
+
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.
143
143
144
144
The formats defined by the OAS are:
145
145
@@ -156,7 +156,7 @@ binary | `string` | `binary` | any sequence of octets
156
156
boolean | `boolean` | | |
157
157
date | `string` | `date` | As defined by `full-date` - [RFC3339](http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14)
158
158
dateTime | `string` | `date-time` | As defined by `date-time` - [RFC3339](http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14)
159
-
password | `string` | `password` | Used to hint UIs the input needs to be obscured.
159
+
password | `string` | `password` | A hint to UIs to obscure input.
160
160
161
161
### <aname="richText"></a>Rich Text Formatting
162
162
Throughout the specification `description` fields are noted as supporting CommonMark markdown formatting.
0 commit comments