diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md new file mode 100644 index 0000000000..0756f637b0 --- /dev/null +++ b/registries/_format/base64url.md @@ -0,0 +1,29 @@ +--- +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 new file mode 100644 index 0000000000..4ac98e911d --- /dev/null +++ b/registries/_format/char.md @@ -0,0 +1,27 @@ +--- +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/decimal.md b/registries/_format/decimal.md new file mode 100644 index 0000000000..a48196419f --- /dev/null +++ b/registries/_format/decimal.md @@ -0,0 +1,32 @@ +--- +owner: baywet +issue: 889 +description: A fixed point decimal number +base_type: string +layout: default +remarks: Potential loss of precision when used with type number. Not specific enough about the size of the integral and fraction parts without the use of extensions. +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format represents a fixed point decimal number. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.remarks %} +### Remarks + +When the decimal format is used in combination with the number type, unintentional loss of precision can happen during serialization as most JSON serializers will serialize the value **1.10** to **1.1**. + +This format is not prescriptive enough to enable interoperability and its usage is discouraged. + +{{ page.remarks }} +{% endif %} \ No newline at end of file diff --git a/registries/_format/int16.md b/registries/_format/int16.md new file mode 100644 index 0000000000..51626b6c41 --- /dev/null +++ b/registries/_format/int16.md @@ -0,0 +1,27 @@ +--- +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. + +{% 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