From 396dd29ab2c3e721b780f58c3dcaab1e1edbf6ef Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 20 Feb 2023 10:28:11 -0500 Subject: [PATCH 01/53] - typo fix --- registries/_format/binary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/registries/_format/binary.md b/registries/_format/binary.md index 85508c2c0f..884a5ea161 100644 --- a/registries/_format/binary.md +++ b/registries/_format/binary.md @@ -12,7 +12,7 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents any sequece of octets. This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). +The `{{page.slug}}` format represents any sequence of octets. This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). {% if page.issue %} ### GitHub Issue From 5ec29356885b4768cd67b069d654c6d576d31dcb Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 20 Feb 2023 10:28:25 -0500 Subject: [PATCH 02/53] - adds UUID format --- registries/_format/uuid.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 registries/_format/uuid.md diff --git a/registries/_format/uuid.md b/registries/_format/uuid.md new file mode 100644 index 0000000000..3b2d959702 --- /dev/null +++ b/registries/_format/uuid.md @@ -0,0 +1,23 @@ +--- +owner: baywet +issue: +description: A Universally Unique IDentifier as defined in RFC4122 +base_type: string +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format a Universally Unique IDentifier as defined in RFC4122. + +[Source](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers). + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file From 89f3a3912985222a9f9f343f251854efb8f661b0 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 20 Feb 2023 10:37:01 -0500 Subject: [PATCH 03/53] - adds URI format --- registries/_format/uri.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 registries/_format/uri.md diff --git a/registries/_format/uri.md b/registries/_format/uri.md new file mode 100644 index 0000000000..6f13101945 --- /dev/null +++ b/registries/_format/uri.md @@ -0,0 +1,23 @@ +--- +owner: baywet +issue: +description: A Uniform Resource Identifier as defined in RFC3986 +base_type: string +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is a Uniform Resource Identifier as defined in RFC3986. + +[Source](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers). + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file From 4db0d98f3bbea0d289ded00d3e04bc0adb6b6542 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 20 Feb 2023 10:40:04 -0500 Subject: [PATCH 04/53] - moves source links to YAML header so it can be in the table as well --- registries/_format/uri.md | 3 +-- registries/_format/uuid.md | 3 +-- registry/format.md | 6 +++--- 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/registries/_format/uri.md b/registries/_format/uri.md index 6f13101945..992a7e62d6 100644 --- a/registries/_format/uri.md +++ b/registries/_format/uri.md @@ -4,6 +4,7 @@ issue: description: A Uniform Resource Identifier as defined in RFC3986 base_type: string layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers --- # {{ page.collection }} @@ -14,8 +15,6 @@ Base type: `{{ page.base_type }}`. The `{{page.slug}}` format is a Uniform Resource Identifier as defined in RFC3986. -[Source](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers). - {% if page.issue %} ### GitHub Issue diff --git a/registries/_format/uuid.md b/registries/_format/uuid.md index 3b2d959702..9126dc4968 100644 --- a/registries/_format/uuid.md +++ b/registries/_format/uuid.md @@ -4,6 +4,7 @@ issue: description: A Universally Unique IDentifier as defined in RFC4122 base_type: string layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers --- # {{ page.collection }} @@ -14,8 +15,6 @@ Base type: `{{ page.base_type }}`. The `{{page.slug}}` format a Universally Unique IDentifier as defined in RFC4122. -[Source](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers). - {% if page.issue %} ### GitHub Issue diff --git a/registry/format.md b/registry/format.md index a23620794e..a4c4263961 100644 --- a/registry/format.md +++ b/registry/format.md @@ -15,8 +15,8 @@ Please raise a [Pull-Request](https://github.com/OAI/OpenAPI-Specification/pulls ## Values -|Value|Description|Issue| -|---|---|---| -{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {% if value.issue %}#{{ value.issue }}{% endif %} | +|Value|Description|Issue|Source| +|---|---|---|---| +{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {% if value.issue %}#{{ value.issue }}{% endif %} | {% if value.source %}Open{% endif %} {% endfor %} From 542fb7fb6773dcacfa07370ab3ff687f3d5b738d Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 20 Feb 2023 10:44:41 -0500 Subject: [PATCH 05/53] - adds URI template, IRI, IRI reference and URI reference --- registries/_format/iri-reference.md | 22 ++++++++++++++++++++++ registries/_format/iri.md | 22 ++++++++++++++++++++++ registries/_format/uri-reference.md | 22 ++++++++++++++++++++++ registries/_format/uri-template.md | 22 ++++++++++++++++++++++ 4 files changed, 88 insertions(+) create mode 100644 registries/_format/iri-reference.md create mode 100644 registries/_format/iri.md create mode 100644 registries/_format/uri-reference.md create mode 100644 registries/_format/uri-template.md diff --git a/registries/_format/iri-reference.md b/registries/_format/iri-reference.md new file mode 100644 index 0000000000..f40772fb8f --- /dev/null +++ b/registries/_format/iri-reference.md @@ -0,0 +1,22 @@ +--- +owner: baywet +issue: +description: A Internationalized Resource Identifier as defined in RFC3987 +base_type: string +layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is a Internationalized Resource Identifier as defined in RFC3987. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file diff --git a/registries/_format/iri.md b/registries/_format/iri.md new file mode 100644 index 0000000000..f40772fb8f --- /dev/null +++ b/registries/_format/iri.md @@ -0,0 +1,22 @@ +--- +owner: baywet +issue: +description: A Internationalized Resource Identifier as defined in RFC3987 +base_type: string +layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is a Internationalized Resource Identifier as defined in RFC3987. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file diff --git a/registries/_format/uri-reference.md b/registries/_format/uri-reference.md new file mode 100644 index 0000000000..a39dc00e53 --- /dev/null +++ b/registries/_format/uri-reference.md @@ -0,0 +1,22 @@ +--- +owner: baywet +issue: +description: A URI reference as defined in RFC3986 +base_type: string +layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is a URI reference as defined in RFC3986. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file diff --git a/registries/_format/uri-template.md b/registries/_format/uri-template.md new file mode 100644 index 0000000000..fed663990b --- /dev/null +++ b/registries/_format/uri-template.md @@ -0,0 +1,22 @@ +--- +owner: baywet +issue: +description: A URI Template as defined in RFC6570 +base_type: string +layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-uri-template +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is a URI Template as defined in RFC6570. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file From 569662c0a8670dc8f31be7abfc6e448496ba20c3 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 20 Feb 2023 10:49:14 -0500 Subject: [PATCH 06/53] - adds time and duration formats --- registries/_format/date-time.md | 1 + registries/_format/date.md | 1 + registries/_format/duration.md | 22 ++++++++++++++++++++++ registries/_format/time.md | 22 ++++++++++++++++++++++ 4 files changed, 46 insertions(+) create mode 100644 registries/_format/duration.md create mode 100644 registries/_format/time.md diff --git a/registries/_format/date-time.md b/registries/_format/date-time.md index 497271b24e..96fd5501bf 100644 --- a/registries/_format/date-time.md +++ b/registries/_format/date-time.md @@ -4,6 +4,7 @@ issue: description: date and time as defined by date-time - RFC3339 base_type: string layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-dates-times-and-duration --- # {{ page.collection }} diff --git a/registries/_format/date.md b/registries/_format/date.md index a1d7345d3b..441193ecae 100644 --- a/registries/_format/date.md +++ b/registries/_format/date.md @@ -4,6 +4,7 @@ issue: description: date as defined by full-date - RFC3339 base_type: string layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers --- # {{ page.collection }} diff --git a/registries/_format/duration.md b/registries/_format/duration.md new file mode 100644 index 0000000000..963cda95bb --- /dev/null +++ b/registries/_format/duration.md @@ -0,0 +1,22 @@ +--- +owner: baywet +issue: +description: duration as defined by duration - RFC3339 +base_type: string +layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-dates-times-and-duration +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format represents a duration as defined by duration - [RFC3339](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339#anchor14one). + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} diff --git a/registries/_format/time.md b/registries/_format/time.md new file mode 100644 index 0000000000..79e0716aab --- /dev/null +++ b/registries/_format/time.md @@ -0,0 +1,22 @@ +--- +owner: baywet +issue: +description: time as defined by full-time - RFC3339 +base_type: string +layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-dates-times-and-duration +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format represents a time as defined by full-time - [RFC3339](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339#anchor14one). + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} From fb02c1452403ee789397a747418401a7f643d699 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 20 Feb 2023 10:51:48 -0500 Subject: [PATCH 07/53] - adds email and idn email formats --- registries/_format/email.md | 22 ++++++++++++++++++++++ registries/_format/idn-email.md | 22 ++++++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 registries/_format/email.md create mode 100644 registries/_format/idn-email.md diff --git a/registries/_format/email.md b/registries/_format/email.md new file mode 100644 index 0000000000..25b66b175e --- /dev/null +++ b/registries/_format/email.md @@ -0,0 +1,22 @@ +--- +owner: baywet +issue: +description: An email address as defined as Mailbox in RFC5351 +base_type: string +layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-email-addresses +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is an email address as defined as Mailbox in RFC5351. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file diff --git a/registries/_format/idn-email.md b/registries/_format/idn-email.md new file mode 100644 index 0000000000..31b829d982 --- /dev/null +++ b/registries/_format/idn-email.md @@ -0,0 +1,22 @@ +--- +owner: baywet +issue: +description: An email address as defined as Mailbox in RFC6531 +base_type: string +layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-email-addresses +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is an email address as defined as Mailbox in RFC6531. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file From 055f1b26684cb8c8b1d34ff5ff19c44a0e8bc008 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 20 Feb 2023 10:56:21 -0500 Subject: [PATCH 08/53] - adds ipv4, v6, hostname and idn hostname formats --- registries/_format/hostname.md | 22 ++++++++++++++++++++++ registries/_format/idn-hostname.md | 22 ++++++++++++++++++++++ registries/_format/ipv4.md | 22 ++++++++++++++++++++++ registries/_format/ipv6.md | 22 ++++++++++++++++++++++ 4 files changed, 88 insertions(+) create mode 100644 registries/_format/hostname.md create mode 100644 registries/_format/idn-hostname.md create mode 100644 registries/_format/ipv4.md create mode 100644 registries/_format/ipv6.md diff --git a/registries/_format/hostname.md b/registries/_format/hostname.md new file mode 100644 index 0000000000..f08f37519a --- /dev/null +++ b/registries/_format/hostname.md @@ -0,0 +1,22 @@ +--- +owner: baywet +issue: +description: A host name as defined by RFC1123 +base_type: string +layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-hostnames +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is a host name as defined by RFC1123. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file diff --git a/registries/_format/idn-hostname.md b/registries/_format/idn-hostname.md new file mode 100644 index 0000000000..489f7fc0dd --- /dev/null +++ b/registries/_format/idn-hostname.md @@ -0,0 +1,22 @@ +--- +owner: baywet +issue: +description: An internationalized host name as defined by RFC5890 +base_type: string +layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-hostnames +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is an internationalized host name as defined by RFC5890. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file diff --git a/registries/_format/ipv4.md b/registries/_format/ipv4.md new file mode 100644 index 0000000000..f7e80bda97 --- /dev/null +++ b/registries/_format/ipv4.md @@ -0,0 +1,22 @@ +--- +owner: baywet +issue: +description: An IPv4 address as defined as dotted-quad by RFC2673 +base_type: string +layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-ip-addresses +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is an IPv4 address as defined as dotted-quad by RFC2673. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file diff --git a/registries/_format/ipv6.md b/registries/_format/ipv6.md new file mode 100644 index 0000000000..dcbec864dd --- /dev/null +++ b/registries/_format/ipv6.md @@ -0,0 +1,22 @@ +--- +owner: baywet +issue: +description: An IPv6 address as defined by RFC4673 +base_type: string +layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-ip-addresses +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is an IPv6 address as defined by RFC4673. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file From 6efed9f0c5b09c7080a11dfce10b793a27d4ed63 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 20 Feb 2023 11:01:44 -0500 Subject: [PATCH 09/53] - adds json and relative json pointers --- registries/_format/json-pointer.md | 22 +++++++++++++++++++ registries/_format/relative-json-pointer.md | 24 +++++++++++++++++++++ 2 files changed, 46 insertions(+) create mode 100644 registries/_format/json-pointer.md create mode 100644 registries/_format/relative-json-pointer.md diff --git a/registries/_format/json-pointer.md b/registries/_format/json-pointer.md new file mode 100644 index 0000000000..7224b4e238 --- /dev/null +++ b/registries/_format/json-pointer.md @@ -0,0 +1,22 @@ +--- +owner: baywet +issue: +description: A JSON string representation of a JSON Pointer as defined in RFC6901 +base_type: string +layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-json-pointers +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is a JSON string representation of a JSON Pointer as defined in RFC6901. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file diff --git a/registries/_format/relative-json-pointer.md b/registries/_format/relative-json-pointer.md new file mode 100644 index 0000000000..b501cfc1d7 --- /dev/null +++ b/registries/_format/relative-json-pointer.md @@ -0,0 +1,24 @@ +--- +owner: baywet +issue: +description: A JSON string representation of a relative JSON Pointer as defined in draft RFC 01 +base_type: string +layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-json-pointers +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is a JSON string representation of a relative JSON Pointer as defined in draft RFC 01. + +[Relative JSON pointers draft RFC 01](https://datatracker.ietf.org/doc/html/draft-handrews-relative-json-pointer-01). + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file From 4662a6c17c78bd800d56de22c050e4513fb85d4d Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 20 Feb 2023 11:03:55 -0500 Subject: [PATCH 10/53] - adds regex --- registries/_format/regex.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 registries/_format/regex.md diff --git a/registries/_format/regex.md b/registries/_format/regex.md new file mode 100644 index 0000000000..1c542d0820 --- /dev/null +++ b/registries/_format/regex.md @@ -0,0 +1,22 @@ +--- +owner: baywet +issue: +description: A regular expression as defined in ECMA-262 +base_type: string +layout: default +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-regex +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is a regular expression as defined in ECMA-262. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file From 264e1d127ff4353466ba084e115cf700c6e9dc7f Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 20 Feb 2023 11:11:31 -0500 Subject: [PATCH 11/53] - adds base64 url format --- registries/_format/base64url.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 registries/_format/base64url.md diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md new file mode 100644 index 0000000000..c5e40e2e21 --- /dev/null +++ b/registries/_format/base64url.md @@ -0,0 +1,21 @@ +--- +owner: baywet +issue: +description: A url-safe binary array as defined in RFC4648 +base_type: string +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is a url-safe binary array as defined in RFC4648. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file From d06da41b3c887f8a2bb2d034f5954d1fea9ec47a Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 20 Feb 2023 11:11:47 -0500 Subject: [PATCH 12/53] - adds decimal format --- registries/_format/decimal.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 registries/_format/decimal.md diff --git a/registries/_format/decimal.md b/registries/_format/decimal.md new file mode 100644 index 0000000000..79f11927e0 --- /dev/null +++ b/registries/_format/decimal.md @@ -0,0 +1,21 @@ +--- +owner: baywet +issue: +description: A fixed point decimal number as defined by ISO/IEC 9075-2 2016 12 15 +base_type: number +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is a fixed point decimal number as defined by ISO/IEC 9075-2 2016 12 15. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file From 2615957a448b531f04b0b549592d62a3378d7cf6 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 20 Feb 2023 11:12:25 -0500 Subject: [PATCH 13/53] - adds char format --- registries/_format/char.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 registries/_format/char.md diff --git a/registries/_format/char.md b/registries/_format/char.md new file mode 100644 index 0000000000..419e4ffe3e --- /dev/null +++ b/registries/_format/char.md @@ -0,0 +1,21 @@ +--- +owner: baywet +issue: +description: A single character +base_type: string +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is a single character. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} \ No newline at end of file From 601b44a7350d6198000256258d59e90d221d3e6a Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 20 Feb 2023 11:15:20 -0500 Subject: [PATCH 14/53] - typo fix --- registries/_format/byte.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/registries/_format/byte.md b/registries/_format/byte.md index 69533e5327..64fc28ed68 100644 --- a/registries/_format/byte.md +++ b/registries/_format/byte.md @@ -12,7 +12,7 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents any sequece of octets encoded as a base64 string. This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). +The `{{page.slug}}` format represents any sequence of octets encoded as a base64 string. This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). {% if page.issue %} ### GitHub Issue From 162a2cba7a86a14cc2efb164b0f08e1397e236ac Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 20 Feb 2023 16:11:02 -0500 Subject: [PATCH 15/53] - switches base type for decimal to number --- registries/_format/decimal.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/registries/_format/decimal.md b/registries/_format/decimal.md index 79f11927e0..9810b50046 100644 --- a/registries/_format/decimal.md +++ b/registries/_format/decimal.md @@ -2,7 +2,7 @@ owner: baywet issue: description: A fixed point decimal number as defined by ISO/IEC 9075-2 2016 12 15 -base_type: number +base_type: string layout: default --- From 7cdeff46d1f02b3ab4955fe45e7455a3a1c68dfa Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Tue, 21 Feb 2023 08:46:49 -0500 Subject: [PATCH 16/53] - removes link to master issue Signed-off-by: Vincent Biret --- registry/format.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/registry/format.md b/registry/format.md index a4c4263961..9ee65a23ac 100644 --- a/registry/format.md +++ b/registry/format.md @@ -5,10 +5,6 @@ permalink: /registry/format/index.html # Formats Registry -## Master Issue - -* [#845](https://github.com/OAI/OpenAPI-Specification/issues/845) - ## Contributing Please raise a [Pull-Request](https://github.com/OAI/OpenAPI-Specification/pulls) or [Issue](https://github.com/OAI/OpenAPI-Specification/issues) to contribute or discuss a registry value. From c0038879e54f5b1e623ce9cd4efe6b884e00d0c0 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Tue, 21 Feb 2023 08:53:55 -0500 Subject: [PATCH 17/53] - adds recommendation for binary format in 3.1 Signed-off-by: Vincent Biret --- registries/_format/binary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/registries/_format/binary.md b/registries/_format/binary.md index 884a5ea161..07575edd23 100644 --- a/registries/_format/binary.md +++ b/registries/_format/binary.md @@ -12,7 +12,7 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents any sequence of octets. This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). +The `{{page.slug}}` format represents any sequence of octets. This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). When using OpenAPI 3.1 or above it's recommended not to use this format and instead set the `contentMediaType` property of the response to `application/octet-stream` without a `schema` property. {% if page.issue %} ### GitHub Issue From 1e853a52cef99c7ed3df40e188a35aa979ab6d5e Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Tue, 21 Feb 2023 09:18:35 -0500 Subject: [PATCH 18/53] Update registries/_format/date.md Co-authored-by: Ralf Handl --- registries/_format/date.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/registries/_format/date.md b/registries/_format/date.md index 441193ecae..ca1c65dfd6 100644 --- a/registries/_format/date.md +++ b/registries/_format/date.md @@ -4,7 +4,7 @@ issue: description: date as defined by full-date - RFC3339 base_type: string layout: default -source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-dates-times-and-duration --- # {{ page.collection }} From b65583a9e091a97b79e48894c73ce6fa2cf465e8 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Tue, 21 Feb 2023 09:32:21 -0500 Subject: [PATCH 19/53] - fixes link to duration spec Co-authored-by: Ralf Handl --- registries/_format/duration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/registries/_format/duration.md b/registries/_format/duration.md index 963cda95bb..832dd9ea7f 100644 --- a/registries/_format/duration.md +++ b/registries/_format/duration.md @@ -13,7 +13,7 @@ source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-d Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents a duration as defined by duration - [RFC3339](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339#anchor14one). +The `{{page.slug}}` format represents a duration as defined by duration - [RFC3339](https://www.rfc-editor.org/rfc/rfc3339.html#appendix-A). {% if page.issue %} ### GitHub Issue From b14a76689b4aeed09c8c9071170c619550a9b5dc Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Tue, 21 Feb 2023 10:02:08 -0500 Subject: [PATCH 20/53] - fixes email RFC number Co-authored-by: Ralf Handl --- registries/_format/email.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/registries/_format/email.md b/registries/_format/email.md index 25b66b175e..c127cac5fd 100644 --- a/registries/_format/email.md +++ b/registries/_format/email.md @@ -1,7 +1,7 @@ --- owner: baywet issue: -description: An email address as defined as Mailbox in RFC5351 +description: An email address as defined as Mailbox in RFC5321 base_type: string layout: default source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-email-addresses From 0267989d3197ff59bdac5704324e501265567051 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Tue, 21 Feb 2023 10:02:26 -0500 Subject: [PATCH 21/53] - adds email rfc link Co-authored-by: Ralf Handl --- registries/_format/email.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/registries/_format/email.md b/registries/_format/email.md index c127cac5fd..de3d9f2959 100644 --- a/registries/_format/email.md +++ b/registries/_format/email.md @@ -13,7 +13,7 @@ source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-e Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format is an email address as defined as Mailbox in RFC5351. +The `{{page.slug}}` format is an email address as defined as Mailbox in [RFC5321](https://www.rfc-editor.org/rfc/rfc5321). {% if page.issue %} ### GitHub Issue From 3cd829b3ab7c49da09fa56c608b46f212c45cb61 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Tue, 21 Feb 2023 10:02:44 -0500 Subject: [PATCH 22/53] - adds IDN hostname RFC link Co-authored-by: Ralf Handl --- registries/_format/idn-hostname.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/registries/_format/idn-hostname.md b/registries/_format/idn-hostname.md index 489f7fc0dd..196fae7564 100644 --- a/registries/_format/idn-hostname.md +++ b/registries/_format/idn-hostname.md @@ -13,7 +13,7 @@ source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-h Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format is an internationalized host name as defined by RFC5890. +The `{{page.slug}}` format is an internationalized host name as defined by [RFC5890](https://www.rfc-editor.org/rfc/rfc5890.html). {% if page.issue %} ### GitHub Issue From edc82608d5349fe90010d5adf1491492feca4251 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Tue, 21 Feb 2023 10:03:14 -0500 Subject: [PATCH 23/53] - adds idn email RFC link Co-authored-by: Ralf Handl --- registries/_format/idn-email.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/registries/_format/idn-email.md b/registries/_format/idn-email.md index 31b829d982..35ec8068d9 100644 --- a/registries/_format/idn-email.md +++ b/registries/_format/idn-email.md @@ -13,7 +13,7 @@ source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-e Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format is an email address as defined as Mailbox in RFC6531. +The `{{page.slug}}` format is an email address as defined as Mailbox in [RFC6531](https://www.rfc-editor.org/rfc/rfc6531). {% if page.issue %} ### GitHub Issue From da95b867056db714582b650285c21613d9ce727e Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Tue, 21 Feb 2023 10:15:38 -0500 Subject: [PATCH 24/53] - adds base type, version and remarks to format table Signed-off-by: Vincent Biret --- registries/_format/base64url.md | 12 ++++++++++++ registries/_format/binary.md | 12 ++++++++++++ registries/_format/byte.md | 12 ++++++++++++ registries/_format/char.md | 12 ++++++++++++ registries/_format/commonmark.md | 12 ++++++++++++ registries/_format/date-time.md | 12 ++++++++++++ registries/_format/date.md | 12 ++++++++++++ registries/_format/decimal.md | 12 ++++++++++++ registries/_format/double.md | 12 ++++++++++++ registries/_format/duration.md | 12 ++++++++++++ registries/_format/email.md | 12 ++++++++++++ registries/_format/float.md | 12 ++++++++++++ registries/_format/hostname.md | 12 ++++++++++++ registries/_format/html.md | 12 ++++++++++++ registries/_format/idn-email.md | 12 ++++++++++++ registries/_format/idn-hostname.md | 12 ++++++++++++ registries/_format/int32.md | 12 ++++++++++++ registries/_format/int64.md | 12 ++++++++++++ registries/_format/int8.md | 12 ++++++++++++ registries/_format/ipv4.md | 12 ++++++++++++ registries/_format/ipv6.md | 12 ++++++++++++ registries/_format/iri-reference.md | 12 ++++++++++++ registries/_format/iri.md | 12 ++++++++++++ registries/_format/json-pointer.md | 14 +++++++++++++- registries/_format/regex.md | 14 +++++++++++++- registries/_format/relative-json-pointer.md | 14 +++++++++++++- registries/_format/time.md | 12 ++++++++++++ registries/_format/uint8.md | 11 +++++++++++ registries/_format/uri-reference.md | 14 +++++++++++++- registries/_format/uri-template.md | 14 +++++++++++++- registries/_format/uri.md | 14 +++++++++++++- registries/_format/uuid.md | 14 +++++++++++++- registry/format.md | 6 +++--- 33 files changed, 393 insertions(+), 10 deletions(-) diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md index c5e40e2e21..bf6f92cdfe 100644 --- a/registries/_format/base64url.md +++ b/registries/_format/base64url.md @@ -18,4 +18,16 @@ The `{{page.slug}}` format is a url-safe binary array as defined in RFC4648. ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/binary.md b/registries/_format/binary.md index 07575edd23..9d059e6cb2 100644 --- a/registries/_format/binary.md +++ b/registries/_format/binary.md @@ -19,3 +19,15 @@ The `{{page.slug}}` format represents any sequence of octets. This format entry * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} diff --git a/registries/_format/byte.md b/registries/_format/byte.md index 64fc28ed68..47b1c9c353 100644 --- a/registries/_format/byte.md +++ b/registries/_format/byte.md @@ -19,3 +19,15 @@ The `{{page.slug}}` format represents any sequence of octets encoded as a base64 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} \ No newline at end of file diff --git a/registries/_format/char.md b/registries/_format/char.md index 419e4ffe3e..1f89a2a3a0 100644 --- a/registries/_format/char.md +++ b/registries/_format/char.md @@ -18,4 +18,16 @@ The `{{page.slug}}` format is a single character. ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/commonmark.md b/registries/_format/commonmark.md index 959b597e2a..97aaebdaf1 100644 --- a/registries/_format/commonmark.md +++ b/registries/_format/commonmark.md @@ -19,3 +19,15 @@ The `{{page.slug}}` format represents [CommonMark](https://commonmark.org/) form * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} \ No newline at end of file diff --git a/registries/_format/date-time.md b/registries/_format/date-time.md index 96fd5501bf..66870f7b20 100644 --- a/registries/_format/date-time.md +++ b/registries/_format/date-time.md @@ -20,3 +20,15 @@ The `{{page.slug}}` format represents a date and time as defined by date-time - * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} diff --git a/registries/_format/date.md b/registries/_format/date.md index ca1c65dfd6..3ff32f8bb7 100644 --- a/registries/_format/date.md +++ b/registries/_format/date.md @@ -20,3 +20,15 @@ The `{{page.slug}}` format represents a date as defined by full-date - [RFC3339] * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} diff --git a/registries/_format/decimal.md b/registries/_format/decimal.md index 9810b50046..8d64eefe71 100644 --- a/registries/_format/decimal.md +++ b/registries/_format/decimal.md @@ -18,4 +18,16 @@ The `{{page.slug}}` format is a fixed point decimal number as defined by ISO/IEC ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/double.md b/registries/_format/double.md index 417af4c715..6c83d5750f 100644 --- a/registries/_format/double.md +++ b/registries/_format/double.md @@ -19,3 +19,15 @@ The `{{page.slug}}` format represents a double precision (64bit) floating point * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} \ No newline at end of file diff --git a/registries/_format/duration.md b/registries/_format/duration.md index 832dd9ea7f..f1c43945f0 100644 --- a/registries/_format/duration.md +++ b/registries/_format/duration.md @@ -20,3 +20,15 @@ The `{{page.slug}}` format represents a duration as defined by duration - [RFC33 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} diff --git a/registries/_format/email.md b/registries/_format/email.md index de3d9f2959..f29fd5d536 100644 --- a/registries/_format/email.md +++ b/registries/_format/email.md @@ -19,4 +19,16 @@ The `{{page.slug}}` format is an email address as defined as Mailbox in [RFC5321 ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/float.md b/registries/_format/float.md index cbe24fdc7b..0e079b84be 100644 --- a/registries/_format/float.md +++ b/registries/_format/float.md @@ -19,3 +19,15 @@ The `{{page.slug}}` format represents a single precision (32bit) floating point * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} \ No newline at end of file diff --git a/registries/_format/hostname.md b/registries/_format/hostname.md index f08f37519a..2dadd61696 100644 --- a/registries/_format/hostname.md +++ b/registries/_format/hostname.md @@ -19,4 +19,16 @@ The `{{page.slug}}` format is a host name as defined by RFC1123. ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/html.md b/registries/_format/html.md index 49b89db7b0..f9c84c1d0e 100644 --- a/registries/_format/html.md +++ b/registries/_format/html.md @@ -19,3 +19,15 @@ The `{{page.slug}}` format represents HTML-formatted text. * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} \ No newline at end of file diff --git a/registries/_format/idn-email.md b/registries/_format/idn-email.md index 35ec8068d9..3c1437bcaf 100644 --- a/registries/_format/idn-email.md +++ b/registries/_format/idn-email.md @@ -19,4 +19,16 @@ The `{{page.slug}}` format is an email address as defined as Mailbox in [RFC6531 ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/idn-hostname.md b/registries/_format/idn-hostname.md index 196fae7564..7bd6cbe2da 100644 --- a/registries/_format/idn-hostname.md +++ b/registries/_format/idn-hostname.md @@ -19,4 +19,16 @@ The `{{page.slug}}` format is an internationalized host name as defined by [RFC5 ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/int32.md b/registries/_format/int32.md index a22ed98821..0e0b43c611 100644 --- a/registries/_format/int32.md +++ b/registries/_format/int32.md @@ -19,3 +19,15 @@ The `{{page.slug}}` format represents a signed 32-bit integer, with the range * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} \ No newline at end of file diff --git a/registries/_format/int64.md b/registries/_format/int64.md index 0fd3ebf1fa..ef1780dc3a 100644 --- a/registries/_format/int64.md +++ b/registries/_format/int64.md @@ -19,3 +19,15 @@ The `{{page.slug}}` format represents a signed 64-bit integer, with the range -9 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} \ No newline at end of file diff --git a/registries/_format/int8.md b/registries/_format/int8.md index 38524e7a7b..f497ff564c 100644 --- a/registries/_format/int8.md +++ b/registries/_format/int8.md @@ -19,3 +19,15 @@ The `{{page.slug}}` format represents a signed 8-bit integer, with the range -12 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} \ No newline at end of file diff --git a/registries/_format/ipv4.md b/registries/_format/ipv4.md index f7e80bda97..535380fce6 100644 --- a/registries/_format/ipv4.md +++ b/registries/_format/ipv4.md @@ -19,4 +19,16 @@ The `{{page.slug}}` format is an IPv4 address as defined as dotted-quad by RFC26 ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/ipv6.md b/registries/_format/ipv6.md index dcbec864dd..7ef26e6d4f 100644 --- a/registries/_format/ipv6.md +++ b/registries/_format/ipv6.md @@ -19,4 +19,16 @@ The `{{page.slug}}` format is an IPv6 address as defined by RFC4673. ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/iri-reference.md b/registries/_format/iri-reference.md index f40772fb8f..99c3726f43 100644 --- a/registries/_format/iri-reference.md +++ b/registries/_format/iri-reference.md @@ -19,4 +19,16 @@ The `{{page.slug}}` format is a Internationalized Resource Identifier as defined ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/iri.md b/registries/_format/iri.md index f40772fb8f..99c3726f43 100644 --- a/registries/_format/iri.md +++ b/registries/_format/iri.md @@ -19,4 +19,16 @@ The `{{page.slug}}` format is a Internationalized Resource Identifier as defined ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/json-pointer.md b/registries/_format/json-pointer.md index 7224b4e238..80bd0ab299 100644 --- a/registries/_format/json-pointer.md +++ b/registries/_format/json-pointer.md @@ -19,4 +19,16 @@ The `{{page.slug}}` format is a JSON string representation of a JSON Pointer as ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) -{% endif %} \ No newline at end of file +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} diff --git a/registries/_format/regex.md b/registries/_format/regex.md index 1c542d0820..4625a758a8 100644 --- a/registries/_format/regex.md +++ b/registries/_format/regex.md @@ -19,4 +19,16 @@ The `{{page.slug}}` format is a regular expression as defined in ECMA-262. ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) -{% endif %} \ No newline at end of file +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} diff --git a/registries/_format/relative-json-pointer.md b/registries/_format/relative-json-pointer.md index b501cfc1d7..5d760888e1 100644 --- a/registries/_format/relative-json-pointer.md +++ b/registries/_format/relative-json-pointer.md @@ -21,4 +21,16 @@ The `{{page.slug}}` format is a JSON string representation of a relative JSON Po ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) -{% endif %} \ No newline at end of file +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} diff --git a/registries/_format/time.md b/registries/_format/time.md index 79e0716aab..ad4f79fc4f 100644 --- a/registries/_format/time.md +++ b/registries/_format/time.md @@ -20,3 +20,15 @@ The `{{page.slug}}` format represents a time as defined by full-time - [RFC3339] * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} diff --git a/registries/_format/uint8.md b/registries/_format/uint8.md index e9919ab03c..da6ceed798 100644 --- a/registries/_format/uint8.md +++ b/registries/_format/uint8.md @@ -20,3 +20,14 @@ The `{{page.slug}}` format represents an unsigned 8-bit integer, with the range * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} diff --git a/registries/_format/uri-reference.md b/registries/_format/uri-reference.md index a39dc00e53..b9ff872f51 100644 --- a/registries/_format/uri-reference.md +++ b/registries/_format/uri-reference.md @@ -19,4 +19,16 @@ The `{{page.slug}}` format is a URI reference as defined in RFC3986. ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) -{% endif %} \ No newline at end of file +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} diff --git a/registries/_format/uri-template.md b/registries/_format/uri-template.md index fed663990b..834a6edca7 100644 --- a/registries/_format/uri-template.md +++ b/registries/_format/uri-template.md @@ -19,4 +19,16 @@ The `{{page.slug}}` format is a URI Template as defined in RFC6570. ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) -{% endif %} \ No newline at end of file +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} diff --git a/registries/_format/uri.md b/registries/_format/uri.md index 992a7e62d6..4003147eaa 100644 --- a/registries/_format/uri.md +++ b/registries/_format/uri.md @@ -19,4 +19,16 @@ The `{{page.slug}}` format is a Uniform Resource Identifier as defined in RFC398 ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) -{% endif %} \ No newline at end of file +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} diff --git a/registries/_format/uuid.md b/registries/_format/uuid.md index 9126dc4968..194b4f884b 100644 --- a/registries/_format/uuid.md +++ b/registries/_format/uuid.md @@ -19,4 +19,16 @@ The `{{page.slug}}` format a Universally Unique IDentifier as defined in RFC4122 ### GitHub Issue * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) -{% endif %} \ No newline at end of file +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} diff --git a/registry/format.md b/registry/format.md index 9ee65a23ac..a762428051 100644 --- a/registry/format.md +++ b/registry/format.md @@ -11,8 +11,8 @@ Please raise a [Pull-Request](https://github.com/OAI/OpenAPI-Specification/pulls ## Values -|Value|Description|Issue|Source| -|---|---|---|---| -{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {% if value.issue %}#{{ value.issue }}{% endif %} | {% if value.source %}Open{% endif %} +|Value|Description|Type|OpenAPI Version|Source|Remarks| +|---|---|----|---|---|----| +{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type }} | {{ value.oas_version }} | {% if value.source %}Open{% endif %} | {{ value.remarks }} | {% endfor %} From 5f92e2b68fc333d64b74feb2ab7f85ae47c4921c Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Tue, 21 Feb 2023 10:18:02 -0500 Subject: [PATCH 25/53] - adds version and remarks for binary format Signed-off-by: Vincent Biret --- registries/_format/binary.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/registries/_format/binary.md b/registries/_format/binary.md index 9d059e6cb2..0b7f333c87 100644 --- a/registries/_format/binary.md +++ b/registries/_format/binary.md @@ -4,6 +4,8 @@ issue: description: any sequence of octets base_type: string layout: default +oas_version: < 3.1 +remarks: "When using OpenAPI 3.1 or above it's recommended not to use this format and instead set the `contentMediaType` property of the response to `application/octet-stream` without a `schema` property." --- # {{ page.collection }} @@ -12,7 +14,7 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents any sequence of octets. This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). When using OpenAPI 3.1 or above it's recommended not to use this format and instead set the `contentMediaType` property of the response to `application/octet-stream` without a `schema` property. +The `{{page.slug}}` format represents any sequence of octets. This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). {% if page.issue %} ### GitHub Issue From c92ab8eb3d3222fd314d62ed3d45f249c17c6456 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Tue, 21 Feb 2023 11:23:41 -0500 Subject: [PATCH 26/53] - adds support for floating points in decimal --- registries/_format/decimal.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/registries/_format/decimal.md b/registries/_format/decimal.md index 8d64eefe71..acfda57677 100644 --- a/registries/_format/decimal.md +++ b/registries/_format/decimal.md @@ -1,7 +1,7 @@ --- owner: baywet issue: -description: A fixed point decimal number as defined by ISO/IEC 9075-2 2016 12 15 +description: A fixed or floating point decimal number as defined by ISO/IEC 9075-2 2016 12 15 base_type: string layout: default --- From 63381faf4b37cfa4830f5843655dddd14162b1ad Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Tue, 21 Feb 2023 12:11:09 -0500 Subject: [PATCH 27/53] Apply suggestions from code review Co-authored-by: Ralf Handl --- registries/_format/decimal.md | 2 +- registries/_format/time.md | 2 +- registries/_format/uri-template.md | 2 +- registries/_format/uuid.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/registries/_format/decimal.md b/registries/_format/decimal.md index acfda57677..06613a687e 100644 --- a/registries/_format/decimal.md +++ b/registries/_format/decimal.md @@ -12,7 +12,7 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format is a fixed point decimal number as defined by ISO/IEC 9075-2 2016 12 15. +The `{{page.slug}}` format represents a fixed or floating point decimal number as defined by ISO/IEC 9075-2 2016 12 15. {% if page.issue %} ### GitHub Issue diff --git a/registries/_format/time.md b/registries/_format/time.md index ad4f79fc4f..8c22a49ef9 100644 --- a/registries/_format/time.md +++ b/registries/_format/time.md @@ -13,7 +13,7 @@ source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-d Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents a time as defined by full-time - [RFC3339](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339#anchor14one). +The `{{page.slug}}` format represents a time as defined by full-time - [RFC3339](https://www.rfc-editor.org/rfc/rfc3339.html#section-5.6). {% if page.issue %} ### GitHub Issue diff --git a/registries/_format/uri-template.md b/registries/_format/uri-template.md index 834a6edca7..86cf4500ef 100644 --- a/registries/_format/uri-template.md +++ b/registries/_format/uri-template.md @@ -13,7 +13,7 @@ source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-u Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format is a URI Template as defined in RFC6570. +The `{{page.slug}}` format is a URI Template as defined in [RFC6570](https://www.rfc-editor.org/rfc/rfc6570). {% if page.issue %} ### GitHub Issue diff --git a/registries/_format/uuid.md b/registries/_format/uuid.md index 194b4f884b..3e67c49510 100644 --- a/registries/_format/uuid.md +++ b/registries/_format/uuid.md @@ -13,7 +13,7 @@ source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-r Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format a Universally Unique IDentifier as defined in RFC4122. +The `{{page.slug}}` format a Universally Unique IDentifier as defined in [RFC4122](https://www.rfc-editor.org/rfc/rfc4122). {% if page.issue %} ### GitHub Issue From ba4fdca30e940a090f1b2a0d43ee6dfbe2107874 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Wed, 22 Feb 2023 08:09:56 -0500 Subject: [PATCH 28/53] - adds int16 to the format list Signed-off-by: Vincent Biret --- registries/_format/int16.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 registries/_format/int16.md diff --git a/registries/_format/int16.md b/registries/_format/int16.md new file mode 100644 index 0000000000..e7fd808d60 --- /dev/null +++ b/registries/_format/int16.md @@ -0,0 +1,33 @@ +--- +owner: DarrelMiller +issue: +description: signed 16-bit integer +base_type: number +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format represents a signed 16-bit integer, with the range -32768 through +32767. This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +#{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +#{{ page.remarks }} +{% endif %} \ No newline at end of file From 145da5afd2a2e0a870de59b899af517102f3b0e4 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Thu, 23 Feb 2023 07:50:51 -0500 Subject: [PATCH 29/53] - adds link to the base64 url RFC Co-authored-by: Ralf Handl --- registries/_format/base64url.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md index bf6f92cdfe..c0cee7e920 100644 --- a/registries/_format/base64url.md +++ b/registries/_format/base64url.md @@ -12,7 +12,7 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format is a url-safe binary array as defined in RFC4648. +The `{{page.slug}}` format is a url-safe binary array as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-5). {% if page.issue %} ### GitHub Issue From dc6434eb90a7dcbcf1aac5e789e91f6286ea74af Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Thu, 23 Feb 2023 10:27:05 -0500 Subject: [PATCH 30/53] - adds remark for base64url format --- registries/_format/base64url.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md index c0cee7e920..ed9f1c0fa0 100644 --- a/registries/_format/base64url.md +++ b/registries/_format/base64url.md @@ -4,6 +4,8 @@ issue: description: A url-safe binary array as defined in RFC4648 base_type: string layout: default +oas_version: < 3.1 +remarks: "When using OpenAPI 3.1 or above it's recommended not to use this format and instead use contentEncoding with a value of base64url." --- # {{ page.collection }} From ea6e131cb00801cfa2f681832eca1e67f1eff6a3 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Thu, 23 Feb 2023 10:32:08 -0500 Subject: [PATCH 31/53] - adds link to the base64 url RFC --- registries/_format/base64url.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md index ed9f1c0fa0..96f22a3d35 100644 --- a/registries/_format/base64url.md +++ b/registries/_format/base64url.md @@ -5,7 +5,7 @@ description: A url-safe binary array as defined in RFC4648 base_type: string layout: default oas_version: < 3.1 -remarks: "When using OpenAPI 3.1 or above it's recommended not to use this format and instead use contentEncoding with a value of base64url." +remarks: "When using OpenAPI 3.1 or above it's recommended not to use this format and instead use [`contentEncoding` with a value of `base64url`](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentencoding)." --- # {{ page.collection }} From ffc64ff41cb99d3543f03ab834c72791a03d9df4 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Thu, 23 Feb 2023 10:37:33 -0500 Subject: [PATCH 32/53] - fixes link to source Signed-off-by: Vincent Biret --- registry/format.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/registry/format.md b/registry/format.md index a762428051..300139e29f 100644 --- a/registry/format.md +++ b/registry/format.md @@ -13,6 +13,6 @@ Please raise a [Pull-Request](https://github.com/OAI/OpenAPI-Specification/pulls |Value|Description|Type|OpenAPI Version|Source|Remarks| |---|---|----|---|---|----| -{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type }} | {{ value.oas_version }} | {% if value.source %}Open{% endif %} | {{ value.remarks }} | +{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type }} | {{ value.oas_version }} | {% if value.source %}Open{% endif %} | {{ value.remarks }} | {% endfor %} From 63bcd4d56e6fc2aa94bd4efe3b5d12e91b8f3e96 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Fri, 24 Feb 2023 08:11:06 -0500 Subject: [PATCH 33/53] - adds details about base64, base64url and byte formats Signed-off-by: Vincent Biret --- registries/_format/base64url.md | 101 ++++++++++++++++++++++++++++++++ registries/_format/binary.md | 66 ++++++++++++++++++++- registries/_format/byte.md | 84 ++++++++++++++++++++++++++ 3 files changed, 250 insertions(+), 1 deletion(-) diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md index 96f22a3d35..b7f8a302b0 100644 --- a/registries/_format/base64url.md +++ b/registries/_format/base64url.md @@ -16,6 +16,107 @@ Base type: `{{ page.base_type }}`. The `{{page.slug}}` format is a url-safe binary array as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-5). +### Upgrading from < 3.1 to >= 3.1 + +#### Entire response body + +```yaml +#OAS 3.0 +paths: + '/picture': + get: + responses: + '200': + content: + image/png: + schema: + type: string + format: byte + +#OAS 3.1 +paths: + '/picture': + get: + responses: + '200': + content: + image/png: + type: string + contentEncoding: base64 +``` + +#### Encoded property as part of a structured response + +```yaml +#OAS 3.0 +paths: + '/picture': + get: + responses: + '200': + content: + application/json: + schema: + properties: + width: + schema: + type: string + height: + schema: + type: string + image: + type: string + format: base64url + +#OAS 3.1 +paths: + '/picture': + get: + responses: + '200': + content: + application/json: + schema: + properties: + width: + schema: + type: string + height: + schema: + type: string + image: + type: string + contentMediaType: image/png + contentEncoding: base64url +``` + +#### Query or Path parameters + +```yaml +#OAS 3.0 +parameters: + - name: anImage + in: query + content: + image/png: + schema: + type: string + format: byte + +#OAS 3.1 +parameters: + - name: anImage + in: query + schema: + type: string + contentMediaType: image/png + contentEncoding: base64url +``` + +#### Multipart/form-data + +Using base64url for multipart/form-data parts is not recommended since it artificially inflates the payload size with not added value. + {% if page.issue %} ### GitHub Issue diff --git a/registries/_format/binary.md b/registries/_format/binary.md index 0b7f333c87..bf8c366ab4 100644 --- a/registries/_format/binary.md +++ b/registries/_format/binary.md @@ -5,7 +5,7 @@ description: any sequence of octets base_type: string layout: default oas_version: < 3.1 -remarks: "When using OpenAPI 3.1 or above it's recommended not to use this format and instead set the `contentMediaType` property of the response to `application/octet-stream` without a `schema` property." +remarks: "When using OpenAPI 3.1 or above it's recommended not to use this format and instead set the `mediaType` to `application/octet-stream`, `image/png`,... without a `schema` property. This format MUST ONLY be used for schemas that represent the whole request/response body and MUST NOT be used for properties, arrays, etc..." --- # {{ page.collection }} @@ -16,6 +16,70 @@ Base type: `{{ page.base_type }}`. The `{{page.slug}}` format represents any sequence of octets. This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). +### Upgrading from < 3.1 to >= 3.1 + +#### Entire response body + +```yaml +#OAS 3.0 +paths: + '/picture': + get: + responses: + '200': + content: + image/png: + schema: + type: string + format: binary + +#OAS 3.1 +paths: + '/picture': + get: + responses: + '200': + content: + image/png: + schema: true #optional, some linters require a schema property +``` + +#### Encoded property as part of a structured response + +Using the binary format as part of a structured response for a property or an array is invalid. The only exception is for `multipart/form-data` content. + +#### Query or Path parameters + +Using the binary format query or path parameters is invalid. + +#### Multipart/form-data + +```yaml +#OAS 3.0 +content: + multipart/form-data: + schema: + type: object + properties: + anImage: + type: string + format: binary + encoding: + anImage: + contentType: image/png + +# OAS 3.1 +content: + multipart/form-data: + schema: + type: object + properties: + anImage: {} + encoding: + anImage: + contentType: image/png +``` + {% if page.issue %} ### GitHub Issue diff --git a/registries/_format/byte.md b/registries/_format/byte.md index 47b1c9c353..7cd9cad3f5 100644 --- a/registries/_format/byte.md +++ b/registries/_format/byte.md @@ -4,6 +4,8 @@ issue: description: base64 encoded characters base_type: string layout: default +oas_version: < 3.1 +remarks: "When using OpenAPI 3.1 or above it's recommended not to use this format and instead use [`contentEncoding` with a value of `base64`](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentencoding)." --- # {{ page.collection }} @@ -14,6 +16,88 @@ Base type: `{{ page.base_type }}`. The `{{page.slug}}` format represents any sequence of octets encoded as a base64 string. This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). +### Upgrading from < 3.1 to >= 3.1 + +#### Entire response body + +```yaml +#OAS 3.0 +paths: + '/picture': + get: + responses: + '200': + content: + image/png: + schema: + type: string + format: byte + +#OAS 3.1 +paths: + '/picture': + get: + responses: + '200': + content: + image/png: + type: string + contentEncoding: base64 +``` + +#### Encoded property as part of a structured response + +```yaml +#OAS 3.0 +paths: + '/picture': + get: + responses: + '200': + content: + application/json: + schema: + properties: + width: + schema: + type: string + height: + schema: + type: string + image: + type: string + format: byte + +#OAS 3.1 +paths: + '/picture': + get: + responses: + '200': + content: + application/json: + schema: + properties: + width: + schema: + type: string + height: + schema: + type: string + image: + type: string + contentMediaType: image/png + contentEncoding: base64 +``` + +#### Query or Path parameters + +Using byte or base64 for path or query parameters is not recommended since this encoding makes use of characters that are not URL safe. + +#### Multipart/form-data + +Using byte or base64 for multipart/form-data parts is not recommended since it artificially inflates the payload size with not added value. + {% if page.issue %} ### GitHub Issue From cb888246dede9027d991f1388900a439c621cbeb Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Fri, 24 Feb 2023 08:18:24 -0500 Subject: [PATCH 34/53] - typo fix Signed-off-by: Vincent Biret --- registries/_format/base64url.md | 4 ++-- registries/_format/binary.md | 4 ++-- registries/_format/byte.md | 4 ++-- registries/_format/char.md | 4 ++-- registries/_format/commonmark.md | 4 ++-- registries/_format/date-time.md | 4 ++-- registries/_format/date.md | 4 ++-- registries/_format/decimal.md | 4 ++-- registries/_format/double.md | 4 ++-- registries/_format/duration.md | 4 ++-- registries/_format/email.md | 4 ++-- registries/_format/float.md | 4 ++-- registries/_format/hostname.md | 4 ++-- registries/_format/html.md | 4 ++-- registries/_format/idn-email.md | 4 ++-- registries/_format/idn-hostname.md | 4 ++-- registries/_format/int16.md | 4 ++-- registries/_format/int32.md | 4 ++-- registries/_format/int64.md | 4 ++-- registries/_format/int8.md | 4 ++-- registries/_format/ipv4.md | 4 ++-- registries/_format/ipv6.md | 4 ++-- registries/_format/iri-reference.md | 4 ++-- registries/_format/iri.md | 4 ++-- registries/_format/json-pointer.md | 4 ++-- registries/_format/regex.md | 4 ++-- registries/_format/relative-json-pointer.md | 4 ++-- registries/_format/time.md | 4 ++-- registries/_format/uint8.md | 4 ++-- registries/_format/uri-reference.md | 4 ++-- registries/_format/uri-template.md | 4 ++-- registries/_format/uri.md | 4 ++-- registries/_format/uuid.md | 4 ++-- 33 files changed, 66 insertions(+), 66 deletions(-) diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md index b7f8a302b0..950e0e9b75 100644 --- a/registries/_format/base64url.md +++ b/registries/_format/base64url.md @@ -126,11 +126,11 @@ Using base64url for multipart/form-data parts is not recommended since it artifi {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/binary.md b/registries/_format/binary.md index bf8c366ab4..0b0401988a 100644 --- a/registries/_format/binary.md +++ b/registries/_format/binary.md @@ -89,11 +89,11 @@ content: {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} diff --git a/registries/_format/byte.md b/registries/_format/byte.md index 7cd9cad3f5..730fa1c637 100644 --- a/registries/_format/byte.md +++ b/registries/_format/byte.md @@ -107,11 +107,11 @@ Using byte or base64 for multipart/form-data parts is not recommended since it a {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/char.md b/registries/_format/char.md index 1f89a2a3a0..e61e00d02c 100644 --- a/registries/_format/char.md +++ b/registries/_format/char.md @@ -23,11 +23,11 @@ The `{{page.slug}}` format is a single character. {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/commonmark.md b/registries/_format/commonmark.md index 97aaebdaf1..b9ec91cda4 100644 --- a/registries/_format/commonmark.md +++ b/registries/_format/commonmark.md @@ -23,11 +23,11 @@ The `{{page.slug}}` format represents [CommonMark](https://commonmark.org/) form {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/date-time.md b/registries/_format/date-time.md index 66870f7b20..f6b79694a6 100644 --- a/registries/_format/date-time.md +++ b/registries/_format/date-time.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format represents a date and time as defined by date-time - {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} diff --git a/registries/_format/date.md b/registries/_format/date.md index 3ff32f8bb7..8c2c8431e5 100644 --- a/registries/_format/date.md +++ b/registries/_format/date.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format represents a date as defined by full-date - [RFC3339] {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} diff --git a/registries/_format/decimal.md b/registries/_format/decimal.md index 06613a687e..3618cc0592 100644 --- a/registries/_format/decimal.md +++ b/registries/_format/decimal.md @@ -23,11 +23,11 @@ The `{{page.slug}}` format represents a fixed or floating point decimal number a {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/double.md b/registries/_format/double.md index 6c83d5750f..e4f2a2c7d1 100644 --- a/registries/_format/double.md +++ b/registries/_format/double.md @@ -23,11 +23,11 @@ The `{{page.slug}}` format represents a double precision (64bit) floating point {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/duration.md b/registries/_format/duration.md index f1c43945f0..1d1ec3ac2f 100644 --- a/registries/_format/duration.md +++ b/registries/_format/duration.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format represents a duration as defined by duration - [RFC33 {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} diff --git a/registries/_format/email.md b/registries/_format/email.md index f29fd5d536..d2ac747658 100644 --- a/registries/_format/email.md +++ b/registries/_format/email.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format is an email address as defined as Mailbox in [RFC5321 {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/float.md b/registries/_format/float.md index 0e079b84be..9776b856ca 100644 --- a/registries/_format/float.md +++ b/registries/_format/float.md @@ -23,11 +23,11 @@ The `{{page.slug}}` format represents a single precision (32bit) floating point {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/hostname.md b/registries/_format/hostname.md index 2dadd61696..868be5b496 100644 --- a/registries/_format/hostname.md +++ b/registries/_format/hostname.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format is a host name as defined by RFC1123. {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/html.md b/registries/_format/html.md index f9c84c1d0e..09b600f9d7 100644 --- a/registries/_format/html.md +++ b/registries/_format/html.md @@ -23,11 +23,11 @@ The `{{page.slug}}` format represents HTML-formatted text. {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/idn-email.md b/registries/_format/idn-email.md index 3c1437bcaf..cf9d19391e 100644 --- a/registries/_format/idn-email.md +++ b/registries/_format/idn-email.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format is an email address as defined as Mailbox in [RFC6531 {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/idn-hostname.md b/registries/_format/idn-hostname.md index 7bd6cbe2da..55303b3757 100644 --- a/registries/_format/idn-hostname.md +++ b/registries/_format/idn-hostname.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format is an internationalized host name as defined by [RFC5 {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/int16.md b/registries/_format/int16.md index e7fd808d60..06b6d9c435 100644 --- a/registries/_format/int16.md +++ b/registries/_format/int16.md @@ -23,11 +23,11 @@ The `{{page.slug}}` format represents a signed 16-bit integer, with the range -3 {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/int32.md b/registries/_format/int32.md index 0e0b43c611..dcc8da231a 100644 --- a/registries/_format/int32.md +++ b/registries/_format/int32.md @@ -23,11 +23,11 @@ The `{{page.slug}}` format represents a signed 32-bit integer, with the range {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/int64.md b/registries/_format/int64.md index ef1780dc3a..9885145b12 100644 --- a/registries/_format/int64.md +++ b/registries/_format/int64.md @@ -23,11 +23,11 @@ The `{{page.slug}}` format represents a signed 64-bit integer, with the range -9 {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/int8.md b/registries/_format/int8.md index f497ff564c..2dc562ecff 100644 --- a/registries/_format/int8.md +++ b/registries/_format/int8.md @@ -23,11 +23,11 @@ The `{{page.slug}}` format represents a signed 8-bit integer, with the range -12 {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/ipv4.md b/registries/_format/ipv4.md index 535380fce6..678bdea814 100644 --- a/registries/_format/ipv4.md +++ b/registries/_format/ipv4.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format is an IPv4 address as defined as dotted-quad by RFC26 {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/ipv6.md b/registries/_format/ipv6.md index 7ef26e6d4f..abcc379f08 100644 --- a/registries/_format/ipv6.md +++ b/registries/_format/ipv6.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format is an IPv6 address as defined by RFC4673. {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/iri-reference.md b/registries/_format/iri-reference.md index 99c3726f43..cc3a6aad3f 100644 --- a/registries/_format/iri-reference.md +++ b/registries/_format/iri-reference.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format is a Internationalized Resource Identifier as defined {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/iri.md b/registries/_format/iri.md index 99c3726f43..cc3a6aad3f 100644 --- a/registries/_format/iri.md +++ b/registries/_format/iri.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format is a Internationalized Resource Identifier as defined {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} \ No newline at end of file diff --git a/registries/_format/json-pointer.md b/registries/_format/json-pointer.md index 80bd0ab299..1e0c4ab0f6 100644 --- a/registries/_format/json-pointer.md +++ b/registries/_format/json-pointer.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format is a JSON string representation of a JSON Pointer as {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} diff --git a/registries/_format/regex.md b/registries/_format/regex.md index 4625a758a8..9542978a92 100644 --- a/registries/_format/regex.md +++ b/registries/_format/regex.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format is a regular expression as defined in ECMA-262. {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} diff --git a/registries/_format/relative-json-pointer.md b/registries/_format/relative-json-pointer.md index 5d760888e1..2515b0fa8c 100644 --- a/registries/_format/relative-json-pointer.md +++ b/registries/_format/relative-json-pointer.md @@ -26,11 +26,11 @@ The `{{page.slug}}` format is a JSON string representation of a relative JSON Po {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} diff --git a/registries/_format/time.md b/registries/_format/time.md index 8c22a49ef9..2805f3467d 100644 --- a/registries/_format/time.md +++ b/registries/_format/time.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format represents a time as defined by full-time - [RFC3339] {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} diff --git a/registries/_format/uint8.md b/registries/_format/uint8.md index da6ceed798..a727ca3f7f 100644 --- a/registries/_format/uint8.md +++ b/registries/_format/uint8.md @@ -23,11 +23,11 @@ The `{{page.slug}}` format represents an unsigned 8-bit integer, with the range {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} diff --git a/registries/_format/uri-reference.md b/registries/_format/uri-reference.md index b9ff872f51..a31208f095 100644 --- a/registries/_format/uri-reference.md +++ b/registries/_format/uri-reference.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format is a URI reference as defined in RFC3986. {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} diff --git a/registries/_format/uri-template.md b/registries/_format/uri-template.md index 86cf4500ef..1044ef0455 100644 --- a/registries/_format/uri-template.md +++ b/registries/_format/uri-template.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format is a URI Template as defined in [RFC6570](https://www {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} diff --git a/registries/_format/uri.md b/registries/_format/uri.md index 4003147eaa..c30b2caed9 100644 --- a/registries/_format/uri.md +++ b/registries/_format/uri.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format is a Uniform Resource Identifier as defined in RFC398 {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} diff --git a/registries/_format/uuid.md b/registries/_format/uuid.md index 3e67c49510..c1436f7024 100644 --- a/registries/_format/uuid.md +++ b/registries/_format/uuid.md @@ -24,11 +24,11 @@ The `{{page.slug}}` format a Universally Unique IDentifier as defined in [RFC412 {% if page.oas_version %} ### OpenAPI Specification version -#{{ page.oas_version }} +{{ page.oas_version }} {% endif %} {% if page.remarks %} ### Remarks -#{{ page.remarks }} +{{ page.remarks }} {% endif %} From a3579e7af51ed709314f3872d27d47cb26855eaa Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Fri, 24 Feb 2023 08:19:57 -0500 Subject: [PATCH 35/53] - adds links to base64 RFC Signed-off-by: Vincent Biret --- registries/_format/base64url.md | 2 +- registries/_format/byte.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md index 950e0e9b75..bd8349a304 100644 --- a/registries/_format/base64url.md +++ b/registries/_format/base64url.md @@ -1,7 +1,7 @@ --- owner: baywet issue: -description: A url-safe binary array as defined in RFC4648 +description: A url-safe binary array as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-5) base_type: string layout: default oas_version: < 3.1 diff --git a/registries/_format/byte.md b/registries/_format/byte.md index 730fa1c637..c3bcec9659 100644 --- a/registries/_format/byte.md +++ b/registries/_format/byte.md @@ -1,7 +1,7 @@ --- owner: DarrelMiller issue: -description: base64 encoded characters +description: base64 encoded characters as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-4) base_type: string layout: default oas_version: < 3.1 @@ -14,7 +14,7 @@ remarks: "When using OpenAPI 3.1 or above it's recommended not to use this forma Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents any sequence of octets encoded as a base64 string. This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). +The `{{page.slug}}` format represents any sequence of octets encoded as a base64 string as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-4). This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). ### Upgrading from < 3.1 to >= 3.1 From 02c4736d4e8df5a0316c0e615b1d866ed8c32e7b Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 27 Feb 2023 10:18:47 -0500 Subject: [PATCH 36/53] - first batch of review suggestions Co-authored-by: Ralf Handl --- registries/_format/base64url.md | 8 +++++--- registries/_format/binary.md | 4 ++-- registries/_format/byte.md | 2 +- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md index bd8349a304..526b7458c5 100644 --- a/registries/_format/base64url.md +++ b/registries/_format/base64url.md @@ -31,7 +31,7 @@ paths: image/png: schema: type: string - format: byte + format: base64url #OAS 3.1 paths: @@ -42,7 +42,7 @@ paths: content: image/png: type: string - contentEncoding: base64 + contentEncoding: base64url ``` #### Encoded property as part of a structured response @@ -57,6 +57,7 @@ paths: content: application/json: schema: + type: object properties: width: schema: @@ -77,6 +78,7 @@ paths: content: application/json: schema: + type: object properties: width: schema: @@ -101,7 +103,7 @@ parameters: image/png: schema: type: string - format: byte + format: base64url #OAS 3.1 parameters: diff --git a/registries/_format/binary.md b/registries/_format/binary.md index 0b0401988a..294a9f854c 100644 --- a/registries/_format/binary.md +++ b/registries/_format/binary.md @@ -46,11 +46,11 @@ paths: #### Encoded property as part of a structured response -Using the binary format as part of a structured response for a property or an array is invalid. The only exception is for `multipart/form-data` content. +Using the binary format as part of a structured response for a property or an array is invalid. Use `multipart/form-data` content instead. #### Query or Path parameters -Using the binary format query or path parameters is invalid. +Using the binary format for query or path parameters is invalid. #### Multipart/form-data diff --git a/registries/_format/byte.md b/registries/_format/byte.md index c3bcec9659..8786c0f005 100644 --- a/registries/_format/byte.md +++ b/registries/_format/byte.md @@ -1,7 +1,7 @@ --- owner: DarrelMiller issue: -description: base64 encoded characters as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-4) +description: base64 encoded data as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-4) base_type: string layout: default oas_version: < 3.1 From 6d465a777b9761d0b5637d3976ed036cee8fac9e Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 27 Feb 2023 10:29:14 -0500 Subject: [PATCH 37/53] - second batch of PR feedback Co-authored-by: Darrel --- registries/_format/base64url.md | 6 +++--- registries/_format/uri.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md index 526b7458c5..ca3bfce3a4 100644 --- a/registries/_format/base64url.md +++ b/registries/_format/base64url.md @@ -1,11 +1,11 @@ --- owner: baywet issue: -description: A url-safe binary array as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-5) +description: Binary data encoded as a url-safe string as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-5) base_type: string layout: default oas_version: < 3.1 -remarks: "When using OpenAPI 3.1 or above it's recommended not to use this format and instead use [`contentEncoding` with a value of `base64url`](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentencoding)." +remarks: "When using OpenAPI 3.1 it's recommended not to use this format and instead use [`contentEncoding` with a value of `base64url`](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentencoding)." --- # {{ page.collection }} @@ -14,7 +14,7 @@ remarks: "When using OpenAPI 3.1 or above it's recommended not to use this forma Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format is a url-safe binary array as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-5). +The `{{page.slug}}` format is binary data encoded as a url-safe string as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-5). ### Upgrading from < 3.1 to >= 3.1 diff --git a/registries/_format/uri.md b/registries/_format/uri.md index c30b2caed9..ed85b9d562 100644 --- a/registries/_format/uri.md +++ b/registries/_format/uri.md @@ -13,7 +13,7 @@ source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-r Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format is a Uniform Resource Identifier as defined in RFC3986. +The `{{page.slug}}` format is a Uniform Resource Identifier as defined in [RFC3986](https://www.rfc-editor.org/rfc/rfc3986.html). {% if page.issue %} ### GitHub Issue From fda1091c35b4696c23bfb6671cd6f1bdf75a36aa Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 27 Feb 2023 10:42:22 -0500 Subject: [PATCH 38/53] - third batch of PR review suggestions Signed-off-by: Vincent Biret --- registries/_format/base64url.md | 4 +++- registries/_format/binary.md | 2 +- registries/_format/byte.md | 8 +++++--- registries/_format/date-time.md | 4 ++-- registries/_format/date.md | 4 ++-- 5 files changed, 13 insertions(+), 9 deletions(-) diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md index ca3bfce3a4..e27dc03e09 100644 --- a/registries/_format/base64url.md +++ b/registries/_format/base64url.md @@ -20,6 +20,8 @@ The `{{page.slug}}` format is binary data encoded as a url-safe string as define #### Entire response body +> Note: Encoding a binary message body to a string is not necessary in HTTP, and will increase the size by 33% to 300%. + ```yaml #OAS 3.0 paths: @@ -117,7 +119,7 @@ parameters: #### Multipart/form-data -Using base64url for multipart/form-data parts is not recommended since it artificially inflates the payload size with not added value. +Encoding a binary part to a string is not necessary for multipart/form-data, and will increase the size by 33% to 300%. {% if page.issue %} ### GitHub Issue diff --git a/registries/_format/binary.md b/registries/_format/binary.md index 294a9f854c..8d5d57a084 100644 --- a/registries/_format/binary.md +++ b/registries/_format/binary.md @@ -5,7 +5,7 @@ description: any sequence of octets base_type: string layout: default oas_version: < 3.1 -remarks: "When using OpenAPI 3.1 or above it's recommended not to use this format and instead set the `mediaType` to `application/octet-stream`, `image/png`,... without a `schema` property. This format MUST ONLY be used for schemas that represent the whole request/response body and MUST NOT be used for properties, arrays, etc..." +remarks: "In OpenAPI 3.1, instead set the media type appropriately and do not use a schema property. Note that only complete HTTP message bodies or complete parts in a multipart media type can accommodate binary data. JSON strings and URL path components cannot." --- # {{ page.collection }} diff --git a/registries/_format/byte.md b/registries/_format/byte.md index 8786c0f005..7432bb949b 100644 --- a/registries/_format/byte.md +++ b/registries/_format/byte.md @@ -5,7 +5,7 @@ description: base64 encoded data as defined in [RFC4648](https://www.rfc-editor. base_type: string layout: default oas_version: < 3.1 -remarks: "When using OpenAPI 3.1 or above it's recommended not to use this format and instead use [`contentEncoding` with a value of `base64`](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentencoding)." +remarks: "In OpenAPI 3.1, instead use [`contentEncoding: base64url`](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentencoding), optionally alongside [contentMediaType](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentmediatype)." --- # {{ page.collection }} @@ -20,6 +20,8 @@ The `{{page.slug}}` format represents any sequence of octets encoded as a base64 #### Entire response body +> Note: Encoding a binary message body to a string is not necessary in HTTP, and will increase the size by 33% to 300%. + ```yaml #OAS 3.0 paths: @@ -92,11 +94,11 @@ paths: #### Query or Path parameters -Using byte or base64 for path or query parameters is not recommended since this encoding makes use of characters that are not URL safe. +Data encoded using byte or base64 will require URL percent-encoding before it can be used in a path or query parameter. Use base64url instead to avoid this problem. #### Multipart/form-data -Using byte or base64 for multipart/form-data parts is not recommended since it artificially inflates the payload size with not added value. +Encoding a binary part to a string is not necessary for multipart/form-data, and will increase the size by 33% to 300%. {% if page.issue %} ### GitHub Issue diff --git a/registries/_format/date-time.md b/registries/_format/date-time.md index f6b79694a6..296f1e5a0d 100644 --- a/registries/_format/date-time.md +++ b/registries/_format/date-time.md @@ -1,7 +1,7 @@ --- owner: DarrelMiller issue: -description: date and time as defined by date-time - RFC3339 +description: date and time as defined by date-time - [RFC3339](https://www.rfc-editor.org/rfc/rfc3339#section-5.6) base_type: string layout: default source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-dates-times-and-duration @@ -13,7 +13,7 @@ source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-d Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents a date and time as defined by date-time - [RFC3339](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339#anchor14one). This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). +The `{{page.slug}}` format represents a date and time as defined by date-time - [RFC3339](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). {% if page.issue %} ### GitHub Issue diff --git a/registries/_format/date.md b/registries/_format/date.md index 8c2c8431e5..c3ddef2760 100644 --- a/registries/_format/date.md +++ b/registries/_format/date.md @@ -1,7 +1,7 @@ --- owner: DarrelMiller issue: -description: date as defined by full-date - RFC3339 +description: date as defined by full-date - [RFC3339](https://www.rfc-editor.org/rfc/rfc3339#section-5.6) base_type: string layout: default source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-dates-times-and-duration @@ -13,7 +13,7 @@ source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-d Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents a date as defined by full-date - [RFC3339](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339#anchor14one). This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). +The `{{page.slug}}` format represents a date as defined by full-date - [RFC3339](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). {% if page.issue %} ### GitHub Issue From bafc2714136a9f8184c072f7fd5940bb0da4aded Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Wed, 1 Mar 2023 15:32:41 -0500 Subject: [PATCH 39/53] - moves and renames version column for formats Signed-off-by: Vincent Biret --- registry/format.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/registry/format.md b/registry/format.md index 300139e29f..41511772a3 100644 --- a/registry/format.md +++ b/registry/format.md @@ -11,8 +11,8 @@ Please raise a [Pull-Request](https://github.com/OAI/OpenAPI-Specification/pulls ## Values -|Value|Description|Type|OpenAPI Version|Source|Remarks| +|Value|Description|Type|Source|OAS Version|Remarks| |---|---|----|---|---|----| -{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type }} | {{ value.oas_version }} | {% if value.source %}Open{% endif %} | {{ value.remarks }} | +{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type }} | {% if value.source %}Open{% endif %} | {{ value.oas_version }} | {{ value.remarks }} | {% endfor %} From b9cc7e539917cd7dd690b18554a8a9412058a279 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Wed, 1 Mar 2023 15:35:09 -0500 Subject: [PATCH 40/53] - adds password format Signed-off-by: Vincent Biret --- registries/_format/password.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 registries/_format/password.md diff --git a/registries/_format/password.md b/registries/_format/password.md new file mode 100644 index 0000000000..05f2a2a38d --- /dev/null +++ b/registries/_format/password.md @@ -0,0 +1,33 @@ +--- +owner: baywet +issue: +description: a string that hints to UIs to obscure input. +base_type: string +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is a string that hints to UIs to obscure input. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.oas_version %} +### OpenAPI Specification version + +{{ page.oas_version }} +{% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} \ No newline at end of file From 05dde66a615eba37109d45795e15243c019dc74d Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Wed, 1 Mar 2023 15:39:03 -0500 Subject: [PATCH 41/53] - adds a source label for formats Signed-off-by: Vincent Biret --- registries/_format/date-time.md | 1 + registries/_format/date.md | 1 + registries/_format/duration.md | 1 + registries/_format/email.md | 1 + registries/_format/hostname.md | 1 + registries/_format/idn-email.md | 3 ++- registries/_format/idn-hostname.md | 1 + registries/_format/ipv4.md | 1 + registries/_format/ipv6.md | 1 + registries/_format/iri-reference.md | 1 + registries/_format/iri.md | 1 + registries/_format/json-pointer.md | 1 + registries/_format/regex.md | 1 + registries/_format/relative-json-pointer.md | 1 + registries/_format/time.md | 1 + registries/_format/uri-reference.md | 1 + registries/_format/uri-template.md | 1 + registries/_format/uri.md | 1 + registries/_format/uuid.md | 1 + registry/format.md | 2 +- 20 files changed, 21 insertions(+), 2 deletions(-) diff --git a/registries/_format/date-time.md b/registries/_format/date-time.md index 296f1e5a0d..bafd87034d 100644 --- a/registries/_format/date-time.md +++ b/registries/_format/date-time.md @@ -4,6 +4,7 @@ issue: description: date and time as defined by date-time - [RFC3339](https://www.rfc-editor.org/rfc/rfc3339#section-5.6) base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-dates-times-and-duration --- diff --git a/registries/_format/date.md b/registries/_format/date.md index c3ddef2760..7bfe47182f 100644 --- a/registries/_format/date.md +++ b/registries/_format/date.md @@ -4,6 +4,7 @@ issue: description: date as defined by full-date - [RFC3339](https://www.rfc-editor.org/rfc/rfc3339#section-5.6) base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-dates-times-and-duration --- diff --git a/registries/_format/duration.md b/registries/_format/duration.md index 1d1ec3ac2f..a6c6ef44be 100644 --- a/registries/_format/duration.md +++ b/registries/_format/duration.md @@ -4,6 +4,7 @@ issue: description: duration as defined by duration - RFC3339 base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-dates-times-and-duration --- diff --git a/registries/_format/email.md b/registries/_format/email.md index d2ac747658..12f471c970 100644 --- a/registries/_format/email.md +++ b/registries/_format/email.md @@ -4,6 +4,7 @@ issue: description: An email address as defined as Mailbox in RFC5321 base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-email-addresses --- diff --git a/registries/_format/hostname.md b/registries/_format/hostname.md index 868be5b496..eb85129903 100644 --- a/registries/_format/hostname.md +++ b/registries/_format/hostname.md @@ -4,6 +4,7 @@ issue: description: A host name as defined by RFC1123 base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-hostnames --- diff --git a/registries/_format/idn-email.md b/registries/_format/idn-email.md index cf9d19391e..269cf148a4 100644 --- a/registries/_format/idn-email.md +++ b/registries/_format/idn-email.md @@ -4,7 +4,8 @@ issue: description: An email address as defined as Mailbox in RFC6531 base_type: string layout: default -source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-email-addresses +source_label: JSON Schema + https://json-schema.org/draft/2020-12/json-schema-validation.html#name-email-addresses --- # {{ page.collection }} diff --git a/registries/_format/idn-hostname.md b/registries/_format/idn-hostname.md index 55303b3757..f1992cd3f6 100644 --- a/registries/_format/idn-hostname.md +++ b/registries/_format/idn-hostname.md @@ -4,6 +4,7 @@ issue: description: An internationalized host name as defined by RFC5890 base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-hostnames --- diff --git a/registries/_format/ipv4.md b/registries/_format/ipv4.md index 678bdea814..f544532ff8 100644 --- a/registries/_format/ipv4.md +++ b/registries/_format/ipv4.md @@ -4,6 +4,7 @@ issue: description: An IPv4 address as defined as dotted-quad by RFC2673 base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-ip-addresses --- diff --git a/registries/_format/ipv6.md b/registries/_format/ipv6.md index abcc379f08..31c4a7678f 100644 --- a/registries/_format/ipv6.md +++ b/registries/_format/ipv6.md @@ -4,6 +4,7 @@ issue: description: An IPv6 address as defined by RFC4673 base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-ip-addresses --- diff --git a/registries/_format/iri-reference.md b/registries/_format/iri-reference.md index cc3a6aad3f..c017e5d3e3 100644 --- a/registries/_format/iri-reference.md +++ b/registries/_format/iri-reference.md @@ -4,6 +4,7 @@ issue: description: A Internationalized Resource Identifier as defined in RFC3987 base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers --- diff --git a/registries/_format/iri.md b/registries/_format/iri.md index cc3a6aad3f..c017e5d3e3 100644 --- a/registries/_format/iri.md +++ b/registries/_format/iri.md @@ -4,6 +4,7 @@ issue: description: A Internationalized Resource Identifier as defined in RFC3987 base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers --- diff --git a/registries/_format/json-pointer.md b/registries/_format/json-pointer.md index 1e0c4ab0f6..09367926bd 100644 --- a/registries/_format/json-pointer.md +++ b/registries/_format/json-pointer.md @@ -4,6 +4,7 @@ issue: description: A JSON string representation of a JSON Pointer as defined in RFC6901 base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-json-pointers --- diff --git a/registries/_format/regex.md b/registries/_format/regex.md index 9542978a92..5e22af153c 100644 --- a/registries/_format/regex.md +++ b/registries/_format/regex.md @@ -4,6 +4,7 @@ issue: description: A regular expression as defined in ECMA-262 base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-regex --- diff --git a/registries/_format/relative-json-pointer.md b/registries/_format/relative-json-pointer.md index 2515b0fa8c..13b216c891 100644 --- a/registries/_format/relative-json-pointer.md +++ b/registries/_format/relative-json-pointer.md @@ -4,6 +4,7 @@ issue: description: A JSON string representation of a relative JSON Pointer as defined in draft RFC 01 base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-json-pointers --- diff --git a/registries/_format/time.md b/registries/_format/time.md index 2805f3467d..8a8f2cdccc 100644 --- a/registries/_format/time.md +++ b/registries/_format/time.md @@ -4,6 +4,7 @@ issue: description: time as defined by full-time - RFC3339 base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-dates-times-and-duration --- diff --git a/registries/_format/uri-reference.md b/registries/_format/uri-reference.md index a31208f095..7ee90f00e0 100644 --- a/registries/_format/uri-reference.md +++ b/registries/_format/uri-reference.md @@ -4,6 +4,7 @@ issue: description: A URI reference as defined in RFC3986 base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers --- diff --git a/registries/_format/uri-template.md b/registries/_format/uri-template.md index 1044ef0455..bebda3bcb6 100644 --- a/registries/_format/uri-template.md +++ b/registries/_format/uri-template.md @@ -4,6 +4,7 @@ issue: description: A URI Template as defined in RFC6570 base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-uri-template --- diff --git a/registries/_format/uri.md b/registries/_format/uri.md index ed85b9d562..a99b64abcf 100644 --- a/registries/_format/uri.md +++ b/registries/_format/uri.md @@ -4,6 +4,7 @@ issue: description: A Uniform Resource Identifier as defined in RFC3986 base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers --- diff --git a/registries/_format/uuid.md b/registries/_format/uuid.md index c1436f7024..130ce47406 100644 --- a/registries/_format/uuid.md +++ b/registries/_format/uuid.md @@ -4,6 +4,7 @@ issue: description: A Universally Unique IDentifier as defined in RFC4122 base_type: string layout: default +source_label: JSON Schema source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers --- diff --git a/registry/format.md b/registry/format.md index 41511772a3..8f660b2847 100644 --- a/registry/format.md +++ b/registry/format.md @@ -13,6 +13,6 @@ Please raise a [Pull-Request](https://github.com/OAI/OpenAPI-Specification/pulls |Value|Description|Type|Source|OAS Version|Remarks| |---|---|----|---|---|----| -{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type }} | {% if value.source %}Open{% endif %} | {{ value.oas_version }} | {{ value.remarks }} | +{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type }} | {% if value.source %}{% if value.source_label %}{{value.source_label}}{% else %}Open{% endif %}{% endif %} | {{ value.oas_version }} | {{ value.remarks }} | {% endfor %} From 21cd16ad9511416909fb2902e694ae9be6845d63 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Fri, 3 Mar 2023 12:38:51 -0500 Subject: [PATCH 42/53] - removes examples from registry entries Signed-off-by: Vincent Biret --- registries/_format/base64url.md | 105 -------------------------------- registries/_format/binary.md | 64 ------------------- registries/_format/byte.md | 84 ------------------------- 3 files changed, 253 deletions(-) diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md index e27dc03e09..b422eebe1b 100644 --- a/registries/_format/base64url.md +++ b/registries/_format/base64url.md @@ -16,111 +16,6 @@ Base type: `{{ page.base_type }}`. The `{{page.slug}}` format is binary data encoded as a url-safe string as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-5). -### Upgrading from < 3.1 to >= 3.1 - -#### Entire response body - -> Note: Encoding a binary message body to a string is not necessary in HTTP, and will increase the size by 33% to 300%. - -```yaml -#OAS 3.0 -paths: - '/picture': - get: - responses: - '200': - content: - image/png: - schema: - type: string - format: base64url - -#OAS 3.1 -paths: - '/picture': - get: - responses: - '200': - content: - image/png: - type: string - contentEncoding: base64url -``` - -#### Encoded property as part of a structured response - -```yaml -#OAS 3.0 -paths: - '/picture': - get: - responses: - '200': - content: - application/json: - schema: - type: object - properties: - width: - schema: - type: string - height: - schema: - type: string - image: - type: string - format: base64url - -#OAS 3.1 -paths: - '/picture': - get: - responses: - '200': - content: - application/json: - schema: - type: object - properties: - width: - schema: - type: string - height: - schema: - type: string - image: - type: string - contentMediaType: image/png - contentEncoding: base64url -``` - -#### Query or Path parameters - -```yaml -#OAS 3.0 -parameters: - - name: anImage - in: query - content: - image/png: - schema: - type: string - format: base64url - -#OAS 3.1 -parameters: - - name: anImage - in: query - schema: - type: string - contentMediaType: image/png - contentEncoding: base64url -``` - -#### Multipart/form-data - -Encoding a binary part to a string is not necessary for multipart/form-data, and will increase the size by 33% to 300%. - {% if page.issue %} ### GitHub Issue diff --git a/registries/_format/binary.md b/registries/_format/binary.md index 8d5d57a084..9bb1bccc26 100644 --- a/registries/_format/binary.md +++ b/registries/_format/binary.md @@ -16,70 +16,6 @@ Base type: `{{ page.base_type }}`. The `{{page.slug}}` format represents any sequence of octets. This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). -### Upgrading from < 3.1 to >= 3.1 - -#### Entire response body - -```yaml -#OAS 3.0 -paths: - '/picture': - get: - responses: - '200': - content: - image/png: - schema: - type: string - format: binary - -#OAS 3.1 -paths: - '/picture': - get: - responses: - '200': - content: - image/png: - schema: true #optional, some linters require a schema property -``` - -#### Encoded property as part of a structured response - -Using the binary format as part of a structured response for a property or an array is invalid. Use `multipart/form-data` content instead. - -#### Query or Path parameters - -Using the binary format for query or path parameters is invalid. - -#### Multipart/form-data - -```yaml -#OAS 3.0 -content: - multipart/form-data: - schema: - type: object - properties: - anImage: - type: string - format: binary - encoding: - anImage: - contentType: image/png - -# OAS 3.1 -content: - multipart/form-data: - schema: - type: object - properties: - anImage: {} - encoding: - anImage: - contentType: image/png -``` - {% if page.issue %} ### GitHub Issue diff --git a/registries/_format/byte.md b/registries/_format/byte.md index 7432bb949b..09eb4a4ff3 100644 --- a/registries/_format/byte.md +++ b/registries/_format/byte.md @@ -16,90 +16,6 @@ Base type: `{{ page.base_type }}`. The `{{page.slug}}` format represents any sequence of octets encoded as a base64 string as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-4). This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). -### Upgrading from < 3.1 to >= 3.1 - -#### Entire response body - -> Note: Encoding a binary message body to a string is not necessary in HTTP, and will increase the size by 33% to 300%. - -```yaml -#OAS 3.0 -paths: - '/picture': - get: - responses: - '200': - content: - image/png: - schema: - type: string - format: byte - -#OAS 3.1 -paths: - '/picture': - get: - responses: - '200': - content: - image/png: - type: string - contentEncoding: base64 -``` - -#### Encoded property as part of a structured response - -```yaml -#OAS 3.0 -paths: - '/picture': - get: - responses: - '200': - content: - application/json: - schema: - properties: - width: - schema: - type: string - height: - schema: - type: string - image: - type: string - format: byte - -#OAS 3.1 -paths: - '/picture': - get: - responses: - '200': - content: - application/json: - schema: - properties: - width: - schema: - type: string - height: - schema: - type: string - image: - type: string - contentMediaType: image/png - contentEncoding: base64 -``` - -#### Query or Path parameters - -Data encoded using byte or base64 will require URL percent-encoding before it can be used in a path or query parameter. Use base64url instead to avoid this problem. - -#### Multipart/form-data - -Encoding a binary part to a string is not necessary for multipart/form-data, and will increase the size by 33% to 300%. - {% if page.issue %} ### GitHub Issue From df38fa530e9babfaf87f3fe94b8c14800289ba8e Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Fri, 3 Mar 2023 12:41:52 -0500 Subject: [PATCH 43/53] - removes remarks column in formats Signed-off-by: Vincent Biret --- registry/format.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/registry/format.md b/registry/format.md index 8f660b2847..9ce86f974f 100644 --- a/registry/format.md +++ b/registry/format.md @@ -11,8 +11,8 @@ Please raise a [Pull-Request](https://github.com/OAI/OpenAPI-Specification/pulls ## Values -|Value|Description|Type|Source|OAS Version|Remarks| +|Value|Description|Type|Source|OAS Version| |---|---|----|---|---|----| -{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type }} | {% if value.source %}{% if value.source_label %}{{value.source_label}}{% else %}Open{% endif %}{% endif %} | {{ value.oas_version }} | {{ value.remarks }} | +{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type }} | {% if value.source %}{% if value.source_label %}{{value.source_label}}{% else %}Open{% endif %}{% endif %} | {{ value.oas_version }} | {% endfor %} From 96e06658e7157f5f8eba7cf20762669bfc464ef7 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Fri, 3 Mar 2023 13:22:35 -0500 Subject: [PATCH 44/53] - renames oas version to deprecated version Signed-off-by: Vincent Biret --- registries/_format/base64url.md | 8 ++++---- registries/_format/binary.md | 8 ++++---- registries/_format/byte.md | 8 ++++---- registries/_format/char.md | 6 +++--- registries/_format/commonmark.md | 6 +++--- registries/_format/date-time.md | 6 +++--- registries/_format/date.md | 6 +++--- registries/_format/decimal.md | 6 +++--- registries/_format/double.md | 6 +++--- registries/_format/duration.md | 6 +++--- registries/_format/email.md | 6 +++--- registries/_format/float.md | 6 +++--- registries/_format/hostname.md | 6 +++--- registries/_format/html.md | 6 +++--- registries/_format/idn-email.md | 6 +++--- registries/_format/idn-hostname.md | 6 +++--- registries/_format/int16.md | 6 +++--- registries/_format/int32.md | 6 +++--- registries/_format/int64.md | 6 +++--- registries/_format/int8.md | 6 +++--- registries/_format/ipv4.md | 6 +++--- registries/_format/ipv6.md | 6 +++--- registries/_format/iri-reference.md | 6 +++--- registries/_format/iri.md | 6 +++--- registries/_format/json-pointer.md | 6 +++--- registries/_format/password.md | 6 +++--- registries/_format/regex.md | 6 +++--- registries/_format/relative-json-pointer.md | 6 +++--- registries/_format/time.md | 6 +++--- registries/_format/uint8.md | 6 +++--- registries/_format/uri-reference.md | 6 +++--- registries/_format/uri-template.md | 6 +++--- registries/_format/uri.md | 6 +++--- registries/_format/uuid.md | 6 +++--- registry/format.md | 4 ++-- 35 files changed, 107 insertions(+), 107 deletions(-) diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md index b422eebe1b..553a9ae35b 100644 --- a/registries/_format/base64url.md +++ b/registries/_format/base64url.md @@ -4,7 +4,7 @@ issue: description: Binary data encoded as a url-safe string as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-5) base_type: string layout: default -oas_version: < 3.1 +deprecated_version: '3.1' remarks: "When using OpenAPI 3.1 it's recommended not to use this format and instead use [`contentEncoding` with a value of `base64url`](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentencoding)." --- @@ -22,10 +22,10 @@ The `{{page.slug}}` format is binary data encoded as a url-safe string as define * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/binary.md b/registries/_format/binary.md index 9bb1bccc26..b992cd61bb 100644 --- a/registries/_format/binary.md +++ b/registries/_format/binary.md @@ -4,7 +4,7 @@ issue: description: any sequence of octets base_type: string layout: default -oas_version: < 3.1 +deprecated_version: '3.1' remarks: "In OpenAPI 3.1, instead set the media type appropriately and do not use a schema property. Note that only complete HTTP message bodies or complete parts in a multipart media type can accommodate binary data. JSON strings and URL path components cannot." --- @@ -22,10 +22,10 @@ The `{{page.slug}}` format represents any sequence of octets. This format entry * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/byte.md b/registries/_format/byte.md index 09eb4a4ff3..26e9ee2ecd 100644 --- a/registries/_format/byte.md +++ b/registries/_format/byte.md @@ -4,7 +4,7 @@ issue: description: base64 encoded data as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-4) base_type: string layout: default -oas_version: < 3.1 +deprecated_version: '3.1' remarks: "In OpenAPI 3.1, instead use [`contentEncoding: base64url`](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentencoding), optionally alongside [contentMediaType](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentmediatype)." --- @@ -22,10 +22,10 @@ The `{{page.slug}}` format represents any sequence of octets encoded as a base64 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/char.md b/registries/_format/char.md index e61e00d02c..f73a2d9cb5 100644 --- a/registries/_format/char.md +++ b/registries/_format/char.md @@ -20,10 +20,10 @@ The `{{page.slug}}` format is a single character. * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/commonmark.md b/registries/_format/commonmark.md index b9ec91cda4..ff480abd73 100644 --- a/registries/_format/commonmark.md +++ b/registries/_format/commonmark.md @@ -20,10 +20,10 @@ The `{{page.slug}}` format represents [CommonMark](https://commonmark.org/) form * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/date-time.md b/registries/_format/date-time.md index bafd87034d..4c9fa1b02f 100644 --- a/registries/_format/date-time.md +++ b/registries/_format/date-time.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format represents a date and time as defined by date-time - * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/date.md b/registries/_format/date.md index 7bfe47182f..646fc99f67 100644 --- a/registries/_format/date.md +++ b/registries/_format/date.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format represents a date as defined by full-date - [RFC3339] * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/decimal.md b/registries/_format/decimal.md index 3618cc0592..8347f313bf 100644 --- a/registries/_format/decimal.md +++ b/registries/_format/decimal.md @@ -20,10 +20,10 @@ The `{{page.slug}}` format represents a fixed or floating point decimal number a * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/double.md b/registries/_format/double.md index e4f2a2c7d1..c345ffbbc8 100644 --- a/registries/_format/double.md +++ b/registries/_format/double.md @@ -20,10 +20,10 @@ The `{{page.slug}}` format represents a double precision (64bit) floating point * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/duration.md b/registries/_format/duration.md index a6c6ef44be..cf3435798c 100644 --- a/registries/_format/duration.md +++ b/registries/_format/duration.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format represents a duration as defined by duration - [RFC33 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/email.md b/registries/_format/email.md index 12f471c970..e2c475de46 100644 --- a/registries/_format/email.md +++ b/registries/_format/email.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format is an email address as defined as Mailbox in [RFC5321 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/float.md b/registries/_format/float.md index 9776b856ca..2617c66b01 100644 --- a/registries/_format/float.md +++ b/registries/_format/float.md @@ -20,10 +20,10 @@ The `{{page.slug}}` format represents a single precision (32bit) floating point * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/hostname.md b/registries/_format/hostname.md index eb85129903..881274489c 100644 --- a/registries/_format/hostname.md +++ b/registries/_format/hostname.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format is a host name as defined by RFC1123. * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/html.md b/registries/_format/html.md index 09b600f9d7..d79e5473d6 100644 --- a/registries/_format/html.md +++ b/registries/_format/html.md @@ -20,10 +20,10 @@ The `{{page.slug}}` format represents HTML-formatted text. * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/idn-email.md b/registries/_format/idn-email.md index 269cf148a4..684ec00e8d 100644 --- a/registries/_format/idn-email.md +++ b/registries/_format/idn-email.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format is an email address as defined as Mailbox in [RFC6531 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/idn-hostname.md b/registries/_format/idn-hostname.md index f1992cd3f6..3cc3df9311 100644 --- a/registries/_format/idn-hostname.md +++ b/registries/_format/idn-hostname.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format is an internationalized host name as defined by [RFC5 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/int16.md b/registries/_format/int16.md index 06b6d9c435..234bf7955f 100644 --- a/registries/_format/int16.md +++ b/registries/_format/int16.md @@ -20,10 +20,10 @@ The `{{page.slug}}` format represents a signed 16-bit integer, with the range -3 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/int32.md b/registries/_format/int32.md index dcc8da231a..1f225471db 100644 --- a/registries/_format/int32.md +++ b/registries/_format/int32.md @@ -20,10 +20,10 @@ The `{{page.slug}}` format represents a signed 32-bit integer, with the range * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/int64.md b/registries/_format/int64.md index 9885145b12..7cd4831c60 100644 --- a/registries/_format/int64.md +++ b/registries/_format/int64.md @@ -20,10 +20,10 @@ The `{{page.slug}}` format represents a signed 64-bit integer, with the range -9 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/int8.md b/registries/_format/int8.md index 2dc562ecff..36a084503d 100644 --- a/registries/_format/int8.md +++ b/registries/_format/int8.md @@ -20,10 +20,10 @@ The `{{page.slug}}` format represents a signed 8-bit integer, with the range -12 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/ipv4.md b/registries/_format/ipv4.md index f544532ff8..5b28dcec36 100644 --- a/registries/_format/ipv4.md +++ b/registries/_format/ipv4.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format is an IPv4 address as defined as dotted-quad by RFC26 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/ipv6.md b/registries/_format/ipv6.md index 31c4a7678f..37e601ab59 100644 --- a/registries/_format/ipv6.md +++ b/registries/_format/ipv6.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format is an IPv6 address as defined by RFC4673. * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/iri-reference.md b/registries/_format/iri-reference.md index c017e5d3e3..c4a21bc518 100644 --- a/registries/_format/iri-reference.md +++ b/registries/_format/iri-reference.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format is a Internationalized Resource Identifier as defined * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/iri.md b/registries/_format/iri.md index c017e5d3e3..c4a21bc518 100644 --- a/registries/_format/iri.md +++ b/registries/_format/iri.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format is a Internationalized Resource Identifier as defined * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/json-pointer.md b/registries/_format/json-pointer.md index 09367926bd..3714d23bff 100644 --- a/registries/_format/json-pointer.md +++ b/registries/_format/json-pointer.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format is a JSON string representation of a JSON Pointer as * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/password.md b/registries/_format/password.md index 05f2a2a38d..7269dbab08 100644 --- a/registries/_format/password.md +++ b/registries/_format/password.md @@ -20,10 +20,10 @@ The `{{page.slug}}` format is a string that hints to UIs to obscure input. * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/regex.md b/registries/_format/regex.md index 5e22af153c..732129eebe 100644 --- a/registries/_format/regex.md +++ b/registries/_format/regex.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format is a regular expression as defined in ECMA-262. * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/relative-json-pointer.md b/registries/_format/relative-json-pointer.md index 13b216c891..50ad9dd425 100644 --- a/registries/_format/relative-json-pointer.md +++ b/registries/_format/relative-json-pointer.md @@ -24,10 +24,10 @@ The `{{page.slug}}` format is a JSON string representation of a relative JSON Po * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/time.md b/registries/_format/time.md index 8a8f2cdccc..344ccdde34 100644 --- a/registries/_format/time.md +++ b/registries/_format/time.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format represents a time as defined by full-time - [RFC3339] * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/uint8.md b/registries/_format/uint8.md index a727ca3f7f..1f3d9ea945 100644 --- a/registries/_format/uint8.md +++ b/registries/_format/uint8.md @@ -20,10 +20,10 @@ The `{{page.slug}}` format represents an unsigned 8-bit integer, with the range * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/uri-reference.md b/registries/_format/uri-reference.md index 7ee90f00e0..f586e0a39f 100644 --- a/registries/_format/uri-reference.md +++ b/registries/_format/uri-reference.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format is a URI reference as defined in RFC3986. * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/uri-template.md b/registries/_format/uri-template.md index bebda3bcb6..19095cb085 100644 --- a/registries/_format/uri-template.md +++ b/registries/_format/uri-template.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format is a URI Template as defined in [RFC6570](https://www * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/uri.md b/registries/_format/uri.md index a99b64abcf..33cf4c90c0 100644 --- a/registries/_format/uri.md +++ b/registries/_format/uri.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format is a Uniform Resource Identifier as defined in [RFC39 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registries/_format/uuid.md b/registries/_format/uuid.md index 130ce47406..9316c67f39 100644 --- a/registries/_format/uuid.md +++ b/registries/_format/uuid.md @@ -22,10 +22,10 @@ The `{{page.slug}}` format a Universally Unique IDentifier as defined in [RFC412 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.oas_version %} -### OpenAPI Specification version +{% if page.deprecated_version %} +### Deprecated Since -{{ page.oas_version }} +{{ page.deprecated_version }} {% endif %} {% if page.remarks %} diff --git a/registry/format.md b/registry/format.md index 9ce86f974f..d966de5b29 100644 --- a/registry/format.md +++ b/registry/format.md @@ -11,8 +11,8 @@ Please raise a [Pull-Request](https://github.com/OAI/OpenAPI-Specification/pulls ## Values -|Value|Description|Type|Source|OAS Version| +|Value|Description|Type|Source|Deprecated Since| |---|---|----|---|---|----| -{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type }} | {% if value.source %}{% if value.source_label %}{{value.source_label}}{% else %}Open{% endif %}{% endif %} | {{ value.oas_version }} | +{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type }} | {% if value.source %}{% if value.source_label %}{{value.source_label}}{% else %}Open{% endif %}{% endif %} | {% if value.deprecated_version %}{{ value.deprecated_version }}{% else %}N/A{% endif %} | {% endfor %} From a089e1312f054d5966e3773db55d47f0b13f24d4 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Fri, 3 Mar 2023 13:39:13 -0500 Subject: [PATCH 45/53] Update registry/format.md Co-authored-by: Darrel --- registry/format.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/registry/format.md b/registry/format.md index d966de5b29..dc17b93b15 100644 --- a/registry/format.md +++ b/registry/format.md @@ -11,7 +11,7 @@ Please raise a [Pull-Request](https://github.com/OAI/OpenAPI-Specification/pulls ## Values -|Value|Description|Type|Source|Deprecated Since| +|Value|Description|Type|Source|Deprecated| |---|---|----|---|---|----| {% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type }} | {% if value.source %}{% if value.source_label %}{{value.source_label}}{% else %}Open{% endif %}{% endif %} | {% if value.deprecated_version %}{{ value.deprecated_version }}{% else %}N/A{% endif %} | {% endfor %} From f5b9c99b62c9841eac88fdba2f60a639852c9cfd Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Fri, 3 Mar 2023 13:41:18 -0500 Subject: [PATCH 46/53] - changes the deprecation to a true/false in the table Signed-off-by: Vincent Biret --- registry/format.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/registry/format.md b/registry/format.md index dc17b93b15..b72a8ab460 100644 --- a/registry/format.md +++ b/registry/format.md @@ -13,6 +13,6 @@ Please raise a [Pull-Request](https://github.com/OAI/OpenAPI-Specification/pulls |Value|Description|Type|Source|Deprecated| |---|---|----|---|---|----| -{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type }} | {% if value.source %}{% if value.source_label %}{{value.source_label}}{% else %}Open{% endif %}{% endif %} | {% if value.deprecated_version %}{{ value.deprecated_version }}{% else %}N/A{% endif %} | +{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type }} | {% if value.source %}{% if value.source_label %}{{value.source_label}}{% else %}Open{% endif %}{% endif %} | {% if value.deprecated_version %}Yes{% else %}No{% endif %} | {% endfor %} From d3cf3492d50e594d14ce44148de26e6d8611a27e Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Fri, 3 Mar 2023 13:44:13 -0500 Subject: [PATCH 47/53] - removes the deprecation notice from detail pages Signed-off-by: Vincent Biret --- registries/_format/base64url.md | 6 ------ registries/_format/binary.md | 6 ------ registries/_format/byte.md | 6 ------ registries/_format/char.md | 6 ------ registries/_format/commonmark.md | 6 ------ registries/_format/date-time.md | 6 ------ registries/_format/date.md | 6 ------ registries/_format/decimal.md | 6 ------ registries/_format/double.md | 6 ------ registries/_format/duration.md | 6 ------ registries/_format/email.md | 6 ------ registries/_format/float.md | 6 ------ registries/_format/hostname.md | 6 ------ registries/_format/html.md | 6 ------ registries/_format/idn-email.md | 6 ------ registries/_format/idn-hostname.md | 6 ------ registries/_format/int16.md | 6 ------ registries/_format/int32.md | 6 ------ registries/_format/int64.md | 6 ------ registries/_format/int8.md | 6 ------ registries/_format/ipv4.md | 6 ------ registries/_format/ipv6.md | 6 ------ registries/_format/iri-reference.md | 6 ------ registries/_format/iri.md | 6 ------ registries/_format/json-pointer.md | 6 ------ registries/_format/password.md | 6 ------ registries/_format/regex.md | 6 ------ registries/_format/relative-json-pointer.md | 6 ------ registries/_format/time.md | 6 ------ registries/_format/uint8.md | 6 ------ registries/_format/uri-reference.md | 6 ------ registries/_format/uri-template.md | 6 ------ registries/_format/uri.md | 6 ------ registries/_format/uuid.md | 6 ------ 34 files changed, 204 deletions(-) diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md index 553a9ae35b..362a4bd2c1 100644 --- a/registries/_format/base64url.md +++ b/registries/_format/base64url.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format is binary data encoded as a url-safe string as define * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/binary.md b/registries/_format/binary.md index b992cd61bb..76ea573bf9 100644 --- a/registries/_format/binary.md +++ b/registries/_format/binary.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format represents any sequence of octets. This format entry * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/byte.md b/registries/_format/byte.md index 26e9ee2ecd..0621ed0d73 100644 --- a/registries/_format/byte.md +++ b/registries/_format/byte.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format represents any sequence of octets encoded as a base64 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/char.md b/registries/_format/char.md index f73a2d9cb5..4ac98e911d 100644 --- a/registries/_format/char.md +++ b/registries/_format/char.md @@ -20,12 +20,6 @@ The `{{page.slug}}` format is a single character. * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/commonmark.md b/registries/_format/commonmark.md index ff480abd73..38bea3301e 100644 --- a/registries/_format/commonmark.md +++ b/registries/_format/commonmark.md @@ -20,12 +20,6 @@ The `{{page.slug}}` format represents [CommonMark](https://commonmark.org/) form * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/date-time.md b/registries/_format/date-time.md index 4c9fa1b02f..a998aa8007 100644 --- a/registries/_format/date-time.md +++ b/registries/_format/date-time.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format represents a date and time as defined by date-time - * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/date.md b/registries/_format/date.md index 646fc99f67..6aca9e58c0 100644 --- a/registries/_format/date.md +++ b/registries/_format/date.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format represents a date as defined by full-date - [RFC3339] * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/decimal.md b/registries/_format/decimal.md index 8347f313bf..1140f524a0 100644 --- a/registries/_format/decimal.md +++ b/registries/_format/decimal.md @@ -20,12 +20,6 @@ The `{{page.slug}}` format represents a fixed or floating point decimal number a * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/double.md b/registries/_format/double.md index c345ffbbc8..93ee3166a7 100644 --- a/registries/_format/double.md +++ b/registries/_format/double.md @@ -20,12 +20,6 @@ The `{{page.slug}}` format represents a double precision (64bit) floating point * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/duration.md b/registries/_format/duration.md index cf3435798c..e33fe8e942 100644 --- a/registries/_format/duration.md +++ b/registries/_format/duration.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format represents a duration as defined by duration - [RFC33 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/email.md b/registries/_format/email.md index e2c475de46..9e3976d32d 100644 --- a/registries/_format/email.md +++ b/registries/_format/email.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format is an email address as defined as Mailbox in [RFC5321 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/float.md b/registries/_format/float.md index 2617c66b01..fc9bbe66b6 100644 --- a/registries/_format/float.md +++ b/registries/_format/float.md @@ -20,12 +20,6 @@ The `{{page.slug}}` format represents a single precision (32bit) floating point * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/hostname.md b/registries/_format/hostname.md index 881274489c..db796c64dd 100644 --- a/registries/_format/hostname.md +++ b/registries/_format/hostname.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format is a host name as defined by RFC1123. * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/html.md b/registries/_format/html.md index d79e5473d6..1e545ca8ba 100644 --- a/registries/_format/html.md +++ b/registries/_format/html.md @@ -20,12 +20,6 @@ The `{{page.slug}}` format represents HTML-formatted text. * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/idn-email.md b/registries/_format/idn-email.md index 684ec00e8d..23d4445a0a 100644 --- a/registries/_format/idn-email.md +++ b/registries/_format/idn-email.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format is an email address as defined as Mailbox in [RFC6531 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/idn-hostname.md b/registries/_format/idn-hostname.md index 3cc3df9311..103213a7ec 100644 --- a/registries/_format/idn-hostname.md +++ b/registries/_format/idn-hostname.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format is an internationalized host name as defined by [RFC5 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/int16.md b/registries/_format/int16.md index 234bf7955f..26b9565898 100644 --- a/registries/_format/int16.md +++ b/registries/_format/int16.md @@ -20,12 +20,6 @@ The `{{page.slug}}` format represents a signed 16-bit integer, with the range -3 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/int32.md b/registries/_format/int32.md index 1f225471db..a68cd2bcad 100644 --- a/registries/_format/int32.md +++ b/registries/_format/int32.md @@ -20,12 +20,6 @@ The `{{page.slug}}` format represents a signed 32-bit integer, with the range * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/int64.md b/registries/_format/int64.md index 7cd4831c60..c7bc406789 100644 --- a/registries/_format/int64.md +++ b/registries/_format/int64.md @@ -20,12 +20,6 @@ The `{{page.slug}}` format represents a signed 64-bit integer, with the range -9 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/int8.md b/registries/_format/int8.md index 36a084503d..bda4ef3ad7 100644 --- a/registries/_format/int8.md +++ b/registries/_format/int8.md @@ -20,12 +20,6 @@ The `{{page.slug}}` format represents a signed 8-bit integer, with the range -12 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/ipv4.md b/registries/_format/ipv4.md index 5b28dcec36..4acc1e5e4d 100644 --- a/registries/_format/ipv4.md +++ b/registries/_format/ipv4.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format is an IPv4 address as defined as dotted-quad by RFC26 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/ipv6.md b/registries/_format/ipv6.md index 37e601ab59..e2ab6ac147 100644 --- a/registries/_format/ipv6.md +++ b/registries/_format/ipv6.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format is an IPv6 address as defined by RFC4673. * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/iri-reference.md b/registries/_format/iri-reference.md index c4a21bc518..197c7d8209 100644 --- a/registries/_format/iri-reference.md +++ b/registries/_format/iri-reference.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format is a Internationalized Resource Identifier as defined * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/iri.md b/registries/_format/iri.md index c4a21bc518..197c7d8209 100644 --- a/registries/_format/iri.md +++ b/registries/_format/iri.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format is a Internationalized Resource Identifier as defined * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/json-pointer.md b/registries/_format/json-pointer.md index 3714d23bff..cb838ee497 100644 --- a/registries/_format/json-pointer.md +++ b/registries/_format/json-pointer.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format is a JSON string representation of a JSON Pointer as * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/password.md b/registries/_format/password.md index 7269dbab08..f9c03435e6 100644 --- a/registries/_format/password.md +++ b/registries/_format/password.md @@ -20,12 +20,6 @@ The `{{page.slug}}` format is a string that hints to UIs to obscure input. * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/regex.md b/registries/_format/regex.md index 732129eebe..2c6de3a2ea 100644 --- a/registries/_format/regex.md +++ b/registries/_format/regex.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format is a regular expression as defined in ECMA-262. * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/relative-json-pointer.md b/registries/_format/relative-json-pointer.md index 50ad9dd425..c1eb233a97 100644 --- a/registries/_format/relative-json-pointer.md +++ b/registries/_format/relative-json-pointer.md @@ -24,12 +24,6 @@ The `{{page.slug}}` format is a JSON string representation of a relative JSON Po * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/time.md b/registries/_format/time.md index 344ccdde34..d1291fcf02 100644 --- a/registries/_format/time.md +++ b/registries/_format/time.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format represents a time as defined by full-time - [RFC3339] * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/uint8.md b/registries/_format/uint8.md index 1f3d9ea945..8556732ae5 100644 --- a/registries/_format/uint8.md +++ b/registries/_format/uint8.md @@ -20,12 +20,6 @@ The `{{page.slug}}` format represents an unsigned 8-bit integer, with the range * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/uri-reference.md b/registries/_format/uri-reference.md index f586e0a39f..371576a2c5 100644 --- a/registries/_format/uri-reference.md +++ b/registries/_format/uri-reference.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format is a URI reference as defined in RFC3986. * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/uri-template.md b/registries/_format/uri-template.md index 19095cb085..bf256e4cbc 100644 --- a/registries/_format/uri-template.md +++ b/registries/_format/uri-template.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format is a URI Template as defined in [RFC6570](https://www * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/uri.md b/registries/_format/uri.md index 33cf4c90c0..39199b2dc0 100644 --- a/registries/_format/uri.md +++ b/registries/_format/uri.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format is a Uniform Resource Identifier as defined in [RFC39 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks diff --git a/registries/_format/uuid.md b/registries/_format/uuid.md index 9316c67f39..391843623c 100644 --- a/registries/_format/uuid.md +++ b/registries/_format/uuid.md @@ -22,12 +22,6 @@ The `{{page.slug}}` format a Universally Unique IDentifier as defined in [RFC412 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} -{% if page.deprecated_version %} -### Deprecated Since - -{{ page.deprecated_version }} -{% endif %} - {% if page.remarks %} ### Remarks From d95a9456142f203697dcd2be6602042036d048de Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Fri, 3 Mar 2023 14:41:02 -0500 Subject: [PATCH 48/53] - renames deprecated version to note as PR feedback Signed-off-by: Vincent Biret --- registries/_format/base64url.md | 2 +- registries/_format/binary.md | 2 +- registries/_format/byte.md | 2 +- registry/format.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md index 362a4bd2c1..0756f637b0 100644 --- a/registries/_format/base64url.md +++ b/registries/_format/base64url.md @@ -4,7 +4,7 @@ issue: description: Binary data encoded as a url-safe string as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-5) base_type: string layout: default -deprecated_version: '3.1' +deprecated_note: '3.1' remarks: "When using OpenAPI 3.1 it's recommended not to use this format and instead use [`contentEncoding` with a value of `base64url`](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentencoding)." --- diff --git a/registries/_format/binary.md b/registries/_format/binary.md index 76ea573bf9..71ef1d6b44 100644 --- a/registries/_format/binary.md +++ b/registries/_format/binary.md @@ -4,7 +4,7 @@ issue: description: any sequence of octets base_type: string layout: default -deprecated_version: '3.1' +deprecated_note: '3.1' remarks: "In OpenAPI 3.1, instead set the media type appropriately and do not use a schema property. Note that only complete HTTP message bodies or complete parts in a multipart media type can accommodate binary data. JSON strings and URL path components cannot." --- diff --git a/registries/_format/byte.md b/registries/_format/byte.md index 0621ed0d73..51637ec992 100644 --- a/registries/_format/byte.md +++ b/registries/_format/byte.md @@ -4,7 +4,7 @@ issue: description: base64 encoded data as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-4) base_type: string layout: default -deprecated_version: '3.1' +deprecated_note: '3.1' remarks: "In OpenAPI 3.1, instead use [`contentEncoding: base64url`](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentencoding), optionally alongside [contentMediaType](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentmediatype)." --- diff --git a/registry/format.md b/registry/format.md index b72a8ab460..7f1a9b5f2f 100644 --- a/registry/format.md +++ b/registry/format.md @@ -13,6 +13,6 @@ Please raise a [Pull-Request](https://github.com/OAI/OpenAPI-Specification/pulls |Value|Description|Type|Source|Deprecated| |---|---|----|---|---|----| -{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type }} | {% if value.source %}{% if value.source_label %}{{value.source_label}}{% else %}Open{% endif %}{% endif %} | {% if value.deprecated_version %}Yes{% else %}No{% endif %} | +{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type }} | {% if value.source %}{% if value.source_label %}{{value.source_label}}{% else %}Open{% endif %}{% endif %} | {% if value.deprecated_note %}Yes{% else %}No{% endif %} | {% endfor %} From 1e69c4e7657be4fe3d4936002830d1d13973ad11 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Fri, 3 Mar 2023 14:48:23 -0500 Subject: [PATCH 49/53] - moves base64url, int16 and char to separate PRs --- registries/_format/base64url.md | 29 ----------------------------- registries/_format/char.md | 27 --------------------------- registries/_format/int16.md | 27 --------------------------- 3 files changed, 83 deletions(-) delete mode 100644 registries/_format/base64url.md delete mode 100644 registries/_format/char.md delete mode 100644 registries/_format/int16.md diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md deleted file mode 100644 index 0756f637b0..0000000000 --- a/registries/_format/base64url.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -owner: baywet -issue: -description: Binary data encoded as a url-safe string as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-5) -base_type: string -layout: default -deprecated_note: '3.1' -remarks: "When using OpenAPI 3.1 it's recommended not to use this format and instead use [`contentEncoding` with a value of `base64url`](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentencoding)." ---- - -# {{ page.collection }} - -## {{ page.slug }} - {{ page.description }} - -Base type: `{{ page.base_type }}`. - -The `{{page.slug}}` format is binary data encoded as a url-safe string as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-5). - -{% if page.issue %} -### GitHub Issue - -* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) -{% endif %} - -{% if page.remarks %} -### Remarks - -{{ page.remarks }} -{% endif %} \ No newline at end of file diff --git a/registries/_format/char.md b/registries/_format/char.md deleted file mode 100644 index 4ac98e911d..0000000000 --- a/registries/_format/char.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -owner: baywet -issue: -description: A single character -base_type: string -layout: default ---- - -# {{ page.collection }} - -## {{ page.slug }} - {{ page.description }} - -Base type: `{{ page.base_type }}`. - -The `{{page.slug}}` format is a single character. - -{% if page.issue %} -### GitHub Issue - -* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) -{% endif %} - -{% if page.remarks %} -### Remarks - -{{ page.remarks }} -{% endif %} \ No newline at end of file diff --git a/registries/_format/int16.md b/registries/_format/int16.md deleted file mode 100644 index 26b9565898..0000000000 --- a/registries/_format/int16.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -owner: DarrelMiller -issue: -description: signed 16-bit integer -base_type: number -layout: default ---- - -# {{ page.collection }} - -## {{ page.slug }} - {{ page.description }} - -Base type: `{{ page.base_type }}`. - -The `{{page.slug}}` format represents a signed 16-bit integer, with the range -32768 through +32767. This format entry is to ensure future versions of OpenAPI maintain compatibility with [OpenAPI 3.0.x](https://spec.openapis.org/oas/v3.0.0). - -{% if page.issue %} -### GitHub Issue - -* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) -{% endif %} - -{% if page.remarks %} -### Remarks - -{{ page.remarks }} -{% endif %} \ No newline at end of file From 95143fbf22cbb1b4b1334b7408caa617347f3324 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 6 Mar 2023 09:42:47 -0500 Subject: [PATCH 50/53] Apply suggestions from code review Co-authored-by: Darrel --- registries/_format/byte.md | 2 +- registries/_format/hostname.md | 2 +- registries/_format/idn-email.md | 2 +- registries/_format/ipv4.md | 2 +- registries/_format/ipv6.md | 2 +- registries/_format/iri-reference.md | 2 +- registries/_format/iri.md | 2 +- registries/_format/json-pointer.md | 2 +- registries/_format/uri-reference.md | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/registries/_format/byte.md b/registries/_format/byte.md index 51637ec992..ee44d77160 100644 --- a/registries/_format/byte.md +++ b/registries/_format/byte.md @@ -5,7 +5,7 @@ description: base64 encoded data as defined in [RFC4648](https://www.rfc-editor. base_type: string layout: default deprecated_note: '3.1' -remarks: "In OpenAPI 3.1, instead use [`contentEncoding: base64url`](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentencoding), optionally alongside [contentMediaType](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentmediatype)." +remarks: "In OpenAPI 3.1, instead use [`contentEncoding: base64`](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentencoding), optionally alongside [contentMediaType](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentmediatype)." --- # {{ page.collection }} diff --git a/registries/_format/hostname.md b/registries/_format/hostname.md index db796c64dd..f4e237202e 100644 --- a/registries/_format/hostname.md +++ b/registries/_format/hostname.md @@ -14,7 +14,7 @@ source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-h Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format is a host name as defined by RFC1123. +The `{{page.slug}}` format is a host name as defined by [RFC1123](https://www.rfc-editor.org/info/rfc1123). {% if page.issue %} ### GitHub Issue diff --git a/registries/_format/idn-email.md b/registries/_format/idn-email.md index 23d4445a0a..ad7e6f8242 100644 --- a/registries/_format/idn-email.md +++ b/registries/_format/idn-email.md @@ -5,7 +5,7 @@ description: An email address as defined as Mailbox in RFC6531 base_type: string layout: default source_label: JSON Schema - https://json-schema.org/draft/2020-12/json-schema-validation.html#name-email-addresses + source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-email-addresses --- # {{ page.collection }} diff --git a/registries/_format/ipv4.md b/registries/_format/ipv4.md index 4acc1e5e4d..9609c0c1ce 100644 --- a/registries/_format/ipv4.md +++ b/registries/_format/ipv4.md @@ -14,7 +14,7 @@ source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-i Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format is an IPv4 address as defined as dotted-quad by RFC2673. +The `{{page.slug}}` format is an IPv4 address as defined as dotted-quad by [RFC2673](https://www.rfc-editor.org/info/rfc2673). {% if page.issue %} ### GitHub Issue diff --git a/registries/_format/ipv6.md b/registries/_format/ipv6.md index e2ab6ac147..92732de58f 100644 --- a/registries/_format/ipv6.md +++ b/registries/_format/ipv6.md @@ -14,7 +14,7 @@ source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-i Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format is an IPv6 address as defined by RFC4673. +The `{{page.slug}}` format is an IPv6 address as defined by [RFC4291](https://www.rfc-editor.org/info/rfc4291). {% if page.issue %} ### GitHub Issue diff --git a/registries/_format/iri-reference.md b/registries/_format/iri-reference.md index 197c7d8209..605d75bbb5 100644 --- a/registries/_format/iri-reference.md +++ b/registries/_format/iri-reference.md @@ -14,7 +14,7 @@ source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-r Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format is a Internationalized Resource Identifier as defined in RFC3987. +The `{{page.slug}}` format is a Internationalized Resource Identifier as defined in [RFC3987](https://www.rfc-editor.org/info/rfc3987). {% if page.issue %} ### GitHub Issue diff --git a/registries/_format/iri.md b/registries/_format/iri.md index 197c7d8209..605d75bbb5 100644 --- a/registries/_format/iri.md +++ b/registries/_format/iri.md @@ -14,7 +14,7 @@ source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-r Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format is a Internationalized Resource Identifier as defined in RFC3987. +The `{{page.slug}}` format is a Internationalized Resource Identifier as defined in [RFC3987](https://www.rfc-editor.org/info/rfc3987). {% if page.issue %} ### GitHub Issue diff --git a/registries/_format/json-pointer.md b/registries/_format/json-pointer.md index cb838ee497..4f96a6d020 100644 --- a/registries/_format/json-pointer.md +++ b/registries/_format/json-pointer.md @@ -14,7 +14,7 @@ source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-j Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format is a JSON string representation of a JSON Pointer as defined in RFC6901. +The `{{page.slug}}` format is a JSON string representation of a JSON Pointer as defined in [RFC6901](https://www.rfc-editor.org/info/rfc6901). {% if page.issue %} ### GitHub Issue diff --git a/registries/_format/uri-reference.md b/registries/_format/uri-reference.md index 371576a2c5..aeb939857f 100644 --- a/registries/_format/uri-reference.md +++ b/registries/_format/uri-reference.md @@ -1,7 +1,7 @@ --- owner: baywet issue: -description: A URI reference as defined in RFC3986 +description: A URI reference as defined in [RFC3986](https://www.rfc-editor.org/info/rfc3986) base_type: string layout: default source_label: JSON Schema From 1cae0da7566a59255c8c9c4db0ce3119c5e18d83 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 6 Mar 2023 09:50:37 -0500 Subject: [PATCH 51/53] - moves decimal to a separate PR --- registries/_format/decimal.md | 27 --------------------------- 1 file changed, 27 deletions(-) delete mode 100644 registries/_format/decimal.md diff --git a/registries/_format/decimal.md b/registries/_format/decimal.md deleted file mode 100644 index 1140f524a0..0000000000 --- a/registries/_format/decimal.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -owner: baywet -issue: -description: A fixed or floating point decimal number as defined by ISO/IEC 9075-2 2016 12 15 -base_type: string -layout: default ---- - -# {{ page.collection }} - -## {{ page.slug }} - {{ page.description }} - -Base type: `{{ page.base_type }}`. - -The `{{page.slug}}` format represents a fixed or floating point decimal number as defined by ISO/IEC 9075-2 2016 12 15. - -{% if page.issue %} -### GitHub Issue - -* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) -{% endif %} - -{% if page.remarks %} -### Remarks - -{{ page.remarks }} -{% endif %} \ No newline at end of file From b3a05582603313f7e3f6fc1e7267a8e21fad320b Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 6 Mar 2023 11:35:16 -0500 Subject: [PATCH 52/53] - adds OAS source for relevant formats Signed-off-by: Vincent Biret --- registries/_format/binary.md | 2 ++ registries/_format/byte.md | 2 ++ registries/_format/commonmark.md | 2 ++ registries/_format/double.md | 2 ++ registries/_format/float.md | 2 ++ registries/_format/html.md | 2 ++ registries/_format/int32.md | 2 ++ registries/_format/int64.md | 2 ++ registries/_format/int8.md | 2 ++ registries/_format/password.md | 2 ++ registries/_format/uint8.md | 2 ++ 11 files changed, 22 insertions(+) diff --git a/registries/_format/binary.md b/registries/_format/binary.md index 71ef1d6b44..6d63a63f3f 100644 --- a/registries/_format/binary.md +++ b/registries/_format/binary.md @@ -6,6 +6,8 @@ base_type: string layout: default deprecated_note: '3.1' remarks: "In OpenAPI 3.1, instead set the media type appropriately and do not use a schema property. Note that only complete HTTP message bodies or complete parts in a multipart media type can accommodate binary data. JSON strings and URL path components cannot." +source: https://spec.openapis.org/oas/v3.0.3.html#data-types +source_label: OAS --- # {{ page.collection }} diff --git a/registries/_format/byte.md b/registries/_format/byte.md index ee44d77160..04e8c49d31 100644 --- a/registries/_format/byte.md +++ b/registries/_format/byte.md @@ -6,6 +6,8 @@ base_type: string layout: default deprecated_note: '3.1' remarks: "In OpenAPI 3.1, instead use [`contentEncoding: base64`](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentencoding), optionally alongside [contentMediaType](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentmediatype)." +source: https://spec.openapis.org/oas/v3.0.3.html#data-types +source_label: OAS --- # {{ page.collection }} diff --git a/registries/_format/commonmark.md b/registries/_format/commonmark.md index 38bea3301e..5cccd7c593 100644 --- a/registries/_format/commonmark.md +++ b/registries/_format/commonmark.md @@ -4,6 +4,8 @@ description: commonmark-formatted text base_type: string issue: layout: default +source: https://spec.openapis.org/oas/latest.html#data-types +source_label: OAS --- # {{ page.collection }} diff --git a/registries/_format/double.md b/registries/_format/double.md index 93ee3166a7..915b515d55 100644 --- a/registries/_format/double.md +++ b/registries/_format/double.md @@ -4,6 +4,8 @@ issue: description: double precision floating point number base_type: number layout: default +source: https://spec.openapis.org/oas/latest.html#data-types +source_label: OAS --- # {{ page.collection }} diff --git a/registries/_format/float.md b/registries/_format/float.md index fc9bbe66b6..9a44e5d1a8 100644 --- a/registries/_format/float.md +++ b/registries/_format/float.md @@ -4,6 +4,8 @@ issue: description: single precision floating point number base_type: number layout: default +source: https://spec.openapis.org/oas/latest.html#data-types +source_label: OAS --- # {{ page.collection }} diff --git a/registries/_format/html.md b/registries/_format/html.md index 1e545ca8ba..1103ae48e2 100644 --- a/registries/_format/html.md +++ b/registries/_format/html.md @@ -4,6 +4,8 @@ description: HTML-formatted text base_type: string issue: layout: default +source: https://spec.openapis.org/oas/latest.html#data-types +source_label: OAS --- # {{ page.collection }} diff --git a/registries/_format/int32.md b/registries/_format/int32.md index a68cd2bcad..c459058867 100644 --- a/registries/_format/int32.md +++ b/registries/_format/int32.md @@ -4,6 +4,8 @@ issue: description: signed 32-bit integer base_type: number layout: default +source: https://spec.openapis.org/oas/latest.html#data-types +source_label: OAS --- # {{ page.collection }} diff --git a/registries/_format/int64.md b/registries/_format/int64.md index c7bc406789..9430c7ce4e 100644 --- a/registries/_format/int64.md +++ b/registries/_format/int64.md @@ -4,6 +4,8 @@ issue: description: signed 64-bit integer base_type: number layout: default +source: https://spec.openapis.org/oas/latest.html#data-types +source_label: OAS --- # {{ page.collection }} diff --git a/registries/_format/int8.md b/registries/_format/int8.md index bda4ef3ad7..b07ea1d5b2 100644 --- a/registries/_format/int8.md +++ b/registries/_format/int8.md @@ -4,6 +4,8 @@ issue: 845 description: signed 8-bit integer base_type: number layout: default +source: https://spec.openapis.org/oas/latest.html#data-types +source_label: OAS --- # {{ page.collection }} diff --git a/registries/_format/password.md b/registries/_format/password.md index f9c03435e6..26216ca175 100644 --- a/registries/_format/password.md +++ b/registries/_format/password.md @@ -4,6 +4,8 @@ issue: description: a string that hints to UIs to obscure input. base_type: string layout: default +source: https://spec.openapis.org/oas/latest.html#data-types +source_label: OAS --- # {{ page.collection }} diff --git a/registries/_format/uint8.md b/registries/_format/uint8.md index 8556732ae5..c9797dd746 100644 --- a/registries/_format/uint8.md +++ b/registries/_format/uint8.md @@ -4,6 +4,8 @@ issue: 845 description: unsigned 8-bit integer base_type: number layout: default +source: https://spec.openapis.org/oas/latest.html#data-types +source_label: OAS --- # {{ page.collection }} From be4f9f7cce4f6a97d9a2feea19bcf9c5bbfe2fbb Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Mon, 6 Mar 2023 12:14:11 -0500 Subject: [PATCH 53/53] Update registries/_format/idn-email.md Co-authored-by: Mike Ralphson --- registries/_format/idn-email.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/registries/_format/idn-email.md b/registries/_format/idn-email.md index ad7e6f8242..f508b3c343 100644 --- a/registries/_format/idn-email.md +++ b/registries/_format/idn-email.md @@ -5,7 +5,7 @@ description: An email address as defined as Mailbox in RFC6531 base_type: string layout: default source_label: JSON Schema - source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-email-addresses +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-email-addresses --- # {{ page.collection }}