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 schemas for different aspects of the OAS.
387
-
The intention is to put reusable components into a single ___location, allowing reuse from this and other OAS documents.
386
+
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.
388
+
388
389
389
390
##### Fixed Fields
390
391
@@ -393,9 +394,13 @@ Field Pattern | Type | Description
393
394
<a name="definitionsObject"></a> | [Definitions Object](#definitionsObject) | A hash containing payload definitions for the specification.
<a name="parametersDefinitionsObject"></a> | [Parameters Definitions Object](#parametersDefinitionsObject) | An object to hold parameters to be reused across operations. Parameter definitions can be referenced to the ones defined here.
397
+
<a name="requestBodyDefinitionsObject"></a> | [Request Body Definitions Object](#requestBodyDefinitionsObject) | An object to hold request body definitions to be reused across operations. Request Body definitions can be referenced to the ones defined here.
396
398
<a name="responseHeadersDefinitionsObject"></a> | [Response Headers Definitions Object](#responseHeadersDefinitionsObject) | Response headers to reuse across the specification.
397
399
<a name="securityDefinitionsObject"></a> | [Security Definitions Object](#securityDefinitionsObject) | Security definitions to reuse across the specification.
400
+
<a name="linksDefinitionObject"></a> | [Link Definitions Object](#linksDefinitionsObject) | Link definitions to reuse across the specification.
401
+
<a name="callbacksDefinitionObject"></a> | [Callback Definitions Object](#callbacksDefinitionsObject) | Callback definitions to reuse across the specification.
398
402
403
+
All the fixed fields declared above are objects that MUST use keys that match the regular expression: `[a-zA-Z0-9.\-_]+`.
An object to hold data types that can be consumed and produced by operations.
2840
+
An object to hold schemas for data types that can be consumed and produced by operations.
2836
2841
These data types can be primitives, arrays or models.
2837
2842
2838
2843
##### Patterned Fields
2839
2844
2840
2845
Field Pattern | Type | Description
2841
2846
---|:---:|---
2842
2847
<a name="definitionsName"></a>{name} | [Schema Object](#schemaObject) | A single definition, mapping a "name" to the schema it defines.
2843
-
The following characters are legal in the `definitionsName`: `a-zA-Z0-9.-_\`. All other characters, including extended ASCII characters, are not legal in the `definitionsName`. The name may be used to namespace the definitions--it is the tooling Specification's job to ensure that the namespace is honored.
0 commit comments