diff --git a/registries/_format/binary.md b/registries/_format/binary.md index 85508c2c0f..6d63a63f3f 100644 --- a/registries/_format/binary.md +++ b/registries/_format/binary.md @@ -4,6 +4,10 @@ issue: description: any sequence of octets 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 }} @@ -12,10 +16,16 @@ 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 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} diff --git a/registries/_format/byte.md b/registries/_format/byte.md index 69533e5327..04e8c49d31 100644 --- a/registries/_format/byte.md +++ b/registries/_format/byte.md @@ -1,9 +1,13 @@ --- owner: DarrelMiller issue: -description: base64 encoded characters +description: base64 encoded data as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-4) 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 }} @@ -12,10 +16,16 @@ 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 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). {% 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/commonmark.md b/registries/_format/commonmark.md index 959b597e2a..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 }} @@ -19,3 +21,9 @@ The `{{page.slug}}` format represents [CommonMark](https://commonmark.org/) form * [#{{ 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/date-time.md b/registries/_format/date-time.md index 497271b24e..a998aa8007 100644 --- a/registries/_format/date-time.md +++ b/registries/_format/date-time.md @@ -1,9 +1,11 @@ --- 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_label: JSON Schema +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-dates-times-and-duration --- # {{ page.collection }} @@ -12,10 +14,16 @@ layout: default 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 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} diff --git a/registries/_format/date.md b/registries/_format/date.md index a1d7345d3b..6aca9e58c0 100644 --- a/registries/_format/date.md +++ b/registries/_format/date.md @@ -1,9 +1,11 @@ --- 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_label: JSON Schema +source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-dates-times-and-duration --- # {{ page.collection }} @@ -12,10 +14,16 @@ layout: default 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 * [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) {% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} diff --git a/registries/_format/double.md b/registries/_format/double.md index 417af4c715..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 }} @@ -19,3 +21,9 @@ 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.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} \ No newline at end of file diff --git a/registries/_format/duration.md b/registries/_format/duration.md new file mode 100644 index 0000000000..e33fe8e942 --- /dev/null +++ b/registries/_format/duration.md @@ -0,0 +1,29 @@ +--- +owner: baywet +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 +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +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 + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} diff --git a/registries/_format/email.md b/registries/_format/email.md new file mode 100644 index 0000000000..9e3976d32d --- /dev/null +++ b/registries/_format/email.md @@ -0,0 +1,29 @@ +--- +owner: baywet +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 +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +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 + +* [#{{ 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/float.md b/registries/_format/float.md index cbe24fdc7b..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 }} @@ -19,3 +21,9 @@ 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.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} \ No newline at end of file diff --git a/registries/_format/hostname.md b/registries/_format/hostname.md new file mode 100644 index 0000000000..f4e237202e --- /dev/null +++ b/registries/_format/hostname.md @@ -0,0 +1,29 @@ +--- +owner: baywet +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 +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is a host name as defined by [RFC1123](https://www.rfc-editor.org/info/rfc1123). + +{% 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/html.md b/registries/_format/html.md index 49b89db7b0..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 }} @@ -19,3 +21,9 @@ The `{{page.slug}}` format represents HTML-formatted text. * [#{{ 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/idn-email.md b/registries/_format/idn-email.md new file mode 100644 index 0000000000..f508b3c343 --- /dev/null +++ b/registries/_format/idn-email.md @@ -0,0 +1,29 @@ +--- +owner: baywet +issue: +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 +--- + +# {{ 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](https://www.rfc-editor.org/rfc/rfc6531). + +{% 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/idn-hostname.md b/registries/_format/idn-hostname.md new file mode 100644 index 0000000000..103213a7ec --- /dev/null +++ b/registries/_format/idn-hostname.md @@ -0,0 +1,29 @@ +--- +owner: baywet +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 +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +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 + +* [#{{ 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/int32.md b/registries/_format/int32.md index a22ed98821..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 }} @@ -19,3 +21,9 @@ 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.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..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 }} @@ -19,3 +21,9 @@ 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.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..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 }} @@ -19,3 +21,9 @@ 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.remarks %} +### Remarks + +{{ page.remarks }} +{% 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..9609c0c1ce --- /dev/null +++ b/registries/_format/ipv4.md @@ -0,0 +1,29 @@ +--- +owner: baywet +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 +--- + +# {{ 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](https://www.rfc-editor.org/info/rfc2673). + +{% 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/ipv6.md b/registries/_format/ipv6.md new file mode 100644 index 0000000000..92732de58f --- /dev/null +++ b/registries/_format/ipv6.md @@ -0,0 +1,29 @@ +--- +owner: baywet +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 +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is an IPv6 address as defined by [RFC4291](https://www.rfc-editor.org/info/rfc4291). + +{% 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/iri-reference.md b/registries/_format/iri-reference.md new file mode 100644 index 0000000000..605d75bbb5 --- /dev/null +++ b/registries/_format/iri-reference.md @@ -0,0 +1,29 @@ +--- +owner: baywet +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 +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +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 + +* [#{{ 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/iri.md b/registries/_format/iri.md new file mode 100644 index 0000000000..605d75bbb5 --- /dev/null +++ b/registries/_format/iri.md @@ -0,0 +1,29 @@ +--- +owner: baywet +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 +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +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 + +* [#{{ 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/json-pointer.md b/registries/_format/json-pointer.md new file mode 100644 index 0000000000..4f96a6d020 --- /dev/null +++ b/registries/_format/json-pointer.md @@ -0,0 +1,29 @@ +--- +owner: baywet +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 +--- + +# {{ 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](https://www.rfc-editor.org/info/rfc6901). + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} diff --git a/registries/_format/password.md b/registries/_format/password.md new file mode 100644 index 0000000000..26216ca175 --- /dev/null +++ b/registries/_format/password.md @@ -0,0 +1,29 @@ +--- +owner: baywet +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 }} + +## {{ 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.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} \ No newline at end of file diff --git a/registries/_format/regex.md b/registries/_format/regex.md new file mode 100644 index 0000000000..2c6de3a2ea --- /dev/null +++ b/registries/_format/regex.md @@ -0,0 +1,29 @@ +--- +owner: baywet +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 +--- + +# {{ 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 %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} diff --git a/registries/_format/relative-json-pointer.md b/registries/_format/relative-json-pointer.md new file mode 100644 index 0000000000..c1eb233a97 --- /dev/null +++ b/registries/_format/relative-json-pointer.md @@ -0,0 +1,31 @@ +--- +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_label: JSON Schema +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 %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} diff --git a/registries/_format/time.md b/registries/_format/time.md new file mode 100644 index 0000000000..d1291fcf02 --- /dev/null +++ b/registries/_format/time.md @@ -0,0 +1,29 @@ +--- +owner: baywet +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 +--- + +# {{ 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://www.rfc-editor.org/rfc/rfc3339.html#section-5.6). + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} diff --git a/registries/_format/uint8.md b/registries/_format/uint8.md index e9919ab03c..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 }} @@ -20,3 +22,8 @@ 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.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} diff --git a/registries/_format/uri-reference.md b/registries/_format/uri-reference.md new file mode 100644 index 0000000000..aeb939857f --- /dev/null +++ b/registries/_format/uri-reference.md @@ -0,0 +1,29 @@ +--- +owner: baywet +issue: +description: A URI reference as defined in [RFC3986](https://www.rfc-editor.org/info/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 +--- + +# {{ 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 %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} diff --git a/registries/_format/uri-template.md b/registries/_format/uri-template.md new file mode 100644 index 0000000000..bf256e4cbc --- /dev/null +++ b/registries/_format/uri-template.md @@ -0,0 +1,29 @@ +--- +owner: baywet +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 +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is a URI Template as defined in [RFC6570](https://www.rfc-editor.org/rfc/rfc6570). + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} diff --git a/registries/_format/uri.md b/registries/_format/uri.md new file mode 100644 index 0000000000..39199b2dc0 --- /dev/null +++ b/registries/_format/uri.md @@ -0,0 +1,29 @@ +--- +owner: baywet +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 +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +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 + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} diff --git a/registries/_format/uuid.md b/registries/_format/uuid.md new file mode 100644 index 0000000000..391843623c --- /dev/null +++ b/registries/_format/uuid.md @@ -0,0 +1,29 @@ +--- +owner: baywet +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 +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format a Universally Unique IDentifier as defined in [RFC4122](https://www.rfc-editor.org/rfc/rfc4122). + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} diff --git a/registry/format.md b/registry/format.md index a23620794e..7f1a9b5f2f 100644 --- a/registry/format.md +++ b/registry/format.md @@ -5,18 +5,14 @@ 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. ## Values -|Value|Description|Issue| -|---|---|---| -{% for value in site.format %}| {{ value.slug }} | {{ value.description }} | {% if value.issue %}#{{ value.issue }}{% endif %} | +|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_note %}Yes{% else %}No{% endif %} | {% endfor %}