Skip to content

Commit b8b3cfe

Browse files
authored
Merge pull request OAI#828 from OAI/dm/componentsreview
Components Review
2 parents 8712108 + 00073ec commit b8b3cfe

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

versions/3.0.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -383,8 +383,9 @@ This object can be extended with [Specification Extensions](#specificationExtens
383383

384384
#### <a name="componentsObject"></a>Components Object
385385

386-
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+
388389

389390
##### Fixed Fields
390391

@@ -393,9 +394,13 @@ Field Pattern | Type | Description
393394
<a name="definitionsObject"></a> | [Definitions Object](#definitionsObject) | A hash containing payload definitions for the specification.
394395
<a name="responsesDefinitionsObject"></a> | [Responses Definitions Object](#responsesDefinitionsObject) | Reusable responses objects.
395396
<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.
396398
<a name="responseHeadersDefinitionsObject"></a> | [Response Headers Definitions Object](#responseHeadersDefinitionsObject) | Response headers to reuse across the specification.
397399
<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.
398402

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

400405
#### <a name="pathsObject"></a>Paths Object
401406

@@ -662,7 +667,7 @@ parameters:
662667
description: ID of pet that needs to be updated
663668
required: true
664669
type: string
665-
responseBody:
670+
requestBody:
666671
content:
667672
'application/x-www-form-urlencoded':
668673
schema:
@@ -2832,15 +2837,14 @@ animals:
28322837

28332838
#### <a name="definitionsObject"></a>Definitions Object
28342839

2835-
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.
28362841
These data types can be primitives, arrays or models.
28372842

28382843
##### Patterned Fields
28392844

28402845
Field Pattern | Type | Description
28412846
---|:---:|---
28422847
<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.
28442848

28452849
Examples:
28462850

0 commit comments

Comments
 (0)