Skip to content

Commit 8d97168

Browse files
committed
Text cleanup
1 parent 9152df6 commit 8d97168

File tree

1 file changed

+25
-19
lines changed

1 file changed

+25
-19
lines changed

versions/3.0.md

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Additional utilities can also take advantage of the resulting files, such as tes
5050
- [Links Object](#linksObject)
5151
- [Link Object](#linkObject)
5252
- [Variable substitution](#variableSubstitution)
53-
- [Link Parameters](#linkParameters)
53+
- [Link Parameters](#linkParametersObject)
5454
- [Header Object](#headerObject)
5555
- [Tag Object](#tagObject)
5656
- [Examples Object](#examplesObject)
@@ -384,22 +384,22 @@ This object can be extended with [Specification Extensions](#specificationExtens
384384
#### <a name="componentsObject"></a>Components Object
385385

386386
Holds a set of reusable objects for different aspects of the OAS.
387-
All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.
387+
All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.
388388

389389

390390
##### Fixed Fields
391391

392392
Field Pattern | Type | Description
393393
---|:---|---
394394
<a name="componentsDefinitions"></a> definitions | Map[`string`, [Schema Object](#schemaObject)] | An object to hold reusable [Schema Objects](#schemaObject).
395-
<a name="componentsResponses"></a> responses | Map[`string`, [Response Object](#responseObject)] | An object to hold reusable [Responses Objects](#responseObject).
395+
<a name="componentsResponses"></a> responses | Map[`string`, [Response Object](#responseObject)] | An object to hold reusable [Response Objects](#responseObject).
396396
<a name="componentsParameters"></a> parameters | Map[`string`, [Parameter Object](#parameterObject)] | An object to hold reusable [Parameter Objects](#parameterObject).
397397
<a name="componentsExamples"></a> examples | Map[`string`, [Example Object](#exampleObject)] | An object to hold reusable [Example Objects](#exampleObject).
398-
<a name="componentsRequestBodies"></a> requestBodies | Map[`string`, [RequestBody Object](#requestBodyObject)] | An object to hold reusable [RequestBody objects](#requestBodyObject).
398+
<a name="componentsRequestBodies"></a> requestBodies | Map[`string`, [Request Body Object](#requestBodyObject)] | An object to hold reusable [Request Body Objects](#requestBodyObject).
399399
<a name="componentsHeaders"></a> headers | Map[`string`, [Header object](#headerObject)] | An object to hold reusable [Header objects](#headerObject).
400-
<a name="componentsSecurityDefinitions"></a> securityDefinitions| Map[`string`, [Security Scheme object](#securitySchemeObject)] | An object to hold reusable [Security Scheme objects](#securitySchemeObject).
400+
<a name="componentsSecurityDefinitions"></a> securityDefinitions| Map[`string`, [Security Scheme Object](#securitySchemeObject)] | An object to hold reusable [Security Scheme Objects](#securitySchemeObject).
401401
<a name="componentsLinks"></a> links | Map[`string`, [Link Object](#linkObject)] | An object to hold reusable [Link Objects](#linkObject).
402-
<a name="componentsCallbacks"></a> callbacks | Map[`string`, [Callback Object](#callbackObject)] | An object to hold reusable [Callback Object](#callbackObject).
402+
<a name="componentsCallbacks"></a> callbacks | Map[`string`, [Callback Object](#callbackObject)] | An object to hold reusable [Callback Objects](#callbackObject).
403403

404404
All the fixed fields declared above are objects that MUST use keys that match the regular expression: `[a-zA-Z0-9.\-_]+`.
405405

@@ -451,16 +451,20 @@ my\org\User
451451
"in": "query",
452452
"description": "number of items to skip",
453453
"required": true,
454-
"type": "integer",
455-
"format": "int32"
454+
"schema": {
455+
"type": "integer",
456+
"format": "int32"
457+
}
456458
},
457459
"limitParam": {
458460
"name": "limit",
459461
"in": "query",
460462
"description": "max records to return",
461463
"required": true,
462-
"type": "integer",
463-
"format": "int32"
464+
"schema" : {
465+
"type": "integer",
466+
"format": "int32"
467+
}
464468
}
465469
},
466470
"responses": {
@@ -528,15 +532,17 @@ components:
528532
in: query
529533
description: number of items to skip
530534
required: true
531-
type: integer
532-
format: int32
535+
schema:
536+
type: integer
537+
format: int32
533538
limitParam:
534539
name: limit
535540
in: query
536541
description: max records to return
537542
required: true
538-
type: integer
539-
format: int32
543+
schema:
544+
type: integer
545+
format: int32
540546
responses:
541547
NotFound:
542548
description: Entity not found.
@@ -1675,7 +1681,7 @@ description: object created
16751681
#### <a name="callbacksObject"></a>Callbacks Object
16761682

16771683
A map of possible out-of band callbacks related to the parent operation.
1678-
Each value in the map is an [Callback Object](#callbackObject) that describes a request that may be initiated by the API provider and the expected responses.
1684+
Each value in the map is a [Callback Object](#callbackObject) that describes a request that may be initiated by the API provider and the expected responses.
16791685
The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.
16801686

16811687
##### Patterned Fields
@@ -1694,13 +1700,13 @@ The key value used to identify the callback object is an expression, evaluated a
16941700
##### Patterned Fields
16951701
Field Pattern | Type | Description
16961702
---|:---:|---
1697-
<a name="callbackExpression"></a>{expression} | [Path Item Object](#pathItemObject) | An Path Item Object used to define a callback request and expected responses
1703+
<a name="callbackExpression"></a>{expression} | [Path Item Object](#pathItemObject) | A Path Item Object used to define a callback request and expected responses
16981704

16991705
This object can be extended with [Specification Extensions](#specificationExtensions).
17001706

17011707
##### Key Expression
17021708

1703-
The key used to identify the Path Item Object is a variable expression that can be evaluated in the context of a runtime HTTP request/response to identify the URL to be used for the callback request.
1709+
The key used to identify the [Path Item Object](#pathItemObject) is a variable expression that can be evaluated in the context of a runtime HTTP request/response to identify the URL to be used for the callback request.
17041710
A simple example might be `$request.body#/url`.
17051711
However, using [variable substitution](#variableSubstitution) syntax the complete HTTP message can be accessed.
17061712
This includes accessing any part of a body that can be accessed using a JSON Pointer [RFC6901](https://tools.ietf.org/html/rfc6901).
@@ -1865,7 +1871,7 @@ Field Name | Type | Description
18651871
---|:---:|---
18661872
href | `string` | a relative or absolute URL to a linked resource. This field is mutually exclusive with the `operationId` field.
18671873
operationId | `string` | the name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive with the `href` field. Relative `href` values MAY be used to locate an existing Operation Object in the OAS.
1868-
parameters | [Link Parameters Object](#linkParameters) | an object representing parameters to pass to an operation as specified with `operationId` or identified via `href`.
1874+
parameters | [Link Parameters Object](#linkParametersObject) | an object representing parameters to pass to an operation as specified with `operationId` or identified via `href`.
18691875
headers | [Headers Object](#headersObject) | an object representing headers to pass to the linked resource. Where conflicts occur between these headers, and those defined in the related operation, these headers override.
18701876
description | `string` | a description of the link, supports [CommonMark syntax](http://spec.commonmark.org/).
18711877

@@ -2241,7 +2247,7 @@ components:
22412247
```
22422248

22432249

2244-
### <a name="linkParameters"></a>Link Parameters
2250+
### <a name="linkParametersObject"></a>Link Parameters Object
22452251
Using the `operationId` to reference an operation in the definition has many benefits, including the ability to define media-type options, security requirements, response and error payloads.
22462252
Many operations require parameters to be passed, and these MAY be dynamic depending on the response itself.
22472253

0 commit comments

Comments
 (0)