Skip to content

Commit b36e61f

Browse files
handrewsjeremyfiel
andauthored
Apply suggestions from code review
Co-authored-by: Jeremy Fiel <[email protected]>
1 parent 367c599 commit b36e61f

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

Diff for: versions/3.1.1.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,8 @@ If the same JSON/YAML object is parsed multiple times and the respective context
193193

194194
#### <a name="resolvingImplicitConnections"></a>Resolving Implicit Connections
195195

196-
Several features of this specification require resolving a non-URI-based connection to some other part of the OpenAPI Description (OAD).
196+
Several features of this specification require resolution of non-URI-based connections to some other part of the OpenAPI Description (OAD).
197+
``
197198

198199
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.
199200
In some cases, an unambiguous URI-based alternative is available, and OAD authors are RECOMMENDED to always use the alternative:
@@ -210,10 +211,10 @@ A fifth implicit connection, which involves appending the templated URL paths of
210211
It is RECOMMENDED to consider all Operation Objects from all parsed documents when resolving any Link Object `operationId`.
211212
This requires ensuring that all referenced documents have been parsed prior to determining an `operationId` to be unresolvable.
212213

213-
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 appropriate typed sub-object of the Components Object.
214+
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.
214215
For example, the component name of the Schema Object at `#/components/schemas/Foo` is `Foo`.
215-
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.
216-
This means that resolving component names and tag names both depend on starting from the correct OpenAPI Object.
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+
This means resolving component names and tag names both depend on starting from the correct OpenAPI Object.
217218

218219
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.
219220
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.

0 commit comments

Comments
 (0)