Skip to content

Commit 674d963

Browse files
committed
various minor corrections.
1 parent f993c41 commit 674d963

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

versions/3.0.md

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

182182
Field Name | Type | Description
183183
---|:---:|---
184-
<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.
184+
<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.
185185
<a name="oasInfo"></a>info | [Info Object](#infoObject) | **Required.** Provides metadata about the API. The metadata can be used by the clients if needed.
186186
<a name="oasServers"></a>servers | [[Server Object](#serverObject)] | An optional array of Server Objects which provide connectivity information to a target server.
187187
<a name="oasPaths"></a>paths | [Paths Object](#pathsObject) | **Required.** The available paths and operations for the API.
@@ -192,7 +192,7 @@ Field Name | Type | Description
192192

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

195-
#### <a name="oasVersion"></a>OpenAPI Version String
195+
#### <a name="oasVersionString"></a>OpenAPI Version String
196196

197197
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.
198198

@@ -384,7 +384,7 @@ An object representing a Server Variable for server URL template substituion.
384384
385385
Field Name | Type | Description
386386
---|:---:|---
387-
<a name="serverVariableEnum"></a>enum | [ `primitive` ] | An enumeration of primitive type values to be used if the substitution options are from a limited set.
387+
<a name="serverVariableEnum"></a>enum | [`primitive`] | An enumeration of primitive type values to be used if the substitution options are from a limited set.
388388
<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.
389389
<a name="serverVariableDescription"></a>description | `string` | An optional description for the server variable.
390390

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

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

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

10871091
```yaml
10881092
in: query
10891093
name: freeForm
1090-
type: object
1091-
additionalProperties:
1092-
type: integer
1094+
schema:
1095+
type: object
1096+
additionalProperties:
1097+
type: integer
10931098
style: form
10941099
```
10951100

0 commit comments

Comments
 (0)