You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: versions/3.0.md
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -138,7 +138,7 @@ The object provides metadata about the API. The metadata can be used by the clie
138
138
Field Name | Type | Description
139
139
---|:---:|---
140
140
<aname="infoTitle"></a>title | `string` | **Required.** The title of the application.
141
-
<aname="infoDescription"></a>description | `string` | A short description of the application. [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation.
141
+
<aname="infoDescription"></a>description | `string` | A short description of the application. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
142
142
<aname="infoTermsOfService"></a>termsOfService | `string` | A URL to the Terms of Service for the API.
143
143
<aname="infoContact"></a>contact | [Contact Object](#contactObject) | The contact information for the exposed API.
144
144
<aname="infoLicense"></a>license | [License Object](#licenseObject) | The license information for the exposed API.
@@ -445,7 +445,7 @@ Field Name | Type | Description
445
445
---|:---:|---
446
446
<a name="operationTags"></a>tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
447
447
<a name="operationSummary"></a>summary | `string` | A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
448
-
<a name="operationDescription"></a>description | `string` | A verbose explanation of the operation behavior. [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation.
448
+
<a name="operationDescription"></a>description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
449
449
<a name="operationExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this operation.
450
450
<a name="operationId"></a>operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.
451
451
<a name="operationConsumes"></a>consumes | [`string`] | A list of media types the operation can consume. This overrides the [`consumes`](#oasConsumes) definition at the OpenAPI Object. An empty value MAY be used to clear the global definition. Value MUST be as described under [Media Types](#mediaTypes).
@@ -572,7 +572,7 @@ Allows referencing an external resource for extended documentation.
572
572
573
573
Field Name | Type | Description
574
574
---|:---:|---
575
-
<a name="externalDocDescription"></a>description | `string` | A short description of the target documentation. [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation.
575
+
<a name="externalDocDescription"></a>description | `string` | A short description of the target documentation. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
576
576
<a name="externalDocUrl"></a>url | `string` | **Required.** The URL for the target documentation. Value MUST be in the format of a URL.
577
577
578
578
##### Patterned Objects
@@ -619,7 +619,7 @@ Field Name | Type | Description
619
619
---|:---:|---
620
620
<a name="parameterName"></a>name | `string` | **Required.** The name of the parameter. Parameter names are *case sensitive*. <ul><li>If [`in`](#parameterIn) is `"path"`, the `name` field MUST correspond to the associated path segment from the [path](#pathsPath) field in the [Paths Object](#pathsObject). See [Path Templating](#pathTemplating) for further information.<li>For all other cases, the `name` corresponds to the parameter name used based on the [`in`](#parameterIn) property.</ul>
621
621
<a name="parameterIn"></a>in | `string` | **Required.** The ___location of the parameter. Possible values are "query", "header", "path", "formData" or "cookie".
622
-
<a name="parameterDescription"></a>description | `string` | A brief description of the parameter. This could contain examples of use. [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation.
622
+
<a name="parameterDescription"></a>description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
623
623
<a name="parameterRequired"></a>required | `boolean` | Determines whether this parameter is mandatory. If the parameter is [`in`](#parameterIn) "path", this property is **required** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`.
624
624
<a name="parameterDeprecated"></a> deprecated | `boolean` | Specifies that a parameter is deprecated and should be transitioned out of usage.
625
625
<a name="parameterSchema"></a>schema | [Schema Object](#schemaObject) | The schema defining the type used for the parameter.
@@ -747,7 +747,7 @@ The `Content-Type` of the request body must be specified by the `consumes` attri
747
747
##### Fixed Fields
748
748
Field Name | Type | Description
749
749
---|:---:|---
750
-
<a name="requestBodyDescription"></a>description | `string` | A brief description of the request body. This could contain examples of use. [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation.
750
+
<a name="requestBodyDescription"></a>description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
751
751
<a name="requestBodySchema"></a>schema | [Schema Object](#schemaObject) | The schema defining the type used for the request body.
752
752
<a name="requestBodyExamples"></a>examples | [Examples Object](#examplesObject) | Examples of the request body, referenced by media type.
753
753
<a name="requestBodyRequired"></a>required | `boolean` | Determines if the request body is required in the request. Defaults to `true`.
@@ -943,7 +943,7 @@ Describes a single response from an API Operation, including design-time, static
943
943
##### Fixed Fields
944
944
Field Name | Type | Description
945
945
---|:---:|---
946
-
<a name="responseDescription"></a>description | `string` | **Required.** A short description of the response. [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation.
946
+
<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.
947
947
<a name="responseSchema"></a>schema | [Schema Object](#schemaObject) | A definition of the response structure. It can be a primitive, an array or an object. If this field does not exist, it means no content is returned as part of the response. As an extension to the [Schema Object](#schemaObject), its root `type` value may also be `"file"`. This SHOULD be accompanied by a relevant `produces` media type.
948
948
<a name="responseHeaders"></a>headers | [Headers Object](#headersObject) | A list of headers that are sent with the response.
949
949
<a name="responseExamples"></a>examples | [Example Object](#exampleObject) | An example of the response message.
@@ -1569,7 +1569,7 @@ Allows adding meta data to a single tag that is used by the [Operation Object](#
1569
1569
Field Name | Type | Description
1570
1570
---|:---:|---
1571
1571
<a name="tagName"></a>name | `string` | **Required.** The name of the tag.
1572
-
<a name="tagDescription"></a>description | `string` | A short description for the tag. [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation.
1572
+
<a name="tagDescription"></a>description | `string` | A short description for the tag. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
1573
1573
<a name="tagExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this tag.
1574
1574
1575
1575
##### Patterned Fields
@@ -1697,7 +1697,7 @@ The following properties are taken directly from the JSON Schema definition and
1697
1697
- $ref - As a [JSON Reference](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03)
1698
1698
- format (See [Data Type Formats](#dataTypeFormat) for further details)
1699
1699
- title
1700
-
- description ([GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation)
1700
+
- description ([CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation)
1701
1701
- default (Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object)
0 commit comments