Skip to content

Commit b7cdbd6

Browse files
authored
Merge pull request OAI#887 from OAI/issue-589-responses
minor doc updates for OAI#589
2 parents e62b1b1 + 2988a11 commit b7cdbd6

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
@@ -1351,12 +1351,16 @@ items:
13511351

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

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

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

13611365
##### Fixed Fields
13621366
Field Name | Type | Description
@@ -1418,24 +1422,26 @@ default:
14181422
```
14191423

14201424
#### <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.
14221427

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

14311436

14321437
##### Patterned Objects
14331438

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

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
14391445

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

@@ -1493,7 +1499,7 @@ representations:
14931499
type: string
14941500
```
14951501

1496-
Response with headers:
1502+
Plain text response with headers:
14971503

14981504
```json
14991505
{

0 commit comments

Comments
 (0)