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/2.0.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -137,7 +137,7 @@ The object provides metadata about the API. The metadata can be used by the clie
137
137
Field Name | Type | Description
138
138
---|:---:|---
139
139
<aname="infoTitle"></a>title | `string` | **Required.** The title of the application.
140
-
<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.
140
+
<aname="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.
141
141
<aname="infoTermsOfService"></a>termsOfService | `string` | The Terms of Service for the API.
142
142
<aname="infoContact"></a>contact | [Contact Object](#contactObject) | The contact information for the exposed API.
143
143
<aname="infoLicense"></a>license | [License Object](#licenseObject) | The license information for the exposed API.
@@ -412,7 +412,7 @@ Field Name | Type | Description
412
412
---|:---:|---
413
413
<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.
414
414
<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.
416
416
<a name="operationExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this operation.
417
417
<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.
418
418
<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.
535
535
536
536
Field Name | Type | Description
537
537
---|:---:|---
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.
539
539
<a name="externalDocUrl"></a>url | `string` | **Required.** The URL for the target documentation. Value MUST be in the format of a URL.
540
540
541
541
##### Patterned Objects
@@ -578,7 +578,7 @@ Field Name | Type | Description
578
578
---|:---:|---
579
579
<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>
580
580
<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.
582
582
<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`.
583
583
584
584
If [`in`](#parameterIn) is `"body"`:
@@ -891,7 +891,7 @@ Describes a single response from an API Operation.
891
891
##### Fixed Fields
892
892
Field Name | Type | Description
893
893
---|:---:|---
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.
895
895
<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.
896
896
<a name="responseHeaders"></a>headers | [Headers Object](#headersObject) | A list of headers that are sent with the response.
897
897
<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](#
1124
1124
Field Name | Type | Description
1125
1125
---|:---:|---
1126
1126
<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.
1128
1128
<a name="tagExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this tag.
1129
1129
1130
1130
##### Patterned Fields
@@ -1201,7 +1201,7 @@ The following properties are taken directly from the JSON Schema definition and
1201
1201
- $ref - As a [JSON Reference](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03)
1202
1202
- format (See [Data Type Formats](#dataTypeFormat) for further details)
1203
1203
- 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)
1205
1205
- default (Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object)
0 commit comments