Skip to content

minor doc updates for #589 #887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 17, 2017
Merged

minor doc updates for #589 #887

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 15 additions & 9 deletions versions/3.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1350,12 +1350,16 @@ items:

A container for the expected responses of an operation.
The container maps a HTTP response code to the expected response.
It is not expected from the documentation to necessarily cover all possible HTTP response codes, since they may not be known in advance.
However, it is expected from the documentation to cover a successful operation response and any known errors.
It is not expected from the documentation to necessarily cover all possible HTTP
response codes, since they may not be known in advance. However, it is expected
from the documentation to cover a successful operation response and any
known errors.

The `default` MAY be used as a default response object for all HTTP codes that are not covered individually by the specification.
The `default` MAY be used as a default response object for all HTTP codes
that are not covered individually by the specification.

The `Responses Object` MUST contain at least one response code, and it SHOULD be the response for a successful operation call.
The `Responses Object` MUST contain at least one response code, and it
SHOULD be the response for a successful operation call.

##### Fixed Fields
Field Name | Type | Description
Expand Down Expand Up @@ -1417,24 +1421,26 @@ default:
```

#### <a name="responseObject"></a>Response Object
Describes a single response from an API Operation, including design-time, static `links` to operations based on the response.
Describes a single response from an API Operation, including design-time, static
`links` to operations based on the response.

##### Fixed Fields
Field Name | Type | Description
---|:---:|---
<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.
<a name="responseHeaders"></a>headers | [Headers Object](#headersObject) | A list of headers that are sent with the response.
<a name="responseRepresentations"></a>content | [Content Object](#contentObject) | An object containing descriptions of potential response payloads.
<a name="responseContentObject"></a>content | [Content Object](#contentObject) | An object containing descriptions of potential response payloads.
<a name="responseLinks"></a>links | [Links Object](#linksObject) | An object representing operations related to the response payload.


##### Patterned Objects

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

Representations may take the form of a wildcard (`*`) to designate any `Content-Type`, or a regular expression for matching a specific type
Representations may take the form of a wildcard (`*`) to designate any `Content-Type`,
or a regular expression for matching a specific type

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

Expand Down Expand Up @@ -1492,7 +1498,7 @@ representations:
type: string
```

Response with headers:
Plain text response with headers:

```json
{
Expand Down