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