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.1.1.md
+10-6Lines changed: 10 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -28,6 +28,10 @@ A "schema" is a formal description of syntax and structure.
28
28
This document serves as the [schema](#schema) for the OpenAPI Specification format; a non-authoritative JSON Schema based on this document is also provided on [spec.openapis.org](https://spec.openapis.org) for informational purposes.
29
29
This specification also _uses_ schemas in the form of the [Schema Object](#schema-object).
30
30
31
+
### Object
32
+
33
+
When capitalized, the word "Object" refers to any of the Objects that are named by section headings in this document.
34
+
31
35
### Path Templating
32
36
33
37
Path templating refers to the usage of template expressions, delimited by curly braces (`{}`), to mark a section of a URL path as replaceable using path parameters.
@@ -135,8 +139,8 @@ Implementations MAY support complete-document parsing in any of the following wa
135
139
* Detecting OpenAPI or JSON Schema documents using media types
136
140
* Detecting OpenAPI documents through the root `openapi` field
137
141
* Detecting JSON Schema documents through detecting keywords or otherwise successfully parsing the document in accordance with the JSON Schema specification
138
-
* Detecting a document containing a referenceable object at its root based on the expected type of the reference
139
-
* Allowing users to configure the type of documents that might be loaded due to a reference to a non-root object
142
+
* Detecting a document containing a referenceable Object at its root based on the expected type of the reference
143
+
* Allowing users to configure the type of documents that might be loaded due to a reference to a non-root Object
140
144
141
145
Implementations that parse referenced fragments of OpenAPI content without regard for the content of the rest of the containing document will miss keywords that change the meaning and behavior of the reference target.
142
146
In particular, failing to take into account keywords that change the base URI introduces security risks by causing references to resolve to unintended URIs, with unpredictable results.
@@ -229,7 +233,7 @@ The formats defined by the OAS are:
229
233
230
234
As noted under [Data Type](#data-types), both `type: number` and `type: integer` are considered to be numbers in the data model.
231
235
232
-
#### Working With Binary Data
236
+
#### Working with Binary Data
233
237
234
238
The OAS can describe either _raw_ or _encoded_ binary data.
235
239
@@ -2199,7 +2203,7 @@ This object MAY be extended with [Specification Extensions](#specification-exten
2199
2203
In all cases, the example value SHOULD be compatible with the schema of its associated value.
2200
2204
Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.
2201
2205
2202
-
#### Working With Examples
2206
+
##### Working with Examples
2203
2207
2204
2208
Example Objects can be used in both [Parameter Objects](#parameter-object) and [Media Type Objects](#media-type-object).
2205
2209
In both Objects, this is done through the `examples` (plural) field.
##### Relative Documents With Embedded Schema Example
2704
+
##### Relative Documents with Embedded Schema Example
2701
2705
2702
2706
```json
2703
2707
{
@@ -4295,7 +4299,7 @@ when expanded with the data given earlier, we get:
4295
4299
?a=x%2By&b=x%2Fy&c=x%5Ey&words=math,is,fun
4296
4300
```
4297
4301
4298
-
#### Expansion With Non-RFC6570-Supported Options
4302
+
#### Expansion with Non-RFC6570-Supported Options
4299
4303
4300
4304
But now let's say that (for some reason), we really want that `/` in the `b` formula to show up as-is in the query string, and we want our words to be space-separated like in a written phrase.
4301
4305
To do that, we'll add `allowReserved: true` to `formulas`, and change to `style: "spaceDelimited"` for `words`:
0 commit comments