Skip to content

Commit 41c7dd1

Browse files
committed
fix OAS.md Appedix F URI inconsistencies
1 parent a04789f commit 41c7dd1

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

src/oas.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5335,7 +5335,7 @@ components:
53355335
content:
53365336
application/json:
53375337
schema:
5338-
$ref: "#/components/api/schemas/Foo"
5338+
$ref: "#/components/schemas/Foo"
53395339
schemas:
53405340
Foo:
53415341
properties:
@@ -5456,7 +5456,7 @@ components:
54565456
```
54575457

54585458
In this example, all of the `$self` and `$id` values are relative URI references consisting of an absolute path.
5459-
This allows the retrieval URI to set the host (and scheme), in this case `https://staging.example.com`, resulting in the first document's `$self` being `https://staging.example.com/openapi`, and the second document's `$self` being `https://staging.example.com/api/shared/foo`, with `$id` values of `https://staging.example.com/api/schemas/foo` and `https://staging.example.com/api/schemas/bar`.
5459+
This allows the retrieval URI to set the host (and scheme), in this case `https://staging.example.com`, resulting in the first document's `$self` being `https://staging.example.com/api/openapi`, and the second document's `$self` being `https://staging.example.com/api/shared/foo`, with `$id` values of `https://staging.example.com/api/schemas/foo` and `https://staging.example.com/api/schemas/bar`.
54605460
Relative `$self` and `$id` values of this sort allow the same set of documents to work when deployed to other hosts, e.g. `https://example.com` (production) or `https://localhost:8080` (local development).
54615461

54625462
## Appendix G: Parsing and Resolution Guidance

0 commit comments

Comments
 (0)