Skip to content

Commit 111cf2b

Browse files
committed
Change markdown standard from GFM to CommonMark
1 parent 12e553f commit 111cf2b

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

versions/3.0.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ The object provides metadata about the API. The metadata can be used by the clie
138138
Field Name | Type | Description
139139
---|:---:|---
140140
<a name="infoTitle"></a>title | `string` | **Required.** The title of the application.
141-
<a name="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+
<a name="infoDescription"></a>description | `string` | A short description of the application. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
142142
<a name="infoTermsOfService"></a>termsOfService | `string` | A URL to the Terms of Service for the API.
143143
<a name="infoContact"></a>contact | [Contact Object](#contactObject) | The contact information for the exposed API.
144144
<a name="infoLicense"></a>license | [License Object](#licenseObject) | The license information for the exposed API.
@@ -445,7 +445,7 @@ Field Name | Type | Description
445445
---|:---:|---
446446
<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.
447447
<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.
449449
<a name="operationExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this operation.
450450
<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.
451451
<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.
572572

573573
Field Name | Type | Description
574574
---|:---:|---
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.
576576
<a name="externalDocUrl"></a>url | `string` | **Required.** The URL for the target documentation. Value MUST be in the format of a URL.
577577

578578
##### Patterned Objects
@@ -619,7 +619,7 @@ Field Name | Type | Description
619619
---|:---:|---
620620
<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>
621621
<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.
623623
<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`.
624624
<a name="parameterDeprecated"></a> deprecated | `boolean` | Specifies that a parameter is deprecated and should be transitioned out of usage.
625625
<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
747747
##### Fixed Fields
748748
Field Name | Type | Description
749749
---|:---:|---
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.
751751
<a name="requestBodySchema"></a>schema | [Schema Object](#schemaObject) | The schema defining the type used for the request body.
752752
<a name="requestBodyExamples"></a>examples | [Examples Object](#examplesObject) | Examples of the request body, referenced by media type.
753753
<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
943943
##### Fixed Fields
944944
Field Name | Type | Description
945945
---|:---:|---
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.
947947
<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.
948948
<a name="responseHeaders"></a>headers | [Headers Object](#headersObject) | A list of headers that are sent with the response.
949949
<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](#
15691569
Field Name | Type | Description
15701570
---|:---:|---
15711571
<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.
15731573
<a name="tagExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this tag.
15741574

15751575
##### Patterned Fields
@@ -1697,7 +1697,7 @@ The following properties are taken directly from the JSON Schema definition and
16971697
- $ref - As a [JSON Reference](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03)
16981698
- format (See [Data Type Formats](#dataTypeFormat) for further details)
16991699
- 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)
17011701
- default (Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object)
17021702
- multipleOf
17031703
- maximum

0 commit comments

Comments
 (0)