Skip to content

Commit 862a8e3

Browse files
philsturgeonPhil Sturgeon
and
Phil Sturgeon
authored
long descriptions are cool too (#2408)
Co-authored-by: Phil Sturgeon <me@philsturgeon.uk>
1 parent 99eabdf commit 862a8e3

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

versions/3.1.0.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ Field Name | Type | Description
203203
---|:---:|---
204204
<a name="infoTitle"></a>title | `string` | **REQUIRED**. The title of the API.
205205
<a name="infoSummary"></a>summary | `string` | A short summary of the API.
206-
<a name="infoDescription"></a>description | `string` | A short description of the API. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
206+
<a name="infoDescription"></a>description | `string` | A description of the API. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
207207
<a name="infoTermsOfService"></a>termsOfService | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL.
208208
<a name="infoContact"></a>contact | [Contact Object](#contactObject) | The contact information for the exposed API.
209209
<a name="infoLicense"></a>license | [License Object](#licenseObject) | The license information for the exposed API.
@@ -971,7 +971,7 @@ Allows referencing an external resource for extended documentation.
971971

972972
Field Name | Type | Description
973973
---|:---:|---
974-
<a name="externalDocDescription"></a>description | `string` | A short description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
974+
<a name="externalDocDescription"></a>description | `string` | A description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
975975
<a name="externalDocUrl"></a>url | `string` | **REQUIRED**. The URL for the target documentation. Value MUST be in the format of a URL.
976976

977977
This object MAY be extended with [Specification Extensions](#specificationExtensions).
@@ -1707,7 +1707,7 @@ Describes a single response from an API Operation, including design-time, static
17071707
##### Fixed Fields
17081708
Field Name | Type | Description
17091709
---|:---:|---
1710-
<a name="responseDescription"></a>description | `string` | **REQUIRED**. A short description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
1710+
<a name="responseDescription"></a>description | `string` | **REQUIRED**. A description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
17111711
<a name="responseHeaders"></a>headers | Map[`string`, [Header Object](#headerObject) \| [Reference Object](#referenceObject)] | Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored.
17121712
<a name="responseContent"></a>content | Map[`string`, [Media Type Object](#mediaTypeObject)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*
17131713
<a name="responseLinks"></a>links | Map[`string`, [Link Object](#linkObject) \| [Reference Object](#referenceObject)] | A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for [Component Objects](#componentsObject).
@@ -2213,7 +2213,7 @@ It is not mandatory to have a Tag Object per tag defined in the Operation Object
22132213
Field Name | Type | Description
22142214
---|:---:|---
22152215
<a name="tagName"></a>name | `string` | **REQUIRED**. The name of the tag.
2216-
<a name="tagDescription"></a>description | `string` | A short description for the tag. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
2216+
<a name="tagDescription"></a>description | `string` | A description for the tag. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
22172217
<a name="tagExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this tag.
22182218

22192219
This object MAY be extended with [Specification Extensions](#specificationExtensions).
@@ -3168,7 +3168,7 @@ Please note that as of 2020, the implicit flow is about to be deprecated by [OAu
31683168
Field Name | Type | Applies To | Description
31693169
---|:---:|---|---
31703170
<a name="securitySchemeType"></a>type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"mutualTLS"`, `"oauth2"`, `"openIdConnect"`.
3171-
<a name="securitySchemeDescription"></a>description | `string` | Any | A short description for security scheme. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
3171+
<a name="securitySchemeDescription"></a>description | `string` | Any | A description for security scheme. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
31723172
<a name="securitySchemeName"></a>name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used.
31733173
<a name="securitySchemeIn"></a>in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"` or `"cookie"`.
31743174
<a name="securitySchemeScheme"></a>scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). The values used SHOULD be registered in the [IANA Authentication Scheme registry](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml).

0 commit comments

Comments
 (0)