Skip to content

Commit 2f547da

Browse files
committed
"Object" def, "with" in titles, fix level
Define capital-O "Object" to make it clear why it is only occasionally capitalized. Use lowercase "with" in titles consistently (it was more common than capitalized "With". This is one of those rules that is different depending on whose style guide you use- about half the major guides say always lowercase, the other say always captial. We were using lowercase more often. Also, fix "Working with Examples" to be a subsection of the Example Object as otherwise it breaks the pattern of all of the headings of its level being Object definitions. I remember messing with this a lot when I first posted that PR and either I just missed this or I had some reason I have now forgotten to do it this way.
1 parent f0ebca0 commit 2f547da

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

versions/3.1.1.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.
@@ -229,7 +233,7 @@ The formats defined by the OAS are:
229233

230234
As noted under [Data Type](#data-types), both `type: number` and `type: integer` are considered to be numbers in the data model.
231235

232-
#### Working With Binary Data
236+
#### Working with Binary Data
233237

234238
The OAS can describe either _raw_ or _encoded_ binary data.
235239

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

2202-
#### Working With Examples
2206+
##### Working with Examples
22032207

22042208
Example Objects can be used in both [Parameter Objects](#parameter-object) and [Media Type Objects](#media-type-object).
22052209
In both Objects, this is done through the `examples` (plural) field.
@@ -2697,7 +2701,7 @@ $ref: '#/components/schemas/Pet'
26972701
$ref: Pet.yaml
26982702
```
26992703

2700-
##### Relative Documents With Embedded Schema Example
2704+
##### Relative Documents with Embedded Schema Example
27012705

27022706
```json
27032707
{
@@ -4295,7 +4299,7 @@ when expanded with the data given earlier, we get:
42954299
?a=x%2By&b=x%2Fy&c=x%5Ey&words=math,is,fun
42964300
```
42974301

4298-
#### Expansion With Non-RFC6570-Supported Options
4302+
#### Expansion with Non-RFC6570-Supported Options
42994303

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

0 commit comments

Comments
 (0)