Skip to content
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.

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

adds missing formats in the registry #3167

Merged
merged 53 commits into from
Mar 6, 2023
Merged
Show file tree
Hide file tree
Changes from 49 commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
396dd29
- typo fix
baywet Feb 20, 2023
5ec2935
- adds UUID format
baywet Feb 20, 2023
89f3a39
- adds URI format
baywet Feb 20, 2023
4db0d98
- moves source links to YAML header so it can be in the table as well
baywet Feb 20, 2023
542fb7f
- adds URI template, IRI, IRI reference and URI reference
baywet Feb 20, 2023
569662c
- adds time and duration formats
baywet Feb 20, 2023
fb02c14
- adds email and idn email formats
baywet Feb 20, 2023
055f1b2
- adds ipv4, v6, hostname and idn hostname formats
baywet Feb 20, 2023
6efed9f
- adds json and relative json pointers
baywet Feb 20, 2023
4662a6c
- adds regex
baywet Feb 20, 2023
264e1d1
- adds base64 url format
baywet Feb 20, 2023
d06da41
- adds decimal format
baywet Feb 20, 2023
2615957
- adds char format
baywet Feb 20, 2023
601b44a
- typo fix
baywet Feb 20, 2023
162a2cb
- switches base type for decimal to number
baywet Feb 20, 2023
7cdeff4
- removes link to master issue
baywet Feb 21, 2023
c003887
- adds recommendation for binary format in 3.1
baywet Feb 21, 2023
1e853a5
Update registries/_format/date.md
baywet Feb 21, 2023
b65583a
- fixes link to duration spec
baywet Feb 21, 2023
b14a766
- fixes email RFC number
baywet Feb 21, 2023
0267989
- adds email rfc link
baywet Feb 21, 2023
3cd829b
- adds IDN hostname RFC link
baywet Feb 21, 2023
edc8260
- adds idn email RFC link
baywet Feb 21, 2023
da95b86
- adds base type, version and remarks to format table
baywet Feb 21, 2023
5f92e2b
- adds version and remarks for binary format
baywet Feb 21, 2023
c92ab8e
- adds support for floating points in decimal
baywet Feb 21, 2023
63381fa
Apply suggestions from code review
baywet Feb 21, 2023
ba4fdca
- adds int16 to the format list
baywet Feb 22, 2023
145da5a
- adds link to the base64 url RFC
baywet Feb 23, 2023
dc6434e
- adds remark for base64url format
baywet Feb 23, 2023
ea6e131
- adds link to the base64 url RFC
baywet Feb 23, 2023
ffc64ff
- fixes link to source
baywet Feb 23, 2023
63bcd4d
- adds details about base64, base64url and byte formats
baywet Feb 24, 2023
cb88824
- typo fix
baywet Feb 24, 2023
a3579e7
- adds links to base64 RFC
baywet Feb 24, 2023
02c4736
- first batch of review suggestions
baywet Feb 27, 2023
6d465a7
- second batch of PR feedback
baywet Feb 27, 2023
fda1091
- third batch of PR review suggestions
baywet Feb 27, 2023
bafc271
- moves and renames version column for formats
baywet Mar 1, 2023
b9cc7e5
- adds password format
baywet Mar 1, 2023
05dde66
- adds a source label for formats
baywet Mar 1, 2023
21cd16a
- removes examples from registry entries
baywet Mar 3, 2023
df38fa5
- removes remarks column in formats
baywet Mar 3, 2023
96e0665
- renames oas version to deprecated version
baywet Mar 3, 2023
a089e13
Update registry/format.md
baywet Mar 3, 2023
f5b9c99
- changes the deprecation to a true/false in the table
baywet Mar 3, 2023
d3cf349
- removes the deprecation notice from detail pages
baywet Mar 3, 2023
d95a945
- renames deprecated version to note as PR feedback
baywet Mar 3, 2023
1e69c4e
- moves base64url, int16 and char to separate PRs
baywet Mar 3, 2023
95143fb
Apply suggestions from code review
baywet Mar 6, 2023
1cae0da
- moves decimal to a separate PR
baywet Mar 6, 2023
b3a0558
- adds OAS source for relevant formats
baywet Mar 6, 2023
be4f9f7
Update registries/_format/idn-email.md
baywet Mar 6, 2023
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
10 changes: 9 additions & 1 deletion registries/_format/binary.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ 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."
---

# <a href="..">{{ page.collection }}</a>
Expand All @@ -12,10 +14,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).
baywet marked this conversation as resolved.
Show resolved Hide resolved

{% if page.issue %}
### GitHub Issue

* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }})
{% endif %}

{% if page.remarks %}
### Remarks

{{ page.remarks }}
{% endif %}
12 changes: 10 additions & 2 deletions registries/_format/byte.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
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: base64url`](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)."
darrelmiller marked this conversation as resolved.
Show resolved Hide resolved
baywet marked this conversation as resolved.
Show resolved Hide resolved
---

# <a href="..">{{ page.collection }}</a>
Expand All @@ -12,10 +14,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 %}
6 changes: 6 additions & 0 deletions registries/_format/commonmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,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 %}
12 changes: 10 additions & 2 deletions registries/_format/date-time.md
Original file line number Diff line number Diff line change
@@ -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
---

# <a href="..">{{ page.collection }}</a>
Expand All @@ -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 %}

baywet marked this conversation as resolved.
Show resolved Hide resolved
{% if page.remarks %}
### Remarks

{{ page.remarks }}
{% endif %}
12 changes: 10 additions & 2 deletions registries/_format/date.md
Original file line number Diff line number Diff line change
@@ -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
---

# <a href="..">{{ page.collection }}</a>
Expand All @@ -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

baywet marked this conversation as resolved.
Show resolved Hide resolved
* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }})
{% endif %}

{% if page.remarks %}
### Remarks

{{ page.remarks }}
{% endif %}
27 changes: 27 additions & 0 deletions registries/_format/decimal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
owner: baywet
issue:
description: A fixed or floating point decimal number as defined by ISO/IEC 9075-2 2016 12 15
base_type: string
layout: default
---

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

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

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

The `{{page.slug}}` format represents a fixed or floating point decimal number as defined by ISO/IEC 9075-2 2016 12 15.

{% if page.issue %}
### GitHub Issue

* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }})
{% endif %}

{% if page.remarks %}
### Remarks

{{ page.remarks }}
{% endif %}
6 changes: 6 additions & 0 deletions registries/_format/double.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,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 %}
29 changes: 29 additions & 0 deletions registries/_format/duration.md
Original file line number Diff line number Diff line change
@@ -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
---

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

## {{ 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 %}
29 changes: 29 additions & 0 deletions registries/_format/email.md
Original file line number Diff line number Diff line change
@@ -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
---

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

## {{ 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 %}
6 changes: 6 additions & 0 deletions registries/_format/float.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,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 %}
29 changes: 29 additions & 0 deletions registries/_format/hostname.md
Original file line number Diff line number Diff line change
@@ -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
---

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

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

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

The `{{page.slug}}` format is a host name as defined by RFC1123.
baywet marked this conversation as resolved.
Show resolved Hide resolved

{% if page.issue %}
### GitHub Issue

* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }})
{% endif %}

{% if page.remarks %}
### Remarks

{{ page.remarks }}
{% endif %}
6 changes: 6 additions & 0 deletions registries/_format/html.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,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 %}
29 changes: 29 additions & 0 deletions registries/_format/idn-email.md
Original file line number Diff line number Diff line change
@@ -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
https://json-schema.org/draft/2020-12/json-schema-validation.html#name-email-addresses
darrelmiller marked this conversation as resolved.
Show resolved Hide resolved
baywet marked this conversation as resolved.
Show resolved Hide resolved
---

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

## {{ 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 %}
29 changes: 29 additions & 0 deletions registries/_format/idn-hostname.md
Original file line number Diff line number Diff line change
@@ -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
---

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

## {{ 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 %}
6 changes: 6 additions & 0 deletions registries/_format/int32.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,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 %}
6 changes: 6 additions & 0 deletions registries/_format/int64.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,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 %}
6 changes: 6 additions & 0 deletions registries/_format/int8.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,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 %}
Loading