Skip to content

Commit 0ccb232

Browse files
authored
Merge branch 'v3.2-dev' into ether/v3.2-contentType-ABNF
2 parents 920a9fb + b847ebb commit 0ccb232

2 files changed

Lines changed: 27 additions & 25 deletions

File tree

.linkspector.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ files:
1313
ignorePatterns:
1414
- pattern: 'clientdomain.com'
1515
- pattern: 'example.org'
16+
- pattern: 'https://www.w3.org/TR/xml-names11/'

src/oas.md

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -607,7 +607,7 @@ The path itself is still exposed to the documentation viewer but they will not k
607607
| <a name="path-item-head"></a>head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. |
608608
| <a name="path-item-patch"></a>patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. |
609609
| <a name="path-item-trace"></a>trace | [Operation Object](#operation-object) | A definition of a TRACE operation on this path. |
610-
| <a name="path-item-query"></a>query | [Operation Object](#operation-object) | A definition of a QUERY operation, as defined in the most recent IETF draft ([draft-ietf-httpbis-safe-method-w-body-08](https://www.ietf.org/archive/id/draft-ietf-httpbis-safe-method-w-body-11.html) as of this writing) or its RFC successor, on this path. |
610+
| <a name="path-item-query"></a>query | [Operation Object](#operation-object) | A definition of a QUERY operation, as defined in the most recent IETF draft ([draft-ietf-httpbis-safe-method-w-body-14](https://www.ietf.org/archive/id/draft-ietf-httpbis-safe-method-w-body-14.html) as of this writing) or its RFC successor, on this path. |
611611
| <a name="path-item-additional-operations"></a>additionalOperations | Map[`string`, [Operation Object](#operation-object)] | A map of additional operations on this path. The map key is the HTTP method with the same capitalization that is to be sent in the request. This map MUST NOT contain any entry for the methods that can be defined by other fixed fields with Operation Object values (e.g. no `POST` entry, as the `post` field is used for this method). |
612612
| <a name="path-item-servers"></a>servers | [[Server Object](#server-object)] | An alternative `servers` array to service all operations in this path. If a `servers` array is specified at the [OpenAPI Object](#oas-servers) level, it will be overridden by this value. |
613613
| <a name="path-item-parameters"></a>parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameter-name) and [location](#parameter-in). The list can use the [Reference Object](#reference-object) to link to parameters that are defined in the [OpenAPI Object's `components.parameters`](#components-parameters). |
@@ -788,7 +788,7 @@ The `example` and `examples` fields are mutually exclusive; see [Working with Ex
788788

789789
| Field Name | Type | Description |
790790
| ---- | :----: | ---- |
791-
| <a name="parameter-name"></a>name | `string` | **REQUIRED**. The name of the parameter. Parameter names are _case-sensitive_. <ul><li>If [`in`](#parameter-in) is `"path"`, the `name` field MUST correspond to a single template expression occurring within the [path](#paths-path) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.<li>If [`in`](#parameter-in) is `"header"` and the `name` field is `"Accept"`, `"Content-Type"` or `"Authorization"`, the parameter definition SHALL be ignored.<li>If `in` is `"querystring"`, or for [certain combinations](#style-examples) of [`style`](#parameter-style) and [`explode`](#parameter-explode), the value of `name` is not used in the parameter serialization.<li>For all other cases, the `name` corresponds to the parameter name used by the [`in`](#parameter-in) field.</ul> |
791+
| <a name="parameter-name"></a>name | `string` | **REQUIRED**. The name of the parameter. Parameter names are _case-sensitive_. <ul><li>If [`in`](#parameter-in) is `"path"`, the `name` field MUST correspond to a single template expression occurring within the [path](#paths-path) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.</li><li>If [`in`](#parameter-in) is `"header"` and the `name` field is `"Accept"`, `"Content-Type"` or `"Authorization"`, the parameter definition SHALL be ignored.</li><li>If `in` is `"querystring"`, or for [certain combinations](#style-examples) of [`style`](#parameter-style) and [`explode`](#parameter-explode), the value of `name` is not used in the parameter serialization.</li><li>For all other cases, the `name` corresponds to the parameter name used by the [`in`](#parameter-in) field.</li></ul> |
792792
| <a name="parameter-in"></a>in | `string` | **REQUIRED**. The location of the parameter. Possible values are `"query"`, `"querystring"`, `"header"`, `"path"` or `"cookie"`. |
793793
| <a name="parameter-description"></a>description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. |
794794
| <a name="parameter-required"></a>required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameter-in) is `"path"`, this field is **REQUIRED** and its value MUST be `true`. Otherwise, the field MAY be included and its default value is `false`. |
@@ -1605,7 +1605,7 @@ content:
16051605
format: int64
16061606
- properties:
16071607
event:
1608-
const: addJson
1608+
const: addJSON
16091609
data:
16101610
$comment: |
16111611
These content fields indicate
@@ -1831,9 +1831,9 @@ requestBody:
18311831
# image media type(s) in the Encoding Object.
18321832
type: string
18331833
contentEncoding: base64url
1834-
encoding:
1835-
icon:
1836-
contentType: image/png, image/jpeg
1834+
encoding:
1835+
icon:
1836+
contentType: image/png, image/jpeg
18371837
```
18381838
18391839
Given a name of `example` and a solid red 2x2-pixel PNG for `icon`, this
@@ -1851,7 +1851,7 @@ However, this is not guaranteed, so it may be more interoperable to keep the pad
18511851

18521852
See [Encoding Usage and Restrictions](#encoding-usage-and-restrictions) for guidance on correlating schema properties with parts.
18531853

1854-
Note that there are significant restrictions on what headers can be used with `multipart` media types in general ([RFC2046](https://www.rfc-editor.org/rfc/rfc2046.html#section-5.1)) and `multi-part/form-data` in particular ([RFC7578](https://www.rfc-editor.org/rfc/rfc7578.html#section-4.8)).
1854+
Note that there are significant restrictions on what headers can be used with `multipart` media types in general ([RFC2046](https://www.rfc-editor.org/rfc/rfc2046.html#section-5.1)) and `multipart/form-data` in particular ([RFC7578](https://www.rfc-editor.org/rfc/rfc7578.html#section-4.8)).
18551855

18561856
##### Handling Multiple `contentType` Values
18571857

@@ -2771,7 +2771,7 @@ components:
27712771
content:
27722772
application/linkset+json:
27732773
schema:
2774-
$ref: '#/components/mediaTypes/CollectionLinks'
2774+
$ref: '#/components/schemas/CollectionLinks'
27752775
```
27762776
27772777
#### Representing the `Set-Cookie` Header
@@ -2849,11 +2849,10 @@ components:
28492849
explode: true
28502850
examples:
28512851
SetCookies:
2852-
dataValue: {
2853-
"lang": "en-US; Expires=Wed, 09 Jun 2021 10:18:14 GMT"
2854-
"foo": "bar; Expires=Wed, 09 Jun 2021 10:18:14 GMT"
2855-
"urlSafeData": "Hello%2C%20world%21"
2856-
}
2852+
dataValue:
2853+
lang: "en-US; Expires=Wed, 09 Jun 2021 10:18:14 GMT"
2854+
foo: "bar; Expires=Wed, 09 Jun 2021 10:18:14 GMT"
2855+
urlSafeData: "Hello%2C%20world%21"
28572856
serializedValue: |
28582857
lang=en-US; Expires=Wed, 09 Jun 2021 10:18:14 GMT
28592858
foo=bar; Expires=Wed, 09 Jun 2021 10:18:14 GMT
@@ -3160,7 +3159,7 @@ This means that the data form of this serialization is equivalent to the followi
31603159
```json
31613160
{
31623161
"code": "1234",
3163-
"count": 42
3162+
"count": 42,
31643163
"extra": {
31653164
"info": "abc"
31663165
}
@@ -4293,14 +4292,15 @@ application/xml:
42934292
name: Fluffy
42944293
- kind: Dog
42954294
name: Fido
4295+
externalValue: ./examples/pets.xml
42964296
```
42974297

42984298
Where `./examples/pets.xml` would be:
42994299

43004300
```xml
43014301
<animals>
4302-
<animal kind="Cat">Fluffy</animals>
4303-
<animal kind="Dog">Fido</animals>
4302+
<animal kind="Cat">Fluffy</animal>
4303+
<animal kind="Dog">Fido</animal>
43044304
<animals>
43054305
```
43064306

@@ -4321,15 +4321,16 @@ components:
43214321
xml:
43224322
nodeType: cdata
43234323
responses:
4324-
content:
4325-
application/xml:
4326-
schema:
4327-
$ref: "#/components/schemas/Documentation"
4328-
examples:
4329-
docs:
4330-
dataValue:
4331-
content: <html><head><title>Awesome Docs</title></head><body></body><html>
4332-
externalValue: ./examples/docs.xml
4324+
AwesomeDocs:
4325+
content:
4326+
application/xml:
4327+
schema:
4328+
$ref: "#/components/schemas/Documentation"
4329+
examples:
4330+
docs:
4331+
dataValue:
4332+
content: <html><head><title>Awesome Docs</title></head><body></body><html>
4333+
externalValue: ./examples/docs.xml
43334334
```
43344335

43354336
Where `./examples/docs.xml` would be:

0 commit comments

Comments
 (0)