From ec68f4200aafd564d2015ce2526171c08dbe6958 Mon Sep 17 00:00:00 2001 From: ndenny Date: Tue, 6 Feb 2024 18:21:56 -0800 Subject: [PATCH 1/4] Remove references to WHATWG to avoid confusion --- versions/1.0.0.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/versions/1.0.0.md b/versions/1.0.0.md index 1b04022..ba0a25b 100644 --- a/versions/1.0.0.md +++ b/versions/1.0.0.md @@ -237,14 +237,14 @@ version: 1.0.1 Describes a source description (such as an OpenAPI description) that will be referenced by one or more workflows described within a Workflows Description. -An object storing a map between named description keys and location URLs to the source descriptions (such as an OpenAPI description) this workflow SHALL apply to. Each source location `string` MUST be in the form of a [URL](https://url.spec.whatwg.org/). MAY be defined using relative references as defined by [RFC3986](https://spec.openapis.org/oas/latest.html#bib-RFC3986). +An object storing a map between named description keys and location URLs to the source descriptions (such as an OpenAPI description) this workflow SHALL apply to. Each source location `string` MUST be in the form of a URL and MAY be defined using relative references as defined by [RFC3986](https://spec.openapis.org/oas/latest.html#bib-RFC3986). ##### Fixed Fields Field Name | Type | Description ---|:---:|--- name | `string` | **REQUIRED**. A unique name for the source description. Tools and libraries MAY use the `name` to uniquely identify a source description, therefore, it is RECOMMENDED to follow common programming naming conventions. SHOULD conform to the regular expression `[A-Za-z0-9_\-]+`. -url | `string` | **REQUIRED**. A URL to a source description to be used by a Workflow. MUST be in the form of a [URL](https://url.spec.whatwg.org/). MAY be defined using relative references as defined by [RFC3986](https://spec.openapis.org/oas/latest.html#bib-RFC3986). +url | `string` | **REQUIRED**. A URL to a source description to be used by a Workflow. The URL MAY be defined using relative references as defined by [RFC3986](https://spec.openapis.org/oas/latest.html#bib-RFC3986). type | `string` | The type of source description. Possible values are `"openapi"` or `"workflowsSpec"`. From 8fb365cfe9fbba6c4ebd41b34fd4bedee4eb1128 Mon Sep 17 00:00:00 2001 From: ndenny Date: Wed, 14 Feb 2024 14:50:15 -0800 Subject: [PATCH 2/4] Correct relative reference wording --- versions/1.0.0.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/versions/1.0.0.md b/versions/1.0.0.md index ba0a25b..3f7025f 100644 --- a/versions/1.0.0.md +++ b/versions/1.0.0.md @@ -237,14 +237,15 @@ version: 1.0.1 Describes a source description (such as an OpenAPI description) that will be referenced by one or more workflows described within a Workflows Description. -An object storing a map between named description keys and location URLs to the source descriptions (such as an OpenAPI description) this workflow SHALL apply to. Each source location `string` MUST be in the form of a URL and MAY be defined using relative references as defined by [RFC3986](https://spec.openapis.org/oas/latest.html#bib-RFC3986). +An object storing a map between named description keys and location URLs to the source descriptions (such as an OpenAPI description) this workflow SHALL apply to. Each source location `string` MUST be in the form of a URL. +If a relative reference is used it MUST be in the form of a URI-reference as defined by [RFC3986 section 4.1](https://datatracker.ietf.org/doc/html/rfc3986#section-4.2). ##### Fixed Fields Field Name | Type | Description ---|:---:|--- name | `string` | **REQUIRED**. A unique name for the source description. Tools and libraries MAY use the `name` to uniquely identify a source description, therefore, it is RECOMMENDED to follow common programming naming conventions. SHOULD conform to the regular expression `[A-Za-z0-9_\-]+`. -url | `string` | **REQUIRED**. A URL to a source description to be used by a Workflow. The URL MAY be defined using relative references as defined by [RFC3986](https://spec.openapis.org/oas/latest.html#bib-RFC3986). +url | `string` | **REQUIRED**. A URL to a source description to be used by a Workflow. If a relative reference is used, it MUST be in the form of a URI-reference as defined by [RFC3986 section 4.1](https://datatracker.ietf.org/doc/html/rfc3986#section-4.2). type | `string` | The type of source description. Possible values are `"openapi"` or `"workflowsSpec"`. From 6d3342ad6ddb3113203e6949ee8a8bc492075919 Mon Sep 17 00:00:00 2001 From: ndenny Date: Wed, 14 Feb 2024 14:52:15 -0800 Subject: [PATCH 3/4] Section 4.2 not 4.1! --- versions/1.0.0.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/versions/1.0.0.md b/versions/1.0.0.md index 3f7025f..580aeaf 100644 --- a/versions/1.0.0.md +++ b/versions/1.0.0.md @@ -238,14 +238,14 @@ version: 1.0.1 Describes a source description (such as an OpenAPI description) that will be referenced by one or more workflows described within a Workflows Description. An object storing a map between named description keys and location URLs to the source descriptions (such as an OpenAPI description) this workflow SHALL apply to. Each source location `string` MUST be in the form of a URL. -If a relative reference is used it MUST be in the form of a URI-reference as defined by [RFC3986 section 4.1](https://datatracker.ietf.org/doc/html/rfc3986#section-4.2). +If a relative reference is used it MUST be in the form of a URI-reference as defined by [RFC3986 section 4.2](https://datatracker.ietf.org/doc/html/rfc3986#section-4.2). ##### Fixed Fields Field Name | Type | Description ---|:---:|--- name | `string` | **REQUIRED**. A unique name for the source description. Tools and libraries MAY use the `name` to uniquely identify a source description, therefore, it is RECOMMENDED to follow common programming naming conventions. SHOULD conform to the regular expression `[A-Za-z0-9_\-]+`. -url | `string` | **REQUIRED**. A URL to a source description to be used by a Workflow. If a relative reference is used, it MUST be in the form of a URI-reference as defined by [RFC3986 section 4.1](https://datatracker.ietf.org/doc/html/rfc3986#section-4.2). +url | `string` | **REQUIRED**. A URL to a source description to be used by a Workflow. If a relative reference is used, it MUST be in the form of a URI-reference as defined by [RFC3986 section 4.2](https://datatracker.ietf.org/doc/html/rfc3986#section-4.2). type | `string` | The type of source description. Possible values are `"openapi"` or `"workflowsSpec"`. From 4db0981258801bf7029c401575ed551f8d89f0aa Mon Sep 17 00:00:00 2001 From: ndenny Date: Thu, 28 Mar 2024 08:11:21 -0700 Subject: [PATCH 4/4] Simplify URI wording --- versions/1.0.0.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/versions/1.0.0.md b/versions/1.0.0.md index 580aeaf..0f71c44 100644 --- a/versions/1.0.0.md +++ b/versions/1.0.0.md @@ -237,8 +237,7 @@ version: 1.0.1 Describes a source description (such as an OpenAPI description) that will be referenced by one or more workflows described within a Workflows Description. -An object storing a map between named description keys and location URLs to the source descriptions (such as an OpenAPI description) this workflow SHALL apply to. Each source location `string` MUST be in the form of a URL. -If a relative reference is used it MUST be in the form of a URI-reference as defined by [RFC3986 section 4.2](https://datatracker.ietf.org/doc/html/rfc3986#section-4.2). +An object storing a map between named description keys and location URLs to the source descriptions (such as an OpenAPI description) this workflow SHALL apply to. Each source location `string` MUST be in the form of a URI-reference as defined by [RFC3986 section 4.1](https://datatracker.ietf.org/doc/html/rfc3986#section-4.1). ##### Fixed Fields