Skip to content

Commit de8ba9c

Browse files
committed
Apply naming constraint across all component definitions
1 parent 18ad65a commit de8ba9c

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

versions/3.0.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,7 @@ This object can be extended with [Specification Extensions](#specificationExtens
331331
Holds a set of reusable objects for different aspects of the OAS.
332332
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.
333333

334+
334335
##### Fixed Fields
335336

336337
Field Pattern | Type | Description
@@ -343,8 +344,9 @@ Field Pattern | Type | Description
343344
<a name="linksDefinitionObject"></a> | [Link Definitions Object](#linksDefinitionsObject) | Link definitions to reuse across the specification.
344345
<a name="callbacksDefinitionObject"></a> | [Callback Definitions Object](#callbacksDefinitionsObject) | Callback definitions to reuse across the specification.
345346

346-
TODO: All objects that are children of the componentsObject use keys where following characters are legal in the `name`: `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.
347-
347+
All the fixed fields declared above are objects that MUST contain keys that only use the following characters: `a-zA-Z0-9.-_\`.
348+
Where it is necessary to namespace definition names the `.` character SHOULD be used to separate namespace segments of the name.
349+
This namespacing mechanism is simply a naming convention and this specification defines no special behavior on namespaced identifiers.
348350

349351
#### <a name="pathsObject"></a>Paths Object
350352

@@ -2791,7 +2793,6 @@ These data types can be primitives, arrays or models.
27912793
Field Pattern | Type | Description
27922794
---|:---:|---
27932795
<a name="definitionsName"></a>{name} | [Schema Object](#schemaObject) | A single definition, mapping a "name" to the schema it defines.
2794-
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.
27952796

27962797
Examples:
27972798

0 commit comments

Comments
 (0)