Skip to content

Commit fa603c0

Browse files
authored
Merge pull request OAI#948 from OAI/dm/final-review
Various minor corrections
2 parents 3c6071b + d1dd1d9 commit fa603c0

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

versions/3.0.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ It combines what previously was the Resource Listing and API Declaration (versio
180180

181181
Field Name | Type | Description
182182
---|:---:|---
183-
<a name="oasVersion"></a>openapi | [OpenAPI Version String](#oasVersion) | **Required.** Specifies the OpenAPI Specification version being used. It can be used by tooling Specifications and clients to interpret the version. The structure SHALL be `major`.`minor`.`patch`, where `patch` versions MUST be compatible with the existing `major`.`minor` tooling. Typically patch versions will be introduced to address errors in the documentation, and tooling SHOULD typically be compatible with the corresponding `major`.`minor` (3.0.*). Patch versions will correspond to patches of this document.
183+
<a name="oasVersion"></a>openapi | `string` | **Required.** Specifies the OpenAPI Specification version being used. It can be used by tooling Specifications and clients to interpret the version. The structure SHALL be `major`.`minor`.`patch`, where `patch` versions MUST be compatible with the existing `major`.`minor` tooling. Typically patch versions will be introduced to address errors in the documentation, and tooling SHOULD typically be compatible with the corresponding `major`.`minor` (3.0.*). Patch versions will correspond to patches of this document.
184184
<a name="oasInfo"></a>info | [Info Object](#infoObject) | **Required.** Provides metadata about the API. The metadata can be used by the clients if needed.
185185
<a name="oasServers"></a>servers | [[Server Object](#serverObject)] | An optional array of Server Objects which provide connectivity information to a target server.
186186
<a name="oasPaths"></a>paths | [Paths Object](#pathsObject) | **Required.** The available paths and operations for the API.
@@ -191,7 +191,7 @@ Field Name | Type | Description
191191

192192
This object can be extended with [Specification Extensions](#specificationExtensions).
193193

194-
#### <a name="oasVersion"></a>OpenAPI Version String
194+
#### <a name="oasVersionString"></a>OpenAPI Version String
195195

196196
The version string signifies the version of the OpenAPI Specification that the document complies to. The format for this string MUST be `major`.`minor`.`patch`. The `patch` MAY be suffixed by a hyphen and extra alphanumeric characters.
197197

@@ -383,7 +383,7 @@ An object representing a Server Variable for server URL template substituion.
383383
384384
Field Name | Type | Description
385385
---|:---:|---
386-
<a name="serverVariableEnum"></a>enum | [ `primitive` ] | An enumeration of primitive type values to be used if the substitution options are from a limited set.
386+
<a name="serverVariableEnum"></a>enum | [`primitive`] | An enumeration of primitive type values to be used if the substitution options are from a limited set.
387387
<a name="serverVariableDefault"></a>default | `primitive` | **Required.** The default value to use for substitution if an alternate value is not specified, and will be sent if an alternative value is _not_ supplied. Unlike the [Schema Object's](#schemaObject) `default`, this value MUST be provided by the consumer.
388388
<a name="serverVariableDescription"></a>description | `string` | An optional description for the server variable.
389389

@@ -409,6 +409,8 @@ Field Pattern | Type | Description
409409
<a name="componentsLinks"></a> links | Map[`string`, [Link Object](#linkObject)] | An object to hold reusable [Link Objects](#linkObject).
410410
<a name="componentsCallbacks"></a> callbacks | Map[`string`, [Callback Object](#callbackObject)] | An object to hold reusable [Callback Objects](#callbackObject).
411411

412+
This object can be extended with [Specification Extensions](#specificationExtensions).
413+
412414
All the fixed fields declared above are objects that MUST use keys that match the regular expression: `[a-zA-Z0-9.\-_]+`.
413415

414416
Field Name Examples:
@@ -1075,20 +1077,23 @@ A free-form query parameter, allowing undefined parameters of a specific type:
10751077
{
10761078
"in": "query",
10771079
"name": "freeForm",
1078-
"type": "object",
1079-
"additionalProperties": {
1080-
"type": "integer"
1081-
},
1080+
"schema": {
1081+
"type": "object",
1082+
"additionalProperties": {
1083+
"type": "integer"
1084+
},
1085+
}
10821086
"style": "form"
10831087
}
10841088
```
10851089

10861090
```yaml
10871091
in: query
10881092
name: freeForm
1089-
type: object
1090-
additionalProperties:
1091-
type: integer
1093+
schema:
1094+
type: object
1095+
additionalProperties:
1096+
type: integer
10921097
style: form
10931098
```
10941099

@@ -1258,16 +1263,12 @@ Each Media Type Object provides schema and examples for a the media type identif
12581263
##### Fixed Fields
12591264
Field Name | Type | Description
12601265
---|:---:|---
1261-
12621266
<a name="mediaTypeSchema"></a>schema | [Schema Object](#schemaObject) <span>&#124;</span> [Reference Object](#referenceObject)] | The schema defining the type used for the request body.
12631267
<a name="mediaTypeExamples"></a>examples | [[Example Object](#exampleObject) <span>&#124;</span> [Reference Object](#referenceObject)] | Examples of the media type. Each example in the Examples array SHOULD be in the correct format as specified in the media type. 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.
12641268
<a name="mediaTypeExample"></a>example | [Example Object](#exampleObject) <span>&#124;</span> [Reference Object](#referenceObject) | Example of the media type. The example object SHOULD be in the correct format as specified in the media type. 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 the example provided by the schema.
12651269
<a name="mediaTypeEncoding"></a>encoding | [Encoding Object](#encodingObject) | Encoding of the media type. The encoding object SHOULD only apply to `requestBody` objects when the content type is `multipart`.
12661270

1267-
##### Patterned Fields
1268-
Field Pattern | Type | Description
1269-
---|:---:|---
1270-
<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.
1271+
This object can be extended with [Specification Extensions](#specificationExtensions).
12711272

12721273
##### Media Type Examples
12731274

0 commit comments

Comments
 (0)