From d3a7a0ede611444ba4cf06c6929ac67b6026ffc8 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Tue, 13 Aug 2024 12:42:13 -0400 Subject: [PATCH 1/7] fix: missing integer type for integer formats Signed-off-by: Vincent Biret --- registries/_format/int16.md | 2 +- registries/_format/int32.md | 2 +- registries/_format/int64.md | 2 +- registries/_format/int8.md | 2 +- registries/_format/uint8.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/registries/_format/int16.md b/registries/_format/int16.md index 203f5104fe..32c7d08ed1 100644 --- a/registries/_format/int16.md +++ b/registries/_format/int16.md @@ -2,7 +2,7 @@ owner: DarrelMiller issue: description: signed 16-bit integer -base_type: number +base_type: [number, integer] layout: default --- diff --git a/registries/_format/int32.md b/registries/_format/int32.md index 135b568201..94313b9ece 100644 --- a/registries/_format/int32.md +++ b/registries/_format/int32.md @@ -2,7 +2,7 @@ owner: DarrelMiller issue: description: signed 32-bit integer -base_type: number +base_type: [number, integer] layout: default source: https://spec.openapis.org/oas/latest.html#data-types source_label: OAS diff --git a/registries/_format/int64.md b/registries/_format/int64.md index e21d32a155..7b986f772c 100644 --- a/registries/_format/int64.md +++ b/registries/_format/int64.md @@ -2,7 +2,7 @@ owner: DarrelMiller issue: description: signed 64-bit integer -base_type: [number, string] +base_type: [number, integer, string] layout: default source: https://spec.openapis.org/oas/latest.html#data-types source_label: OAS diff --git a/registries/_format/int8.md b/registries/_format/int8.md index c02618917a..220d71df4b 100644 --- a/registries/_format/int8.md +++ b/registries/_format/int8.md @@ -2,7 +2,7 @@ owner: MikeRalphson issue: 845 description: signed 8-bit integer -base_type: number +base_type: [number, integer] layout: default source: https://spec.openapis.org/oas/latest.html#data-types source_label: OAS diff --git a/registries/_format/uint8.md b/registries/_format/uint8.md index 9f63ffc0d7..699d6606b8 100644 --- a/registries/_format/uint8.md +++ b/registries/_format/uint8.md @@ -2,7 +2,7 @@ owner: MikeRalphson issue: 845 description: unsigned 8-bit integer -base_type: number +base_type: [number, integer] layout: default source: https://spec.openapis.org/oas/latest.html#data-types source_label: OAS From 2640a0321607644ecc8fe004868ad21eac9b9b7f Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Wed, 21 Aug 2024 09:47:36 -0400 Subject: [PATCH 2/7] fix: removes the use of integer base type Signed-off-by: Vincent Biret --- registries/_format/double-int.md | 2 +- registries/_format/int16.md | 2 +- registries/_format/int32.md | 2 +- registries/_format/int64.md | 2 +- registries/_format/int8.md | 2 +- registries/_format/sf-integer.md | 2 +- registries/_format/uint8.md | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/registries/_format/double-int.md b/registries/_format/double-int.md index 87a821f708..50aa14ae8c 100644 --- a/registries/_format/double-int.md +++ b/registries/_format/double-int.md @@ -2,7 +2,7 @@ owner: mikekistler issue: description: an integer that can be stored in an IEEE 754 double-precision number without loss of precision -base_type: integer +base_type: number layout: default --- diff --git a/registries/_format/int16.md b/registries/_format/int16.md index 32c7d08ed1..203f5104fe 100644 --- a/registries/_format/int16.md +++ b/registries/_format/int16.md @@ -2,7 +2,7 @@ owner: DarrelMiller issue: description: signed 16-bit integer -base_type: [number, integer] +base_type: number layout: default --- diff --git a/registries/_format/int32.md b/registries/_format/int32.md index 94313b9ece..135b568201 100644 --- a/registries/_format/int32.md +++ b/registries/_format/int32.md @@ -2,7 +2,7 @@ owner: DarrelMiller issue: description: signed 32-bit integer -base_type: [number, integer] +base_type: number layout: default source: https://spec.openapis.org/oas/latest.html#data-types source_label: OAS diff --git a/registries/_format/int64.md b/registries/_format/int64.md index 7b986f772c..e21d32a155 100644 --- a/registries/_format/int64.md +++ b/registries/_format/int64.md @@ -2,7 +2,7 @@ owner: DarrelMiller issue: description: signed 64-bit integer -base_type: [number, integer, string] +base_type: [number, string] layout: default source: https://spec.openapis.org/oas/latest.html#data-types source_label: OAS diff --git a/registries/_format/int8.md b/registries/_format/int8.md index 220d71df4b..c02618917a 100644 --- a/registries/_format/int8.md +++ b/registries/_format/int8.md @@ -2,7 +2,7 @@ owner: MikeRalphson issue: 845 description: signed 8-bit integer -base_type: [number, integer] +base_type: number layout: default source: https://spec.openapis.org/oas/latest.html#data-types source_label: OAS diff --git a/registries/_format/sf-integer.md b/registries/_format/sf-integer.md index 8edc872cee..17f5224fca 100644 --- a/registries/_format/sf-integer.md +++ b/registries/_format/sf-integer.md @@ -4,7 +4,7 @@ issue: description: structured fields integer as defined in [RFC8941] source: https://www.rfc-editor.org/rfc/rfc8941#name-integers source_label: RFC 8941 -base_type: [integer, number] +base_type: number layout: default --- diff --git a/registries/_format/uint8.md b/registries/_format/uint8.md index 699d6606b8..9f63ffc0d7 100644 --- a/registries/_format/uint8.md +++ b/registries/_format/uint8.md @@ -2,7 +2,7 @@ owner: MikeRalphson issue: 845 description: unsigned 8-bit integer -base_type: [number, integer] +base_type: number layout: default source: https://spec.openapis.org/oas/latest.html#data-types source_label: OAS From eddb9b2b4354e648f5a3391a6b136a2e5ce950f5 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Wed, 21 Aug 2024 12:34:16 -0400 Subject: [PATCH 3/7] fix: changes terminology for type to align with spec updates Signed-off-by: Vincent Biret --- registry/format.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/registry/format.md b/registry/format.md index c032f95844..313384b29f 100644 --- a/registry/format.md +++ b/registry/format.md @@ -15,14 +15,13 @@ If tools choose to implement any format present in this registry, they SHOULD im The registry SHOULD NOT contain two entries that have the same meaning, unless all but one have been deprecated. - ## 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. ## Values -|Value|Description|Type|Source|Deprecated| +|Value|Description|JSON Data Type|Source|Deprecated| |---|---|----|---|---|----| {% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type | join: ', ' }} | {% if value.source %}{% if value.source_label %}{{value.source_label}}{% else %}Open{% endif %}{% endif %} | {% if value.deprecated_note %}Yes{% else %}No{% endif %} | {% endfor %} From d3b96de57beb9503fe6e1931beabe999c362761b Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Thu, 22 Aug 2024 12:51:03 +0200 Subject: [PATCH 4/7] Harmonize terminology --- _includes/format-entry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/format-entry.md b/_includes/format-entry.md index 016dedc065..1bea284e40 100644 --- a/_includes/format-entry.md +++ b/_includes/format-entry.md @@ -2,7 +2,7 @@ ## {{ page.slug }} - {{ page.description }} -Base type: `{{ page.base_type | join:', ' }}`. +JSON Data Type: `{{ page.base_type | join:', ' }}`. {{ include.summary }} From 7446e7b28605e35569fe9f8ba86dcd2144c9178d Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Thu, 22 Aug 2024 08:49:12 -0400 Subject: [PATCH 5/7] Apply suggestions from code review Co-authored-by: Mike Kistler --- _includes/format-entry.md | 2 +- registry/format.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/_includes/format-entry.md b/_includes/format-entry.md index 1bea284e40..d3c6449c9a 100644 --- a/_includes/format-entry.md +++ b/_includes/format-entry.md @@ -2,7 +2,7 @@ ## {{ page.slug }} - {{ page.description }} -JSON Data Type: `{{ page.base_type | join:', ' }}`. +Instance Type: `{{ page.base_type | join:', ' }}`. {{ include.summary }} diff --git a/registry/format.md b/registry/format.md index 313384b29f..1ecbda91a5 100644 --- a/registry/format.md +++ b/registry/format.md @@ -21,7 +21,9 @@ Please raise a [Pull-Request](https://github.com/OAI/OpenAPI-Specification/pulls ## Values -|Value|Description|JSON Data Type|Source|Deprecated| +For the purpose of [JSON Schema validation](https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-7.1), each format should specify the set of instance types (primitive JSON types) for which it applies. In this registry, these types are shown in the "Instance Type" column. + +|Value|Description|Instance Type|Source|Deprecated| |---|---|----|---|---|----| {% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type | join: ', ' }} | {% if value.source %}{% if value.source_label %}{{value.source_label}}{% else %}Open{% endif %}{% endif %} | {% if value.deprecated_note %}Yes{% else %}No{% endif %} | {% endfor %} From 60d7ecdc87b7236bd2def9ddd9e03ae92f860441 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Thu, 22 Aug 2024 11:54:53 -0400 Subject: [PATCH 6/7] fix: reverts to JSON data type to align with spec Signed-off-by: Vincent Biret --- _includes/format-entry.md | 2 +- registry/format.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/_includes/format-entry.md b/_includes/format-entry.md index d3c6449c9a..76669ed12c 100644 --- a/_includes/format-entry.md +++ b/_includes/format-entry.md @@ -2,7 +2,7 @@ ## {{ page.slug }} - {{ page.description }} -Instance Type: `{{ page.base_type | join:', ' }}`. +JSON data type: `{{ page.base_type | join:', ' }}`. {{ include.summary }} diff --git a/registry/format.md b/registry/format.md index 1ecbda91a5..0d0b6b301f 100644 --- a/registry/format.md +++ b/registry/format.md @@ -21,9 +21,9 @@ Please raise a [Pull-Request](https://github.com/OAI/OpenAPI-Specification/pulls ## Values -For the purpose of [JSON Schema validation](https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-7.1), each format should specify the set of instance types (primitive JSON types) for which it applies. In this registry, these types are shown in the "Instance Type" column. +For the purpose of [JSON Schema validation](https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-7.1), each format should specify the set of JSON data types for which it applies. In this registry, these types are shown in the "JSON data type" column. -|Value|Description|Instance Type|Source|Deprecated| +|Value|Description|JSON data Type|Source|Deprecated| |---|---|----|---|---|----| {% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type | join: ', ' }} | {% if value.source %}{% if value.source_label %}{{value.source_label}}{% else %}Open{% endif %}{% endif %} | {% if value.deprecated_note %}Yes{% else %}No{% endif %} | {% endfor %} From baa81d0c47a229ddd43e31f48e142cec5d51a859 Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Thu, 22 Aug 2024 18:58:27 +0200 Subject: [PATCH 7/7] Apply suggestions from code review --- _includes/format-entry.md | 2 +- registry/format.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/_includes/format-entry.md b/_includes/format-entry.md index 76669ed12c..1bea284e40 100644 --- a/_includes/format-entry.md +++ b/_includes/format-entry.md @@ -2,7 +2,7 @@ ## {{ page.slug }} - {{ page.description }} -JSON data type: `{{ page.base_type | join:', ' }}`. +JSON Data Type: `{{ page.base_type | join:', ' }}`. {{ include.summary }} diff --git a/registry/format.md b/registry/format.md index 0d0b6b301f..90e1e1341f 100644 --- a/registry/format.md +++ b/registry/format.md @@ -23,7 +23,7 @@ Please raise a [Pull-Request](https://github.com/OAI/OpenAPI-Specification/pulls For the purpose of [JSON Schema validation](https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-7.1), each format should specify the set of JSON data types for which it applies. In this registry, these types are shown in the "JSON data type" column. -|Value|Description|JSON data Type|Source|Deprecated| +|Value|Description|JSON Data Type|Source|Deprecated| |---|---|----|---|---|----| {% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {{ value.base_type | join: ', ' }} | {% if value.source %}{% if value.source_label %}{{value.source_label}}{% else %}Open{% endif %}{% endif %} | {% if value.deprecated_note %}Yes{% else %}No{% endif %} | {% endfor %}