Skip to content

Commit a88d108

Browse files
committed
More review feedback.
1 parent b36e61f commit a88d108

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

Diff for: versions/3.1.1.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ If the same JSON/YAML object is parsed multiple times and the respective context
196196
Several features of this specification require resolution of non-URI-based connections to some other part of the OpenAPI Description (OAD).
197197
``
198198

199-
These connections are easily resolved in single-document OADs, but the resolution process in multi-document OADs has never been spelled out, and is therefore _implementation-defined_, within the constraints described in this section.
199+
These connections are unambiguously resolved in single-document OADs, but the resolution process in multi-document OADs is _implementation-defined_, within the constraints described in this section.
200200
In some cases, an unambiguous URI-based alternative is available, and OAD authors are RECOMMENDED to always use the alternative:
201201

202202
Source | Target | Alternative
@@ -206,22 +206,23 @@ Source | Target | Alternative
206206
[Operation Object](#operationObject) `tags` | [Tag Object](#tagObject) `name` (in the Components Object) | _n/a_
207207
[Link Object](#linkObject) `operationId` | [Path Item Object](#pathItemObject) `operationId` | `operationRef`
208208

209-
A fifth implicit connection, which involves appending the templated URL paths of the [Paths Object](#pathsObject) to the appropriate [Server Object](#serverObject)'s `url` field, is unambiguous because only the entry document's Paths Object contributes URLs to the described API.
209+
A fifth implicit connection involves appending the templated URL paths of the [Paths Object](#pathsObject) to the appropriate [Server Object](#serverObject)'s `url` field.
210+
This is unambiguous because only the entry document's Paths Object contributes URLs to the described API.
210211

211212
It is RECOMMENDED to consider all Operation Objects from all parsed documents when resolving any Link Object `operationId`.
212-
This requires ensuring that all referenced documents have been parsed prior to determining an `operationId` to be unresolvable.
213+
This requires parsing all referenced documents prior to determining an `operationId` to be unresolvable.
213214

214215
The implicit connections in the Security Requirement Object and Discriminator Object rely on the _component name_, which is the property name holding the component in the appropriately typed sub-object of the Components Object.
215216
For example, the component name of the Schema Object at `#/components/schemas/Foo` is `Foo`.
216-
The implicit connection of `tags` in the Operation Object use the `name` field of Tag Objects, which (like the Components Object) are found under the root OpenAPI Object.
217+
The implicit connection of `tags` in the Operation Object uses the `name` field of Tag Objects, which (like the Components Object) are found under the root OpenAPI Object.
217218
This means resolving component names and tag names both depend on starting from the correct OpenAPI Object.
218219

219220
For resolving component and tag name connections from a referenced (non-entry) document, it is RECOMMENDED that tools resolve from the entry document, rather than the current document.
220221
This allows Security Scheme Objects and Tag Objects to be defined with the API's deployment information (the top-level Server Objects), and treated as an interface for referenced documents to access.
221222

222223
The interface approach can also work for Discriminator Objects and Schema Objects, but it is also possible to keep the Discriminator Object's behavior within a single document using the relative URI-reference syntax of `mapping`.
223224

224-
There currently are no URI-based alternatives for the Security Requirement Object or for the Operation Object's `tags` field.
225+
There are no URI-based alternatives for the Security Requirement Object or for the Operation Object's `tags` field.
225226
These limitations are expected to be addressed in a future release.
226227

227228
Note that no aspect of implicit connection resolution changes how [URIs are resolved](#relativeReferencesURI), or restricts their possible targets.

0 commit comments

Comments
 (0)