Skip to content

Encapsulate page layout for formats - Part 3 #3832

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
May 21, 2024
Merged

Encapsulate page layout for formats - Part 3 #3832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
947d226
Encapsulate ipv4
Bellangelo May 21, 2024
1bc08d1
Encapsulate ipv6
Bellangelo May 21, 2024
f23438a
Encapsulate iri
Bellangelo May 21, 2024
6f137bc
Encapsulate iri-reference
Bellangelo May 21, 2024
5093653
Encapsulate json-pointer
Bellangelo May 21, 2024
d014e85
Encapsulate media-range
Bellangelo May 21, 2024
45f311e
Encapsulate password
Bellangelo May 21, 2024
0728946
Encapsulate regex
Bellangelo May 21, 2024
843e501
Encapsulate relative-json-pointer
Bellangelo May 21, 2024
1fce917
Encapsulate binary
Bellangelo May 21, 2024
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/ipv4.md
View file
Open in desktop
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-ip-addresses
---

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

## {{ 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 %}
{% include format-entry.md summary=summary %}
20 changes: 3 additions & 17 deletions registries/_format/ipv6.md
View file
Open in desktop
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-ip-addresses
---

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

## {{ 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 %}
{% include format-entry.md summary=summary %}
20 changes: 3 additions & 17 deletions registries/_format/iri-reference.md
View file
Open in desktop
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 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 %}
{% include format-entry.md summary=summary %}
20 changes: 3 additions & 17 deletions registries/_format/iri.md
View file
Open in desktop
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 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 %}
{% include format-entry.md summary=summary %}
20 changes: 3 additions & 17 deletions registries/_format/json-pointer.md
View file
Open in desktop
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-json-pointers
---

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

## {{ 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 %}
20 changes: 3 additions & 17 deletions registries/_format/media-range.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,9 @@ source_label: OpenAPI
source: https://www.rfc-editor.org/rfc/rfc9110#field.accept
---

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

## {{ 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 %}
20 changes: 3 additions & 17 deletions registries/_format/password.md
View file
Open in desktop
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 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 %}
20 changes: 3 additions & 17 deletions registries/_format/regex.md
View file
Open in desktop
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-regex
---

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

## {{ 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 %}
20 changes: 3 additions & 17 deletions registries/_format/relative-json-pointer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,10 @@ source_label: JSON Schema
source: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-json-pointers
---

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

## {{ 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 %}
20 changes: 3 additions & 17 deletions registries/_format/sf-binary.md
View file
Open in desktop
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 byte sequence as defined in [RFC8941].

```abnf
Expand All @@ -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