Skip to content

Commit 68ed2e4

Browse files
authored
Added formats to the registry as defined by OpenAPI v3 (#2857)
* Added formats to the registry as defined by OpenAPI v3 * Fixed date-time format * Removed boolean as format is not needed
1 parent 54da8c5 commit 68ed2e4

File tree

8 files changed

+168
-0
lines changed

8 files changed

+168
-0
lines changed

registries/_format/binary.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
owner: DarrelMiller
3+
issue:
4+
description: any sequence of octets
5+
base_type: string
6+
layout: default
7+
---
8+
9+
# <a href="..">{{ page.collection }}</a>
10+
11+
## {{ page.slug }} - {{ page.description }}
12+
13+
Base type: `{{ page.base_type }}`.
14+
15+
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).
16+
17+
{% if page.issue %}
18+
### GitHub Issue
19+
20+
* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }})
21+
{% endif %}

registries/_format/byte.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
owner: DarrelMiller
3+
issue:
4+
description: base64 encoded characters
5+
base_type: string
6+
layout: default
7+
---
8+
9+
# <a href="..">{{ page.collection }}</a>
10+
11+
## {{ page.slug }} - {{ page.description }}
12+
13+
Base type: `{{ page.base_type }}`.
14+
15+
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).
16+
17+
{% if page.issue %}
18+
### GitHub Issue
19+
20+
* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }})
21+
{% endif %}

registries/_format/date-time.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
owner: DarrelMiller
3+
issue:
4+
description: date and time as defined by date-time - RFC3339
5+
base_type: string
6+
layout: default
7+
---
8+
9+
# <a href="..">{{ page.collection }}</a>
10+
11+
## {{ page.slug }} - {{ page.description }}
12+
13+
Base type: `{{ page.base_type }}`.
14+
15+
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).
16+
17+
{% if page.issue %}
18+
### GitHub Issue
19+
20+
* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }})
21+
{% endif %}

registries/_format/date.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
owner: DarrelMiller
3+
issue:
4+
description: date as defined by full-date - RFC3339
5+
base_type: string
6+
layout: default
7+
---
8+
9+
# <a href="..">{{ page.collection }}</a>
10+
11+
## {{ page.slug }} - {{ page.description }}
12+
13+
Base type: `{{ page.base_type }}`.
14+
15+
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).
16+
17+
{% if page.issue %}
18+
### GitHub Issue
19+
20+
* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }})
21+
{% endif %}

registries/_format/double.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
owner: DarrelMiller
3+
issue:
4+
description: double precision floating point number
5+
base_type: number
6+
layout: default
7+
---
8+
9+
# <a href="..">{{ page.collection }}</a>
10+
11+
## {{ page.slug }} - {{ page.description }}
12+
13+
Base type: `{{ page.base_type }}`.
14+
15+
The `{{page.slug}}` format represents a double precision (64bit) floating point number as defined by [IEEE Std 754-2019](https://ieeexplore.ieee.org/document/8766229). 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).
16+
17+
{% if page.issue %}
18+
### GitHub Issue
19+
20+
* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }})
21+
{% endif %}

registries/_format/float.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
owner: DarrelMiller
3+
issue:
4+
description: single precision floating point number
5+
base_type: number
6+
layout: default
7+
---
8+
9+
# <a href="..">{{ page.collection }}</a>
10+
11+
## {{ page.slug }} - {{ page.description }}
12+
13+
Base type: `{{ page.base_type }}`.
14+
15+
The `{{page.slug}}` format represents a single precision (32bit) floating point number as defined by [IEEE Std 754-2019](https://ieeexplore.ieee.org/document/8766229). 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).
16+
17+
{% if page.issue %}
18+
### GitHub Issue
19+
20+
* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }})
21+
{% endif %}

registries/_format/int32.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
owner: DarrelMiller
3+
issue:
4+
description: signed 32-bit integer
5+
base_type: number
6+
layout: default
7+
---
8+
9+
# <a href="..">{{ page.collection }}</a>
10+
11+
## {{ page.slug }} - {{ page.description }}
12+
13+
Base type: `{{ page.base_type }}`.
14+
15+
The `{{page.slug}}` format represents a signed 32-bit integer, with the range −2,147,483,648 through 2,147,483,647. 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).
16+
17+
{% if page.issue %}
18+
### GitHub Issue
19+
20+
* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }})
21+
{% endif %}

registries/_format/int64.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
owner: DarrelMiller
3+
issue:
4+
description: signed 64-bit integer
5+
base_type: number
6+
layout: default
7+
---
8+
9+
# <a href="..">{{ page.collection }}</a>
10+
11+
## {{ page.slug }} - {{ page.description }}
12+
13+
Base type: `{{ page.base_type }}`.
14+
15+
The `{{page.slug}}` format represents a signed 64-bit integer, with the range -9223372036854775808 through 9223372036854775807. 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).
16+
17+
{% if page.issue %}
18+
### GitHub Issue
19+
20+
* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }})
21+
{% endif %}

0 commit comments

Comments
 (0)