You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
388
388
389
389
390
390
##### Fixed Fields
391
391
392
392
Field Pattern | Type | Description
393
393
---|:---|---
394
394
<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).
396
396
<a name="componentsParameters"></a> parameters | Map[`string`, [Parameter Object](#parameterObject)] | An object to hold reusable [Parameter Objects](#parameterObject).
397
397
<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).
399
399
<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).
401
401
<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).
403
403
404
404
All the fixed fields declared above are objects that MUST use keys that match the regular expression: `[a-zA-Z0-9.\-_]+`.
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.
1679
1685
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.
1680
1686
1681
1687
##### Patterned Fields
@@ -1694,13 +1700,13 @@ The key value used to identify the callback object is an expression, evaluated a
1694
1700
##### Patterned Fields
1695
1701
Field Pattern | Type | Description
1696
1702
---|:---:|---
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
1698
1704
1699
1705
This object can be extended with [Specification Extensions](#specificationExtensions).
1700
1706
1701
1707
##### Key Expression
1702
1708
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.
1704
1710
A simple example might be `$request.body#/url`.
1705
1711
However, using [variable substitution](#variableSubstitution) syntax the complete HTTP message can be accessed.
1706
1712
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
1865
1871
---|:---:|---
1866
1872
href | `string` | a relative or absolute URL to a linked resource. This field is mutually exclusive with the `operationId` field.
1867
1873
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`.
1869
1875
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.
1870
1876
description | `string` | a description of the link, supports [CommonMark syntax](http://spec.commonmark.org/).
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.
2246
2252
Many operations require parameters to be passed, and these MAY be dynamic depending on the response itself.
0 commit comments