Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 3 additions & 17 deletions registries/_format/sf-boolean.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@ base_type: string
layout: default
---

# <a href="..">{{ page.collection }}</a>

## {{ page.slug }} - {{ page.description }}

Base type: `{{ page.base_type }}`.

{% capture summary %}
The `{{page.slug}}` format represents a structured fields boolean as defined in [RFC8941].

```abnf
Expand All @@ -24,17 +19,8 @@ boolean = "0" / "1"
A Boolean is indicated with a leading "?" character followed by a "1" for a true value or "0" for false.

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-booleans
20 changes: 3 additions & 17 deletions registries/_format/sf-decimal.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@ base_type: number
layout: default
---

# <a href="..">{{ page.collection }}</a>

## {{ page.slug }} - {{ page.description }}

Base type: `{{ page.base_type }}`.

{% capture summary %}
The `{{page.slug}}` format represents a structured fields decimal as defined in [RFC8941].

```abnf
Expand All @@ -24,17 +19,8 @@ Decimals are numbers with an integer and a fractional component.
The integer component has at most 12 digits; the fractional component has at most three digits.

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-decimals
22 changes: 4 additions & 18 deletions registries/_format/sf-integer.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@ base_type: [integer, number]
layout: default
---

# <a href="..">{{ page.collection }}</a>

## {{ page.slug }} - {{ page.description }}

Base type: `{{ page.base_type }}`.

{% capture summary %}
The `{{page.slug}}` format represents a structured fields integer as defined in [RFC8941].

```abnf
Expand All @@ -24,18 +19,9 @@ Integers have a range of -999,999,999,999,999 to 999,999,999,999,999 inclusive (
for IEEE 754 compatibility [IEEE754].

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-integers
[IEEE754]: https://ieeexplore.ieee.org/document/8766229
[IEEE754]: https://ieeexplore.ieee.org/document/8766229
20 changes: 3 additions & 17 deletions registries/_format/sf-string.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@ base_type: string
layout: default
---

# <a href="..">{{ page.collection }}</a>

## {{ page.slug }} - {{ page.description }}

Base type: `{{ page.base_type }}`.

{% capture summary %}
The `{{page.slug}}` format represents a structured fields string as defined in [RFC8941].

```abnf
Expand All @@ -29,17 +24,8 @@ Note that this excludes tabs, newlines, carriage returns, etc.
Strings are delimited with double quotes, using a backslash ("\") to escape double quotes and backslashes.

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-strings
20 changes: 3 additions & 17 deletions registries/_format/sf-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@ base_type: string
layout: default
---

# <a href="..">{{ page.collection }}</a>

## {{ page.slug }} - {{ page.description }}

Base type: `{{ page.base_type }}`.

{% capture summary %}
The `{{page.slug}}` format represents a structured fields token as defined in [RFC8941].

```abnf
Expand All @@ -23,17 +18,8 @@ sf-token = ( ALPHA / "*" ) *( tchar / ":" / "/" )
Tokens are short textual words; their abstract model is identical to their expression in the HTTP field value serialization.

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-tokens
20 changes: 3 additions & 17 deletions registries/_format/time.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,8 @@ source_label: JSON Schema
source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-dates-times-and-duration
---

# <a href="..">{{ page.collection }}</a>

## {{ page.slug }} - {{ page.description }}

Base type: `{{ page.base_type }}`.

{% capture summary %}
The `{{page.slug}}` format represents a time as defined by full-time - [RFC3339](https://www.rfc-editor.org/rfc/rfc3339.html#section-5.6).
{% 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 %}
20 changes: 3 additions & 17 deletions registries/_format/uint8.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,8 @@ source: https://spec.openapis.org/oas/latest.html#data-types
source_label: OAS
---

# <a href="..">{{ page.collection }}</a>

## {{ page.slug }} - {{ page.description }}

Base type: `{{ page.base_type }}`.

{% capture summary %}
The `{{page.slug}}` format represents an unsigned 8-bit integer, with the range 0 to 255.
{% 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 %}
20 changes: 3 additions & 17 deletions registries/_format/uri-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,8 @@ source_label: JSON Schema
source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers
---

# <a href="..">{{ page.collection }}</a>

## {{ page.slug }} - {{ page.description }}

Base type: `{{ page.base_type }}`.

{% capture summary %}
The `{{page.slug}}` format is a URI reference as defined in RFC3986.
{% 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 %}
20 changes: 3 additions & 17 deletions registries/_format/uri-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,8 @@ source_label: JSON Schema
source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-uri-template
---

# <a href="..">{{ page.collection }}</a>

## {{ page.slug }} - {{ page.description }}

Base type: `{{ page.base_type }}`.

{% capture summary %}
The `{{page.slug}}` format is a URI Template as defined in [RFC6570](https://www.rfc-editor.org/rfc/rfc6570).
{% 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 %}
20 changes: 3 additions & 17 deletions registries/_format/uri.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,8 @@ source_label: JSON Schema
source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers
---

# <a href="..">{{ page.collection }}</a>

## {{ page.slug }} - {{ page.description }}

Base type: `{{ page.base_type }}`.

{% capture summary %}
The `{{page.slug}}` format is a Uniform Resource Identifier as defined in [RFC3986](https://www.rfc-editor.org/rfc/rfc3986.html).
{% 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 %}
20 changes: 3 additions & 17 deletions registries/_format/uuid.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,8 @@ source_label: JSON Schema
source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-resource-identifiers
---

# <a href="..">{{ page.collection }}</a>

## {{ page.slug }} - {{ page.description }}

Base type: `{{ page.base_type }}`.

{% capture summary %}
The `{{page.slug}}` format a Universally Unique IDentifier as defined in [RFC4122](https://www.rfc-editor.org/rfc/rfc4122).
{% 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 %}