From 8085c349381d1116015e6e7c5d544a4a3744c95b Mon Sep 17 00:00:00 2001 From: Darrel Miller Date: Fri, 14 Jan 2022 12:56:48 -0500 Subject: [PATCH 1/3] Added formats to the registry as defined by OpenAPI v3 --- registries/_format/binary.md | 21 +++++++++++++++++++++ registries/_format/boolean.md | 21 +++++++++++++++++++++ registries/_format/byte.md | 21 +++++++++++++++++++++ registries/_format/date.md | 21 +++++++++++++++++++++ registries/_format/dateTime.md | 21 +++++++++++++++++++++ registries/_format/double.md | 21 +++++++++++++++++++++ registries/_format/float.md | 21 +++++++++++++++++++++ registries/_format/int32.md | 21 +++++++++++++++++++++ registries/_format/int64.md | 21 +++++++++++++++++++++ 9 files changed, 189 insertions(+) create mode 100644 registries/_format/binary.md create mode 100644 registries/_format/boolean.md create mode 100644 registries/_format/byte.md create mode 100644 registries/_format/date.md create mode 100644 registries/_format/dateTime.md create mode 100644 registries/_format/double.md create mode 100644 registries/_format/float.md create mode 100644 registries/_format/int32.md create mode 100644 registries/_format/int64.md diff --git a/registries/_format/binary.md b/registries/_format/binary.md new file mode 100644 index 0000000000..85508c2c0f --- /dev/null +++ b/registries/_format/binary.md @@ -0,0 +1,21 @@ +--- +owner: DarrelMiller +issue: +description: any sequence of octets +base_type: string +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +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). + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} diff --git a/registries/_format/boolean.md b/registries/_format/boolean.md new file mode 100644 index 0000000000..074146b19f --- /dev/null +++ b/registries/_format/boolean.md @@ -0,0 +1,21 @@ +--- +owner: DarrelMiller +issue: +description: data type that has one of two possible values, true or false. +base_type: string +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format represents one of two possible values, `true` or `false`. 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 %} diff --git a/registries/_format/byte.md b/registries/_format/byte.md new file mode 100644 index 0000000000..69533e5327 --- /dev/null +++ b/registries/_format/byte.md @@ -0,0 +1,21 @@ +--- +owner: DarrelMiller +issue: +description: base64 encoded characters +base_type: string +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +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). + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} diff --git a/registries/_format/date.md b/registries/_format/date.md new file mode 100644 index 0000000000..a1d7345d3b --- /dev/null +++ b/registries/_format/date.md @@ -0,0 +1,21 @@ +--- +owner: DarrelMiller +issue: +description: date as defined by full-date - RFC3339 +base_type: string +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +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). + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} diff --git a/registries/_format/dateTime.md b/registries/_format/dateTime.md new file mode 100644 index 0000000000..497271b24e --- /dev/null +++ b/registries/_format/dateTime.md @@ -0,0 +1,21 @@ +--- +owner: DarrelMiller +issue: +description: date and time as defined by date-time - RFC3339 +base_type: string +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +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). + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} diff --git a/registries/_format/double.md b/registries/_format/double.md new file mode 100644 index 0000000000..417af4c715 --- /dev/null +++ b/registries/_format/double.md @@ -0,0 +1,21 @@ +--- +owner: DarrelMiller +issue: +description: double precision floating point number +base_type: number +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format represents a double precision (64bit) floating point number as defined by [IEEE Std 754-2019](https://ieeexplore.ieee.org/document/8766229). 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 %} diff --git a/registries/_format/float.md b/registries/_format/float.md new file mode 100644 index 0000000000..cbe24fdc7b --- /dev/null +++ b/registries/_format/float.md @@ -0,0 +1,21 @@ +--- +owner: DarrelMiller +issue: +description: single precision floating point number +base_type: number +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format represents a single precision (32bit) floating point number as defined by [IEEE Std 754-2019](https://ieeexplore.ieee.org/document/8766229). 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 %} diff --git a/registries/_format/int32.md b/registries/_format/int32.md new file mode 100644 index 0000000000..a22ed98821 --- /dev/null +++ b/registries/_format/int32.md @@ -0,0 +1,21 @@ +--- +owner: DarrelMiller +issue: +description: signed 32-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 32-bit integer, with the range −2,147,483,648 through 2,147,483,647. 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 %} diff --git a/registries/_format/int64.md b/registries/_format/int64.md new file mode 100644 index 0000000000..0fd3ebf1fa --- /dev/null +++ b/registries/_format/int64.md @@ -0,0 +1,21 @@ +--- +owner: DarrelMiller +issue: +description: signed 64-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 64-bit integer, with the range -9223372036854775808 through 9223372036854775807. 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 %} From 6cda025f3c45f82b3ccceb325bd6ad8afb2c00ac Mon Sep 17 00:00:00 2001 From: Darrel Miller Date: Fri, 14 Jan 2022 20:08:28 -0500 Subject: [PATCH 2/3] Fixed date-time format --- registries/_format/{dateTime.md => date-time.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename registries/_format/{dateTime.md => date-time.md} (100%) diff --git a/registries/_format/dateTime.md b/registries/_format/date-time.md similarity index 100% rename from registries/_format/dateTime.md rename to registries/_format/date-time.md From 73e6809a4d082888c4a66744a22f05acb48a6cb5 Mon Sep 17 00:00:00 2001 From: Darrel Miller Date: Fri, 14 Jan 2022 20:09:42 -0500 Subject: [PATCH 3/3] Removed boolean as format is not needed --- registries/_format/boolean.md | 21 --------------------- 1 file changed, 21 deletions(-) delete mode 100644 registries/_format/boolean.md diff --git a/registries/_format/boolean.md b/registries/_format/boolean.md deleted file mode 100644 index 074146b19f..0000000000 --- a/registries/_format/boolean.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -owner: DarrelMiller -issue: -description: data type that has one of two possible values, true or false. -base_type: string -layout: default ---- - -# {{ page.collection }} - -## {{ page.slug }} - {{ page.description }} - -Base type: `{{ page.base_type }}`. - -The `{{page.slug}}` format represents one of two possible values, `true` or `false`. 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 %}