Skip to content

Commit 946df36

Browse files
authored
Misc errata
* Removed last(?) Vendor Extension references * Title casing on headings * Commas, minor grammatical fixes, and small consistency issues * Minor wordsmithing
1 parent 902ce94 commit 946df36

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

versions/3.0.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ For example, if a field has an array value, the JSON array representation will b
111111
}
112112
```
113113

114-
While the API is described using JSON it does not impose a JSON input/output to the API itself.
114+
While the API is described using JSON, it does not impose a JSON input/output to the API itself.
115115

116116
All field names in the specification are **case sensitive**.
117117

@@ -214,7 +214,7 @@ Field Name | Type | Description
214214
<a name="infoTermsOfService"></a>termsOfService | `string` | A URL to the Terms of Service for the API.
215215
<a name="infoContact"></a>contact | [Contact Object](#contactObject) | The contact information for the exposed API.
216216
<a name="infoLicense"></a>license | [License Object](#licenseObject) | The license information for the exposed API.
217-
<a name="infoVersion"></a>version | `string` | **Required** Provides the version of the application API (not to be confused with the specification version). While not required, is it suggested that the `info.version` value correspond to the version of the API definition. In practice, the version of the API _implementation_ MAY evolve at an entirely different rate.
217+
<a name="infoVersion"></a>version | `string` | **Required.** Provides the version of the application API (not to be confused with the specification version). While not required, is it suggested that the `info.version` value correspond to the version of the API definition. In practice, the version of the API _implementation_ MAY evolve at an entirely different rate.
218218

219219
This object can be extended with [Specification Extensions](#specificationExtensions).
220220

@@ -311,7 +311,7 @@ url: http://www.apache.org/licenses/LICENSE-2.0.html
311311

312312
#### <a name="serverObject"></a>Server Object
313313

314-
An object representing a Server.
314+
An object representing a list of one or more servers.
315315

316316
##### Fixed Fields
317317

@@ -579,7 +579,7 @@ Field Name | Type | Description
579579
<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.
580580
<a name="operationExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this operation.
581581
<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.
582-
<a name="operationParameters"></a>parameters | [[Parameter Object](#parameterObject) <span>&#124;</span> [Reference Object](#referenceObject)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it, but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [___location](#parameterIn). The list can use the [Reference Object](#referenceObject) to link to parameters that are defined at the [OpenAPI Object's parameters](#oasParameters).
582+
<a name="operationParameters"></a>parameters | [[Parameter Object](#parameterObject) <span>&#124;</span> [Reference Object](#referenceObject)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [___location](#parameterIn). The list can use the [Reference Object](#referenceObject) to link to parameters that are defined at the [OpenAPI Object's parameters](#oasParameters).
583583
<a name="operationRequestBody"></a>requestBody | [[Request Body Object](#requestBodyObject) <span>&#124;</span> [Reference Object](#referenceObject)] | The request body applicable for this operation. The `requestBody` is only supported in HTTP methods where the [HTTP 1.1 specification](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, `requestBody` SHALL be ignored by consumers.
584584
<a name="operationResponses"></a>responses | [Responses Object](#responsesObject) | **Required.** The list of possible responses as they are returned from executing this operation.
585585
<a name="operationCallbacks"></a>callbacks | [Callbacks Object](#callbacksObject) | The list of possible callbacks as they are returned from executing this operation.
@@ -757,7 +757,7 @@ Field Name | Type | Description
757757
<a name="parameterExplode"></a>explode | `boolean` | When this is true, parameter values of type `array` or `object` generate separate parameters for each value of the array, or key-value-pair of the map. For other types of parameters this property has no effect. When [`style`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`.
758758
<a name="parameterAllowReserved"></a>allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`.
759759
<a name="parameterSchema"></a>schema | [Schema Object](#schemaObject) | The schema defining the type used for the parameter.
760-
<a name="parameterExamples"></a>examples | [[Example Object](#exampleObject)] | Examples of the content type. Each example in the Examples array SHOULD be in the correct format as specified parameter encoding. The `examples` object is mutually exclusive to the `example` object. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema.
760+
<a name="parameterExamples"></a>examples | [[Example Object](#exampleObject)] | Examples of the content type. Each example in the Examples array SHOULD be in the correct format as specified parameter encoding. The `examples` object is mutually exclusive to the `example` object. Furthermore, if referencing a `schema` that contains an example, the `examples` value SHALL _override_ the example provided by the schema.
761761
<a name="parameterExample"></a>example | [Example Object](#exampleObject) | Example of the content type. The example object SHOULD be in the correct format as specified in the parameter encoding. The `example` object is mutually exclusive to the `examples` object. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the the schema.
762762

763763
For more complex scenarios a `content` object can be used to define the media-type
@@ -935,7 +935,7 @@ Field Name | Type | Description
935935
Field Pattern | Type | Description
936936
---|:---:|---
937937
<a name="requestBodyRepresentation"></a>`*` | [Schema Object](#schemaObject) | The schema defining the request body.
938-
<a name="parameterExtensions"></a>^x- | Any | Allows extensions to the OpenAPI 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.
938+
<a name="parameterExtensions"></a>^x- | Any | Allows extensions to the OpenAPI 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 [Specification Extensions](#specificationExtensions) for further details.
939939

940940

941941
##### Request Body Examples
@@ -1092,7 +1092,7 @@ Field Name | Type | Description
10921092
##### Patterned Fields
10931093
Field Pattern | Type | Description
10941094
---|:---:|---
1095-
<a name="parameterExtensions"></a>^x- | Any | Allows extensions to the OpenAPI 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.
1095+
<a name="parameterExtensions"></a>^x- | Any | Allows extensions to the OpenAPI 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 [Specification Extensions](#specificationExtensions) for further details.
10961096

10971097
##### Content Type Examples
10981098

@@ -1747,7 +1747,7 @@ color: ["red", "green", "blue"]
17471747
The variables generated can be used in locations prescribed by the definition.
17481748

17491749

1750-
### <a name="variableSubstitution"></a>Variable substitution
1750+
### <a name="variableSubstitution"></a>Variable Substitution
17511751
In all cases, _variables_ from request and responses may be substituted for link generation.
17521752
The table below provides examples of variable expressions and examples of their use in a value:
17531753

@@ -1783,7 +1783,7 @@ The variable expression is defined by the following [ABNF](https://tools.ietf.or
17831783
The `name` identifier is case-sensitive, whereas `token` is not.
17841784
17851785
1786-
### Request parameter example
1786+
### Request Parameter Example
17871787
Computing a link from a request operation like such:
17881788
17891789
```yaml
@@ -1823,7 +1823,7 @@ For a `id` value of `10101110`, the generated link would be:
18231823
href: '/users/10101110/department'
18241824
```
18251825

1826-
### Response payload example
1826+
### Response Payload Example
18271827

18281828
```yaml
18291829
Addresses:
@@ -3067,7 +3067,7 @@ animals:
30673067
#### <a name="definitionsObject"></a>Definitions Object
30683068

30693069
An object to hold schemas for data types that can be consumed and produced by operations.
3070-
These data types can be primitives, arrays or models.
3070+
These data types can be primitives, arrays, or models.
30713071

30723072
##### Patterned Fields
30733073

@@ -3293,7 +3293,7 @@ Field Name | Type | Validity | Description
32933293
<a name="securitySchemeType"></a>type | `string` | Any | **Required.** The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"oauth2"`, `"openIdConnect"`.
32943294
<a name="securitySchemeDescription"></a>description | `string` | Any | A short description for security scheme.
32953295
<a name="securitySchemeName"></a>name | `string` | `apiKey` | **Required.** The name of the header or query parameter to be used.
3296-
<a name="securitySchemeIn"></a>in | `string` | `apiKey` | **Required** The ___location of the API key. Valid values are `"query"` or `"header"`.
3296+
<a name="securitySchemeIn"></a>in | `string` | `apiKey` | **Required.** The ___location of the API key. Valid values are `"query"` or `"header"`.
32973297
<a name="securitySchemeScheme"></a>scheme | `string` | `http` | **Required.** The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC 7235](https://tools.ietf.org/html/rfc7235#section-4.2).
32983298
<a name="securitySchemeBearerFormat"></a>bearerFormat | `string` | `http` (`"bearer"`) | A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.
32993299
<a name="securitySchemeFlow"></a>flow | [OAuth Flows Object](#oauthFlowsObject) | `oauth2` | **Required.** An object containing configuration information for the flow types supported.
@@ -3546,7 +3546,7 @@ Two examples for this:
35463546

35473547
Version | Date | Notes
35483548
--- | --- | ---
3549-
3.0.0-rc0 | 2017-02-28 | Implementor's draft of the 3.0 specification
3549+
3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification
35503550
2.0 | 2015-12-31 | Donation of Swagger 2.0 to the Open API Initiative
35513551
2.0 | 2014-09-08 | Release of Swagger 2.0
35523552
1.2 | 2014-03-14 | Initial release of the formal document.

0 commit comments

Comments
 (0)