Skip to content

Commit d2b0fe9

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

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

Diff for: versions/3.1.1.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3832,7 +3832,7 @@ security:
38323832

38333833
See [Resolving Implicit Connections](#resolvingImplicitConnections) for more information.
38343834

3835-
First, our entry document is where parsing begins. It defines the `MySecurity` security scheme to be JWT-based, and it defines on Path Item as a reference to a component in another document:
3835+
First, our entry document is where parsing begins. It defines the `MySecurity` security scheme to be JWT-based, and it defines a Path Item as a reference to a component in another document:
38363836

38373837
```HTTP
38383838
GET /api/description/openapi HTTP/1.1
@@ -3875,7 +3875,7 @@ paths:
38753875
$ref: "other#/components/pathItems/Foo"
38763876
```
38773877

3878-
Next, we have our referenced document, `other`, that we presumably request in the same format we requested for the entry document. But the fact that we don't use file extensions gives the client the flexibilty to choose on a resource-by-resource basis, assuming both representations are available:
3878+
Next, we have our referenced document, `other`. The fact that we don't use file extensions gives the client the flexibility to choose an acceptable format on a resource-by-resource basis, assuming both representations are available:
38793879

38803880
```HTTP
38813881
GET /api/description/other HTTP/1.1
@@ -3922,7 +3922,7 @@ components:
39223922
- MySecurity: []
39233923
```
39243924

3925-
In this `other` document, the reference path item has a Security Requirement for the Security Scheme "MySecurity". But there is a Security Scheme by that name in the `other` document as well. As discussed in [Resolving Implicit Connections](#resolvingImplicitConnections), which "MySecurity" gets used is [implementation-defined](#undefinedAndImplementationDefinedBehavior). However, as also documented in that section, it is RECOMMENDED that tools resolve component names from the [entry document](#documentStructure). As with all implementation-defined behavior, it is important to check tool documentation to determine which behavior is supported.
3925+
In the `other` document, the referenced path item has a Security Requirement for a Security Scheme, `MySecurity`. The same Security Scheme exists in the original entry document. As outlined in [Resolving Implicit Connections](#resolvingImplicitConnections), `MySecurity` is resolved with an [implementation-defined behavior](#undefinedAndImplementationDefinedBehavior). However, documented in that section, it is RECOMMENDED that tools resolve component names from the [entry document](#documentStructure). As with all implementation-defined behavior, it is important to check tool documentation to determine which behavior is supported.
39263926

39273927
### <a name="specificationExtensions"></a>Specification Extensions
39283928

0 commit comments

Comments
 (0)