Skip to content

Commit 2988a11

Browse files
committed
minor doc updates for #589
1 parent 7141ddf commit 2988a11

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

versions/3.0.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1350,12 +1350,16 @@ items:
13501350

13511351
A container for the expected responses of an operation.
13521352
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.
13551357

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.
13571360

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.
13591363

13601364
##### Fixed Fields
13611365
Field Name | Type | Description
@@ -1417,24 +1421,26 @@ default:
14171421
```
14181422

14191423
#### <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.
14211426

14221427
##### Fixed Fields
14231428
Field Name | Type | Description
14241429
---|:---:|---
14251430
<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.
14261431
<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.
14281433
<a name="responseLinks"></a>links | [Links Object](#linksObject) | An object representing operations related to the response payload.
14291434

14301435

14311436
##### Patterned Objects
14321437

14331438
Field Pattern | Type | Description
14341439
---|:---:|---
1435-
<a name="representations"></a>`*` | [Schema Object](#schemaObject)<span>&#124;</span> [Reference Object](#referenceObject) | A schema describing the response value for a specific `Content-Type`
1440+
<a name="responseContentType"></a>`*` | [Schema Object](#schemaObject)<span>&#124;</span> [Reference Object](#referenceObject) | A schema describing the response value for a specific `Content-Type`
14361441

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
14381444

14391445
This object can be extended with [Specification Extensions](#specificationExtensions).
14401446

@@ -1492,7 +1498,7 @@ representations:
14921498
type: string
14931499
```
14941500

1495-
Response with headers:
1501+
Plain text response with headers:
14961502

14971503
```json
14981504
{

0 commit comments

Comments
 (0)