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.4.md
+8-4Lines changed: 8 additions & 4 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.
@@ -199,7 +203,7 @@ The formats defined by the OAS are:
199
203
|`string`|`date-time`| As defined by `date-time` - [RFC3339](https://www.rfc-editor.org/rfc/rfc3339#section-5.6)|
200
204
|`string`|`password`| A hint to obscure the value. |
201
205
202
-
#### Working With Binary Data
206
+
#### Working with Binary Data
203
207
204
208
Two formats, `binary` and `byte`, describe different ways to work with binary data:
205
209
@@ -2125,7 +2129,7 @@ This object MAY be extended with [Specification Extensions](#specification-exten
2125
2129
In all cases, the example value SHOULD be compatible with the schema of its associated value.
2126
2130
Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.
2127
2131
2128
-
#### Working With Examples
2132
+
##### Working with Examples
2129
2133
2130
2134
Example Objects can be used in both [Parameter Objects](#parameter-object) and [Media Type Objects](#media-type-object).
2131
2135
In both objects, this is done through the `examples` (plural) field.
##### Relative Documents With Embedded Schema Example
2625
+
##### Relative Documents with Embedded Schema Example
2622
2626
2623
2627
```json
2624
2628
{
@@ -4087,7 +4091,7 @@ when expanded with the data given earlier, we get:
4087
4091
?a=x%2By&b=x%2Fy&c=x%5Ey&words=math,is,fun
4088
4092
```
4089
4093
4090
-
#### Expansion With Non-RFC6570-Supported Options
4094
+
#### Expansion with Non-RFC6570-Supported Options
4091
4095
4092
4096
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.
4093
4097
To do that, we'll add `allowReserved: true` to `formulas`, and change to `style: "spaceDelimited"` for `words`:
0 commit comments