Skip to content

Commit 2642291

Browse files
committed
merged #227
1 parent ded00d6 commit 2642291

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

versions/2.0.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Field Pattern | Type | Description
140140
---|:---:|---
141141
<a name="operationExtensions"></a>^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#vendorExtensions) for further details.
142142

143-
##### Object Example:
143+
##### Info Object Example:
144144

145145
```js
146146
{
@@ -186,7 +186,7 @@ Field Name | Type | Description
186186
<a name="contactUrl"></a>url | `string` | The URL pointing to the contact information. MUST be in the format of a URL.
187187
<a name="contactEmail"></a>email | `string` | The email address of the contact person/organization. MUST be in the format of an email address.
188188

189-
##### Object Example:
189+
##### Contact Object Example:
190190

191191
```js
192192
{
@@ -213,7 +213,7 @@ Field Name | Type | Description
213213
<a name="licenseName"></a>name | `string` | **Required.** The license name used for the API.
214214
<a name="licenseUrl"></a>url | `string` | A URL to the license used for the API. MUST be in the format of a URL.
215215

216-
##### Object Example:
216+
##### License Object Example:
217217

218218
```js
219219
{
@@ -239,7 +239,7 @@ Field Pattern | Type | Description
239239
<a name="pathsPath"></a>/{path} | [Path Item Object](#pathItemObject) | A relative path to an individual endpoint. The field name MUST begin with a slash. The path is appended to the [`basePath`](#swaggerBasePath) in order to construct the full URL. [Path templating](#pathTemplating) is allowed.
240240
<a name="pathsExtensions"></a>^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#vendorExtensions) for further details.
241241

242-
##### Object Example
242+
##### Paths Object Example
243243

244244
```js
245245
{
@@ -305,7 +305,7 @@ Field Pattern | Type | Description
305305
---|:---:|---
306306
<a name="pathItemExtensions"></a>^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#vendorExtensions) for further details.
307307

308-
##### Object Example
308+
##### Path Item Object Example
309309

310310
```js
311311
{
@@ -408,7 +408,7 @@ Field Pattern | Type | Description
408408
---|:---:|---
409409
<a name="operationExtensions"></a>^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#vendorExtensions) for further details.
410410

411-
##### Object Example
411+
##### Operation Object Example
412412

413413
```js
414414
{
@@ -517,7 +517,7 @@ Field Name | Type | Description
517517
<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.
518518
<a name="externalDocUrl"></a>url | `string` | **Required.** The URL for the target documentation. Value MUST be in the format of a URL.
519519

520-
##### Object Example
520+
##### External Documentation Object Example
521521

522522
```js
523523
{
@@ -589,7 +589,7 @@ Field Pattern | Type | Description
589589
<a name="parameterExtensions"></a>^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#vendorExtensions) for further details.
590590

591591

592-
##### Object Example
592+
##### Parameter Object Examples
593593

594594
###### Body Parameters
595595

@@ -762,7 +762,7 @@ Field Name | Type | Description
762762
<a name="itemsEnum"></a>enum | [*] | See http://json-schema.org/latest/json-schema-validation.html#anchor76.
763763
<a name="itemsMultipleOf"></a>multipleOf | `number` | See http://json-schema.org/latest/json-schema-validation.html#anchor14.
764764

765-
##### Object Example
765+
##### Items Object Examples
766766

767767
Items must be of type string and have the minimum length of 2 characters:
768768

@@ -819,7 +819,7 @@ Field Pattern | Type | Description
819819
<a name="parameterExtensions"></a>^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#vendorExtensions) for further details.
820820

821821

822-
##### Object Example
822+
##### Responses Object Example
823823

824824
A 200 response for successful operation and a default response for others (implying an error):
825825

@@ -862,7 +862,7 @@ Field Name | Type | Description
862862
<a name="responseHeaders"></a>headers | [Headers Object](#headersObject) | A list of headers that are sent with the response.
863863
<a name="responseExamples"></a>examples | [Example Object](#exampleObject) | An example of the response message.
864864

865-
##### Object Example
865+
##### Response Object Examples
866866

867867
Response of an array of a complex type:
868868

@@ -964,7 +964,7 @@ Field Pattern | Type | Description
964964
---|:---:|---
965965
<a name="headersName"></a>{name} | [Header Object](#headerObject) | The name of the property corresponds to the name of the header. The value describes the type of the header.
966966

967-
##### Object Example
967+
##### Headers Object Example
968968

969969
Rate-limit headers:
970970

@@ -1006,7 +1006,7 @@ Field Pattern | Type | Description
10061006
---|:---:|---
10071007
<a name="exampleMimeType"></a>{[mime type](#mimeTypes)} | Any | The name of the property MUST be one of the Operation `produces` values (either implicit or inherited). The value SHOULD be an example of what such a response would look like.
10081008

1009-
##### Object Example
1009+
##### Example Object Example
10101010

10111011
Example response for application/json mimetype of a Pet data type:
10121012

@@ -1054,7 +1054,7 @@ Field Name | Type | Description
10541054
<a name="headerEnum"></a>enum | [*] | See http://json-schema.org/latest/json-schema-validation.html#anchor76.
10551055
<a name="headerMultipleOf"></a>multipleOf | `number` | See http://json-schema.org/latest/json-schema-validation.html#anchor14.
10561056

1057-
##### Object Example
1057+
##### Header Object Example
10581058

10591059
A simple header with of an integer type:
10601060

@@ -1086,7 +1086,7 @@ Field Pattern | Type | Description
10861086
---|:---:|---
10871087
<a name="tagExtensions"></a>^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#vendorExtensions) for further details.
10881088

1089-
##### Object Example
1089+
##### Tag Object Example
10901090

10911091
```js
10921092
{
@@ -1109,7 +1109,7 @@ Field Name | Type | Description
11091109
---|:---:|---
11101110
<a name="referenceRef"></a>$ref | `string` | **Required.** The reference string.
11111111

1112-
##### Object Example
1112+
##### Reference Object Example
11131113

11141114
```js
11151115
{
@@ -1174,7 +1174,7 @@ While composition offers model extensibility, it does not imply a hierarchy betw
11741174

11751175
The [xml](#schemaXml) property allows extra definitions when translating the JSON definition to XML. The [XML Object](#xmlObject) contains additional information about the available options.
11761176

1177-
##### Object Example
1177+
##### Schema Object Examples
11781178

11791179
###### Primitive Sample
11801180

@@ -1503,7 +1503,7 @@ Field Name | Type | Description
15031503
<a name="xmlAttribute"></a>attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`.
15041504
<a name="xmlWrapped"></a>wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, `<books><book/><book/></books>`) or unwrapped (`<book/><book/>`). Default value is `false`. The definition takes effect only when defined alongside `type` being `array` (outside the `items`).
15051505

1506-
##### Object Example
1506+
##### XML Object Examples
15071507

15081508
The examples of the XML object definitions are included inside a property definition of a [Schema Object](#schemaObject) with a sample of the XML representation of it.
15091509

@@ -1848,7 +1848,7 @@ Field Pattern | Type | Description
18481848
---|:---:|---
18491849
<a name="definitionsName"></a>{name} | [Schema Object](#schemaObject) | A single definition, mapping a "name" to the schema it defines.
18501850

1851-
##### Object Example
1851+
##### Definitions Object Example
18521852

18531853
```js
18541854
{
@@ -1906,7 +1906,7 @@ Field Pattern | Type | Description
19061906
---|:---:|---
19071907
<a name="pdName"></a>{name} | [Parameter Object](#parameterObject) | A single parameter definition, mapping a "name" to the parameter it defines.
19081908

1909-
##### Object Example
1909+
##### Parameters Definition Object Example
19101910

19111911
```js
19121912
{
@@ -1959,7 +1959,7 @@ Field Pattern | Type | Description
19591959
---|:---:|---
19601960
<a name="rdName"></a>{name} | [Response Object](#responseObject) | A single response definition, mapping a "name" to the response it defines.
19611961

1962-
##### Object Example
1962+
##### Responses Definitions Object Example
19631963

19641964
```js
19651965
{
@@ -1998,7 +1998,7 @@ Field Pattern | Type | Description
19981998
---|:---:|---
19991999
<a name="sdName"></a>{name} | [Security Scheme Object](#securitySchemeObject) | A single security scheme definition, mapping a "name" to the scheme it defines.
20002000

2001-
##### Object Example
2001+
##### Security Definitions Object Example
20022002

20032003
```js
20042004
{
@@ -2055,7 +2055,7 @@ Field Name | Type | Description
20552055
---|:---:|---
20562056
<a name="securitySchemeExtensions"></a>^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#vendorExtensions) for further details.
20572057

2058-
##### Object Example
2058+
##### Security Scheme Object Example
20592059

20602060
###### Basic Authentication Sample
20612061

@@ -2118,7 +2118,7 @@ Field Pattern | Type | Description
21182118
---|:---:|---
21192119
<a name="scopesName"></a>{name} | `string` | Maps between a name of a scope to a short description of it (as the value of the property).
21202120

2121-
##### Object Example
2121+
##### Scopes Object Example
21222122

21232123
```js
21242124
{
@@ -2144,7 +2144,7 @@ Field Pattern | Type | Description
21442144
---|:---:|---
21452145
<a name="securityRequirementsName"></a>{name} | [`string`] | Each name must correspond to a security scheme which is declared in the [Security Definitions](#securityDefinitions). If the security scheme is of type `"oauth2"`, then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty.
21462146

2147-
##### Object Example
2147+
##### Security Requirement Object Examples
21482148

21492149
###### Non-OAuth2 Security Requirement
21502150

0 commit comments

Comments
 (0)