From 2988a1162ee1180df5587e4632ac108d006514f0 Mon Sep 17 00:00:00 2001 From: Tony Tam Date: Thu, 16 Feb 2017 14:03:34 -0800 Subject: [PATCH] minor doc updates for #589 --- versions/3.0.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/versions/3.0.md b/versions/3.0.md index 2e792ae612..397536523f 100644 --- a/versions/3.0.md +++ b/versions/3.0.md @@ -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 @@ -1417,14 +1421,15 @@ default: ``` #### 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 ---|:---:|--- description | `string` | **Required.** A short description of the response. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation. headers | [Headers Object](#headersObject) | A list of headers that are sent with the response. -content | [Content Object](#contentObject) | An object containing descriptions of potential response payloads. +content | [Content Object](#contentObject) | An object containing descriptions of potential response payloads. links | [Links Object](#linksObject) | An object representing operations related to the response payload. @@ -1432,9 +1437,10 @@ Field Name | Type | Description Field Pattern | Type | Description ---|:---:|--- -`*` | [Schema Object](#schemaObject)| [Reference Object](#referenceObject) | A schema describing the response value for a specific `Content-Type` +`*` | [Schema Object](#schemaObject)| [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). @@ -1492,7 +1498,7 @@ representations: type: string ``` -Response with headers: +Plain text response with headers: ```json {