Skip to content

Commit 14f0605

Browse files
authored
Merge pull request #4050 from handrews/obj-with
"Object" definition, "with" in titles, fix level of "Working with Examples"
2 parents 57a9bc6 + 55e87c3 commit 14f0605

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

versions/3.0.4.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ A "schema" is a formal description of syntax and structure.
2828
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.
2929
This specification also _uses_ schemas in the form of the [Schema Object](#schema-object).
3030

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+
3135
### Path Templating
3236

3337
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:
199203
| `string` | `date-time` | As defined by `date-time` - [RFC3339](https://www.rfc-editor.org/rfc/rfc3339#section-5.6) |
200204
| `string` | `password` | A hint to obscure the value. |
201205

202-
#### Working With Binary Data
206+
#### Working with Binary Data
203207

204208
Two formats, `binary` and `byte`, describe different ways to work with binary data:
205209

@@ -2125,7 +2129,7 @@ This object MAY be extended with [Specification Extensions](#specification-exten
21252129
In all cases, the example value SHOULD be compatible with the schema of its associated value.
21262130
Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.
21272131

2128-
#### Working With Examples
2132+
##### Working with Examples
21292133

21302134
Example Objects can be used in both [Parameter Objects](#parameter-object) and [Media Type Objects](#media-type-object).
21312135
In both objects, this is done through the `examples` (plural) field.
@@ -2618,7 +2622,7 @@ $ref: '#/components/schemas/Pet'
26182622
$ref: Pet.yaml
26192623
```
26202624

2621-
##### Relative Documents With Embedded Schema Example
2625+
##### Relative Documents with Embedded Schema Example
26222626

26232627
```json
26242628
{
@@ -4087,7 +4091,7 @@ when expanded with the data given earlier, we get:
40874091
?a=x%2By&b=x%2Fy&c=x%5Ey&words=math,is,fun
40884092
```
40894093

4090-
#### Expansion With Non-RFC6570-Supported Options
4094+
#### Expansion with Non-RFC6570-Supported Options
40914095

40924096
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.
40934097
To do that, we'll add `allowReserved: true` to `formulas`, and change to `style: "spaceDelimited"` for `words`:

0 commit comments

Comments
 (0)