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: src/oas.md
+26-25Lines changed: 26 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -607,7 +607,7 @@ The path itself is still exposed to the documentation viewer but they will not k
607
607
| <a name="path-item-head"></a>head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. |
608
608
| <a name="path-item-patch"></a>patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. |
609
609
| <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. |
611
611
| <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). |
612
612
| <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. |
613
613
| <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
788
788
789
789
| Field Name | Type | Description |
790
790
| ---- | :----: | ---- |
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> |
792
792
| <a name="parameter-in"></a>in | `string` | **REQUIRED**. The location of the parameter. Possible values are `"query"`, `"querystring"`, `"header"`, `"path"` or `"cookie"`. |
793
793
| <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. |
794
794
| <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:
1605
1605
format: int64
1606
1606
- properties:
1607
1607
event:
1608
-
const: addJson
1608
+
const: addJSON
1609
1609
data:
1610
1610
$comment: |
1611
1611
These content fields indicate
@@ -1831,9 +1831,9 @@ requestBody:
1831
1831
# image media type(s) in the Encoding Object.
1832
1832
type: string
1833
1833
contentEncoding: base64url
1834
-
encoding:
1835
-
icon:
1836
-
contentType: image/png, image/jpeg
1834
+
encoding:
1835
+
icon:
1836
+
contentType: image/png, image/jpeg
1837
1837
```
1838
1838
1839
1839
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
1851
1851
1852
1852
See [Encoding Usage and Restrictions](#encoding-usage-and-restrictions) for guidance on correlating schema properties with parts.
1853
1853
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)).
1855
1855
1856
1856
##### Handling Multiple `contentType` Values
1857
1857
@@ -2771,7 +2771,7 @@ components:
2771
2771
content:
2772
2772
application/linkset+json:
2773
2773
schema:
2774
-
$ref: '#/components/mediaTypes/CollectionLinks'
2774
+
$ref: '#/components/schemas/CollectionLinks'
2775
2775
```
2776
2776
2777
2777
#### Representing the `Set-Cookie` Header
@@ -2849,11 +2849,10 @@ components:
2849
2849
explode: true
2850
2850
examples:
2851
2851
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"
2857
2856
serializedValue: |
2858
2857
lang=en-US; Expires=Wed, 09 Jun 2021 10:18:14 GMT
2859
2858
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
0 commit comments