Skip to content

Commit fb50e3f

Browse files
committed
The URL for Github Flavored Markdown documentation changed
This feature seemed to be the best analog to the previous page: https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown
1 parent 39624ac commit fb50e3f

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

versions/2.0.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ The object provides metadata about the API. The metadata can be used by the clie
137137
Field Name | Type | Description
138138
---|:---:|---
139139
<a name="infoTitle"></a>title | `string` | **Required.** The title of the application.
140-
<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.
140+
<a name="infoDescription"></a>description | `string` | A short description of the application. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation.
141141
<a name="infoTermsOfService"></a>termsOfService | `string` | The Terms of Service for the API.
142142
<a name="infoContact"></a>contact | [Contact Object](#contactObject) | The contact information for the exposed API.
143143
<a name="infoLicense"></a>license | [License Object](#licenseObject) | The license information for the exposed API.
@@ -412,7 +412,7 @@ Field Name | Type | Description
412412
---|:---:|---
413413
<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.
414414
<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.
415-
<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.
415+
<a name="operationDescription"></a>description | `string` | A verbose explanation of the operation behavior. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation.
416416
<a name="operationExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this operation.
417417
<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.
418418
<a name="operationConsumes"></a>consumes | [`string`] | A list of MIME types the operation can consume. This overrides the [`consumes`](#swaggerConsumes) definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under [Mime Types](#mimeTypes).
@@ -535,7 +535,7 @@ Allows referencing an external resource for extended documentation.
535535

536536
Field Name | Type | Description
537537
---|:---:|---
538-
<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.
538+
<a name="externalDocDescription"></a>description | `string` | A short description of the target documentation. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation.
539539
<a name="externalDocUrl"></a>url | `string` | **Required.** The URL for the target documentation. Value MUST be in the format of a URL.
540540

541541
##### Patterned Objects
@@ -578,7 +578,7 @@ Field Name | Type | Description
578578
---|:---:|---
579579
<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>
580580
<a name="parameterIn"></a>in | `string` | **Required.** The ___location of the parameter. Possible values are "query", "header", "path", "formData" or "body".
581-
<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.
581+
<a name="parameterDescription"></a>description | `string` | A brief description of the parameter. This could contain examples of use. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation.
582582
<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`.
583583

584584
If [`in`](#parameterIn) is `"body"`:
@@ -891,7 +891,7 @@ Describes a single response from an API Operation.
891891
##### Fixed Fields
892892
Field Name | Type | Description
893893
---|:---:|---
894-
<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.
894+
<a name="responseDescription"></a>description | `string` | **Required.** A short description of the response. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation.
895895
<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` mime-type.
896896
<a name="responseHeaders"></a>headers | [Headers Object](#headersObject) | A list of headers that are sent with the response.
897897
<a name="responseExamples"></a>examples | [Example Object](#exampleObject) | An example of the response message.
@@ -1124,7 +1124,7 @@ Allows adding meta data to a single tag that is used by the [Operation Object](#
11241124
Field Name | Type | Description
11251125
---|:---:|---
11261126
<a name="tagName"></a>name | `string` | **Required.** The name of the tag.
1127-
<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.
1127+
<a name="tagDescription"></a>description | `string` | A short description for the tag. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation.
11281128
<a name="tagExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this tag.
11291129

11301130
##### Patterned Fields
@@ -1201,7 +1201,7 @@ The following properties are taken directly from the JSON Schema definition and
12011201
- $ref - As a [JSON Reference](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03)
12021202
- format (See [Data Type Formats](#dataTypeFormat) for further details)
12031203
- title
1204-
- description ([GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation)
1204+
- description ([GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation)
12051205
- default (Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object)
12061206
- multipleOf
12071207
- maximum

0 commit comments

Comments
 (0)