From 50380dcf23596c2520d984c9fb86af76ce3d6c51 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Fri, 3 Mar 2023 14:44:36 -0500 Subject: [PATCH] - adds a base64url format description --- registries/_format/base64url.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 registries/_format/base64url.md diff --git a/registries/_format/base64url.md b/registries/_format/base64url.md new file mode 100644 index 0000000000..0756f637b0 --- /dev/null +++ b/registries/_format/base64url.md @@ -0,0 +1,29 @@ +--- +owner: baywet +issue: +description: Binary data encoded as a url-safe string as defined in [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-5) +base_type: string +layout: default +deprecated_note: '3.1' +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)." +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +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). + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} \ No newline at end of file