From 471067a57a6cbba6538fe1029f8d4ff2b2bb1409 Mon Sep 17 00:00:00 2001 From: Darrel Miller Date: Sat, 12 Oct 2024 12:30:43 -0400 Subject: [PATCH 1/3] Updated use of URL --- versions/1.0.0.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/versions/1.0.0.md b/versions/1.0.0.md index 505cb1a..94639ca 100644 --- a/versions/1.0.0.md +++ b/versions/1.0.0.md @@ -46,10 +46,9 @@ In order to preserve the ability to round-trip between YAML and JSON formats, [[ - Tags MUST be limited to those allowed by the [JSON Schema ruleset](https://yaml.org/spec/1.2/spec.html#id2803231). - 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). -### Relative References in URLs +### Relative References in URIs -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). -Unless specified otherwise, relative references are resolved using the URL of the referring document. +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). ### Schema @@ -65,7 +64,7 @@ This is the root object of the [Overlay](#overlay). | ---- | :----: | ---- | | 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. | | info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the Overlay. The metadata MAY be used by tooling as required. | -| 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. | +| extends | `string` | URI reference that identifies the target document (such as an [[OpenAPI]] document) this overlay applies to. | | 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. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -74,7 +73,7 @@ The list of actions MUST be applied in sequential order to ensure a consistent o 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). -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. +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 reference. ```yaml overlay: 1.0.0 @@ -85,7 +84,7 @@ extends: 'https://raw.githubusercontent.com/OAI/learn.openapis.org/refs/heads/ma ... ``` -The `extends` property can also specify a relative URL. In this case, the URL is resolved relative to the location of the Overlay document. +The `extends` property can also specify a relative URI reference. ```yaml overlay: 1.0.0 From 2ec603f7cd500cbd57453b2adc17dcc09bec1836 Mon Sep 17 00:00:00 2001 From: Darrel Miller Date: Sat, 12 Oct 2024 13:10:35 -0400 Subject: [PATCH 2/3] Added comma --- versions/1.0.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versions/1.0.0.md b/versions/1.0.0.md index 94639ca..7081420 100644 --- a/versions/1.0.0.md +++ b/versions/1.0.0.md @@ -73,7 +73,7 @@ The list of actions MUST be applied in sequential order to ensure a consistent o 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). -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 reference. +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 reference. ```yaml overlay: 1.0.0 From 299b643eb9e091291bf52f228c0fdafa6c807ea3 Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Mon, 14 Oct 2024 10:42:55 +0200 Subject: [PATCH 3/3] Update versions/1.0.0.md Co-authored-by: Henry Andrews --- versions/1.0.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versions/1.0.0.md b/versions/1.0.0.md index 7081420..8d690df 100644 --- a/versions/1.0.0.md +++ b/versions/1.0.0.md @@ -73,7 +73,7 @@ The list of actions MUST be applied in sequential order to ensure a consistent o 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). -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 reference. +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. ```yaml overlay: 1.0.0