Skip to content

Commit 5be9dfc

Browse files
handrewsjeremyfiel
andcommitted
Apply suggestions from code review (3.2.0 port of 3856 4/4)
Co-authored-by: Jeremy Fiel <[email protected]>
1 parent 21b9ec5 commit 5be9dfc

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

versions/3.2.0.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4042,7 +4042,7 @@ security:
40424042

40434043
See [Resolving Implicit Connections](#resolvingImplicitConnections) for more information.
40444044

4045-
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:
4045+
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:
40464046

40474047
```HTTP
40484048
GET /api/description/openapi HTTP/1.1
@@ -4085,7 +4085,7 @@ paths:
40854085
$ref: "other#/components/pathItems/Foo"
40864086
```
40874087

4088-
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:
4088+
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:
40894089

40904090
```HTTP
40914091
GET /api/description/other HTTP/1.1
@@ -4132,7 +4132,7 @@ components:
41324132
- MySecurity: []
41334133
```
41344134

4135-
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.
4135+
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.
41364136

41374137
### <a name="specificationExtensions"></a>Specification Extensions
41384138

0 commit comments

Comments
 (0)