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.md
+15-9Lines changed: 15 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -1350,12 +1350,16 @@ items:
1350
1350
1351
1351
A container for the expected responses of an operation.
1352
1352
The container maps a HTTP response code to the expected response.
1353
-
It is not expected from the documentation to necessarily cover all possible HTTP response codes, since they may not be known in advance.
1354
-
However, it is expected from the documentation to cover a successful operation response and any known errors.
1353
+
It is not expected from the documentation to necessarily cover all possible HTTP
1354
+
response codes, since they may not be known in advance. However, it is expected
1355
+
from the documentation to cover a successful operation response and any
1356
+
known errors.
1355
1357
1356
-
The `default` MAY be used as a default response object for all HTTP codes that are not covered individually by the specification.
1358
+
The `default` MAY be used as a default response object for all HTTP codes
1359
+
that are not covered individually by the specification.
1357
1360
1358
-
The `Responses Object` MUST contain at least one response code, and it SHOULD be the response for a successful operation call.
1361
+
The `Responses Object` MUST contain at least one response code, and it
1362
+
SHOULD be the response for a successful operation call.
1359
1363
1360
1364
##### Fixed Fields
1361
1365
Field Name | Type | Description
@@ -1417,24 +1421,26 @@ default:
1417
1421
```
1418
1422
1419
1423
#### <a name="responseObject"></a>Response Object
1420
-
Describes a single response from an API Operation, including design-time, static `links` to operations based on the response.
1424
+
Describes a single response from an API Operation, including design-time, static
1425
+
`links`to operations based on the response.
1421
1426
1422
1427
##### Fixed Fields
1423
1428
Field Name | Type | Description
1424
1429
---|:---:|---
1425
1430
<a name="responseDescription"></a>description | `string` | **Required.** A short description of the response. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
1426
1431
<a name="responseHeaders"></a>headers | [Headers Object](#headersObject) | A list of headers that are sent with the response.
1427
-
<a name="responseRepresentations"></a>content | [Content Object](#contentObject) | An object containing descriptions of potential response payloads.
1432
+
<a name="responseContentObject"></a>content | [Content Object](#contentObject) | An object containing descriptions of potential response payloads.
1428
1433
<a name="responseLinks"></a>links | [Links Object](#linksObject) | An object representing operations related to the response payload.
1429
1434
1430
1435
1431
1436
##### Patterned Objects
1432
1437
1433
1438
Field Pattern | Type | Description
1434
1439
---|:---:|---
1435
-
<a name="representations"></a>`*` | [Schema Object](#schemaObject)<span>|</span> [Reference Object](#referenceObject) | A schema describing the response value for a specific `Content-Type`
1440
+
<a name="responseContentType"></a>`*` | [Schema Object](#schemaObject)<span>|</span> [Reference Object](#referenceObject) | A schema describing the response value for a specific `Content-Type`
1436
1441
1437
-
Representations may take the form of a wildcard (`*`) to designate any `Content-Type`, or a regular expression for matching a specific type
1442
+
Representations may take the form of a wildcard (`*`) to designate any `Content-Type`,
1443
+
or a regular expression for matching a specific type
1438
1444
1439
1445
This object can be extended with [Specification Extensions](#specificationExtensions).
0 commit comments