Skip to content

Commit fef7638

Browse files
authored
Merge pull request #76 from OAI/dm/URLtoURI
2 parents 75355c8 + 299b643 commit fef7638

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

versions/1.0.0.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,9 @@ In order to preserve the ability to round-trip between YAML and JSON formats, [[
4343
- Tags MUST be limited to those allowed by the [JSON Schema ruleset](https://yaml.org/spec/1.2/spec.html#id2803231).
4444
- Keys used in YAML maps MUST be limited to a scalar string, as defined by the [YAML Failsafe schema ruleset](https://yaml.org/spec/1.2/spec.html#id2802346).
4545

46-
### Relative References in URLs
46+
### Relative References in URIs
4747

48-
Unless specified otherwise, all properties that are URLs MAY be relative references as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-4.2).
49-
Unless specified otherwise, relative references are resolved using the URL of the referring document.
48+
Unless specified otherwise, all fields that are URI references MAY be relative references as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-4.2).
5049

5150
### Schema
5251

@@ -62,7 +61,7 @@ This is the root object of the [Overlay](#overlay).
6261
| ---- | :----: | ---- |
6362
| <a name="overlay-version"></a>overlay | `string` | **REQUIRED**. This string MUST be the [version number](#versions) of the Overlay Specification that the Overlay document uses. The `overlay` field SHOULD be used by tooling to interpret the Overlay document. |
6463
| <a name="overlay-info"></a>info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the Overlay. The metadata MAY be used by tooling as required. |
65-
| <a name="overlay-extends"></a>extends | `string` | URL to the target document (such as an [[OpenAPI]] document) this overlay applies to. This MUST be in the form of a URL. |
64+
| <a name="overlay-extends"></a>extends | `string` | URI reference that identifies the target document (such as an [[OpenAPI]] document) this overlay applies to. |
6665
| <a name="overlay-actions"></a>actions | [[Action Object](#action-object)] | **REQUIRED** An ordered list of actions to be applied to the target document. The array MUST contain at least one value. |
6766

6867
This object MAY be extended with [Specification Extensions](#specification-extensions).
@@ -71,7 +70,7 @@ The list of actions MUST be applied in sequential order to ensure a consistent o
7170

7271
The `extends` property can be used to indicate that the Overlay was designed to update a specific [[OpenAPI]] document. Where no `extends` is provided it is the responsibility of tooling to apply the Overlay document to the appropriate OpenAPI document(s).
7372

74-
In the following example the `extends` property specifies that the overlay is designed to update the OpenAPI Tic Tac Toe example document using an absolute URL.
73+
In the following example the `extends` property specifies that the overlay is designed to update the OpenAPI Tic Tac Toe example document, identified by an absolute URI.
7574

7675
```yaml
7776
overlay: 1.0.0
@@ -82,7 +81,7 @@ extends: 'https://raw.githubusercontent.com/OAI/learn.openapis.org/refs/heads/ma
8281
...
8382
```
8483

85-
The `extends` property can also specify a relative URL. In this case, the URL is resolved relative to the location of the Overlay document.
84+
The `extends` property can also specify a relative URI reference.
8685

8786
```yaml
8887
overlay: 1.0.0

0 commit comments

Comments
 (0)