diff --git a/registries/_format/ipv4.md b/registries/_format/ipv4.md index 9609c0c1ce..19463a9ee3 100644 --- a/registries/_format/ipv4.md +++ b/registries/_format/ipv4.md @@ -8,22 +8,8 @@ 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 }}`. - +{% capture summary %} The `{{page.slug}}` format is an IPv4 address as defined as dotted-quad by [RFC2673](https://www.rfc-editor.org/info/rfc2673). +{% endcapture %} -{% 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 +{% include format-entry.md summary=summary %} diff --git a/registries/_format/ipv6.md b/registries/_format/ipv6.md index 92732de58f..11ce1f1679 100644 --- a/registries/_format/ipv6.md +++ b/registries/_format/ipv6.md @@ -8,22 +8,8 @@ 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 }}`. - +{% capture summary %} The `{{page.slug}}` format is an IPv6 address as defined by [RFC4291](https://www.rfc-editor.org/info/rfc4291). +{% endcapture %} -{% 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 +{% include format-entry.md summary=summary %} diff --git a/registries/_format/iri-reference.md b/registries/_format/iri-reference.md index 605d75bbb5..ae76e46da0 100644 --- a/registries/_format/iri-reference.md +++ b/registries/_format/iri-reference.md @@ -8,22 +8,8 @@ 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 }}`. - +{% capture summary %} The `{{page.slug}}` format is a Internationalized Resource Identifier as defined in [RFC3987](https://www.rfc-editor.org/info/rfc3987). +{% endcapture %} -{% 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 +{% include format-entry.md summary=summary %} diff --git a/registries/_format/iri.md b/registries/_format/iri.md index 605d75bbb5..ae76e46da0 100644 --- a/registries/_format/iri.md +++ b/registries/_format/iri.md @@ -8,22 +8,8 @@ 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 }}`. - +{% capture summary %} The `{{page.slug}}` format is a Internationalized Resource Identifier as defined in [RFC3987](https://www.rfc-editor.org/info/rfc3987). +{% endcapture %} -{% 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 +{% include format-entry.md summary=summary %} diff --git a/registries/_format/json-pointer.md b/registries/_format/json-pointer.md index 4f96a6d020..5803c2d9e3 100644 --- a/registries/_format/json-pointer.md +++ b/registries/_format/json-pointer.md @@ -8,22 +8,8 @@ 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 }}`. - +{% capture summary %} The `{{page.slug}}` format is a JSON string representation of a JSON Pointer as defined in [RFC6901](https://www.rfc-editor.org/info/rfc6901). +{% endcapture %} -{% if page.issue %} -### GitHub Issue - -* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) -{% endif %} - -{% if page.remarks %} -### Remarks - -{{ page.remarks }} -{% endif %} +{% include format-entry.md summary=summary %} diff --git a/registries/_format/media-range.md b/registries/_format/media-range.md index e15eb7ca4d..7e3f404078 100644 --- a/registries/_format/media-range.md +++ b/registries/_format/media-range.md @@ -8,23 +8,9 @@ source_label: OpenAPI source: https://www.rfc-editor.org/rfc/rfc9110#field.accept --- -# {{ page.collection }} - -## {{ page.slug }} - {{ page.description }} - -Base type: `{{ page.base_type }}`. - +{% capture summary %} The `{{page.slug}}` format is a media type as defined by the `media-range` ABNF production in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110). +{% endcapture %} -{% if page.issue %} -### GitHub Issue - -* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) -{% endif %} - -{% if page.remarks %} -### Remarks - -{{ page.remarks }} -{% endif %} +{% include format-entry.md summary=summary %} diff --git a/registries/_format/password.md b/registries/_format/password.md index 687500e0a7..c3bdcbc04b 100644 --- a/registries/_format/password.md +++ b/registries/_format/password.md @@ -8,22 +8,8 @@ source: https://spec.openapis.org/oas/latest.html#data-types source_label: OAS --- -# {{ page.collection }} - -## {{ page.slug }} - {{ page.description }} - -Base type: `{{ page.base_type }}`. - +{% capture summary %} The `{{page.slug}}` format is a string that hints to obscure the value. +{% endcapture %} -{% if page.issue %} -### GitHub Issue - -* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) -{% endif %} - -{% if page.remarks %} -### Remarks - -{{ page.remarks }} -{% endif %} +{% include format-entry.md summary=summary %} diff --git a/registries/_format/regex.md b/registries/_format/regex.md index 2c6de3a2ea..c5adf6d9ce 100644 --- a/registries/_format/regex.md +++ b/registries/_format/regex.md @@ -8,22 +8,8 @@ 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 }}`. - +{% capture summary %} The `{{page.slug}}` format is a regular expression as defined in ECMA-262. +{% endcapture %} -{% if page.issue %} -### GitHub Issue - -* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) -{% endif %} - -{% if page.remarks %} -### Remarks - -{{ page.remarks }} -{% endif %} +{% include format-entry.md summary=summary %} diff --git a/registries/_format/relative-json-pointer.md b/registries/_format/relative-json-pointer.md index c1eb233a97..d771b21a82 100644 --- a/registries/_format/relative-json-pointer.md +++ b/registries/_format/relative-json-pointer.md @@ -8,24 +8,10 @@ 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 }}`. - +{% capture summary %} 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). +{% endcapture %} -{% if page.issue %} -### GitHub Issue - -* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) -{% endif %} - -{% if page.remarks %} -### Remarks - -{{ page.remarks }} -{% endif %} +{% include format-entry.md summary=summary %} diff --git a/registries/_format/sf-binary.md b/registries/_format/sf-binary.md index d28c1c6665..8c9ba10804 100644 --- a/registries/_format/sf-binary.md +++ b/registries/_format/sf-binary.md @@ -8,12 +8,7 @@ base_type: string layout: default --- -# {{ page.collection }} - -## {{ page.slug }} - {{ page.description }} - -Base type: `{{ page.base_type }}`. - +{% capture summary %} The `{{page.slug}}` format represents a structured fields byte sequence as defined in [RFC8941]. ```abnf @@ -24,18 +19,9 @@ base64 = ALPHA / DIGIT / "+" / "/" / "=" A Byte Sequence is delimited with colons and encoded using base64 ([RFC4648], Section 4). This format is appropriate for a header value that must conform to the {{page.slug}} structured field definition. +{% endcapture %} -{% if page.issue %} -### GitHub Issue - -* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) -{% endif %} - -{% if page.remarks %} -### Remarks - -{{ page.remarks }} -{% endif %} +{% include format-entry.md summary=summary %} [RFC8941]: https://www.rfc-editor.org/rfc/rfc8941#name-byte-sequences [RFC4648]: https://www.rfc-editor.org/rfc/rfc4648#section-4