Skip to content

Commit 1639c5d

Browse files
handrewsjeremyfiel
andcommitted
Apply suggestions from code review
Co-authored-by: Jeremy Fiel <[email protected]>
1 parent 80ec461 commit 1639c5d

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

versions/3.0.4.md

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

38033803
See [Resolving Implicit Connections](#resolvingImplicitConnections) for more information.
38043804

3805-
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:
3805+
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:
38063806

38073807
```HTTP
38083808
GET /api/description/openapi HTTP/1.1
@@ -3845,7 +3845,7 @@ paths:
38453845
$ref: "other#/components/pathItems/Foo"
38463846
```
38473847

3848-
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:
3848+
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:
38493849

38503850
```HTTP
38513851
GET /api/description/other HTTP/1.1
@@ -3892,7 +3892,7 @@ components:
38923892
- MySecurity: []
38933893
```
38943894

3895-
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.
3895+
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.
38963896

38973897
### <a name="specificationExtensions"></a>Specification Extensions
38983898

0 commit comments

Comments
 (0)