Skip to content

Commit 94c8821

Browse files
authored
- adds a base64url format description (#3184)
1 parent 660331f commit 94c8821

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

registries/_format/base64url.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
owner: baywet
3+
issue:
4+
description: Binary data encoded as a url-safe string as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-5)
5+
base_type: string
6+
layout: default
7+
deprecated_note: '3.1'
8+
remarks: "When using OpenAPI 3.1 it's recommended not to use this format and instead use [`contentEncoding` with a value of `base64url`](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-contentencoding)."
9+
---
10+
11+
# <a href="..">{{ page.collection }}</a>
12+
13+
## {{ page.slug }} - {{ page.description }}
14+
15+
Base type: `{{ page.base_type }}`.
16+
17+
The `{{page.slug}}` format is binary data encoded as a url-safe string as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-5).
18+
19+
{% if page.issue %}
20+
### GitHub Issue
21+
22+
* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }})
23+
{% endif %}
24+
25+
{% if page.remarks %}
26+
### Remarks
27+
28+
{{ page.remarks }}
29+
{% endif %}

0 commit comments

Comments
 (0)