Skip to content

Commit 6503bbe

Browse files
committed
explain base64url and padding
1 parent 5412d63 commit 6503bbe

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ Minor Changes:
4141
* Clarification on how to handle duplicate query parameters
4242
* Replace "servers" clause in OpenAPI files
4343
* Add notes for base64url-encoded values and order of "assetIds" query parameters
44+
* Design Decisions for the HTTP API: Clarify that padding is not allowed for base64url-encoded values (https://github.com/admin-shell-io/aas-specs-api/issues/423[#423])
4445

4546
=== Interface Changes w.r.t. V3.0.3 to V3.1
4647

documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/http-rest-api.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ Identifiers may also be passed as base64url-encoded query parameters, e.g. for s
8383
Such query parameters are typically used when a list of objects may be retrieved in the resulting payload.
8484
A list of base64url-encoded ids is simply passed as comma-separated query parameters.
8585
* Please note that base64url-encoding differs slightly from base64-encoding and has been specifically defined for passing URLs.
86+
In particular, base64url-encoded values shall contain or end with the `=` character (so-called 'padding') to keep them URL-safe.
8687
An appropriate base64url implementation needs to be used for encoding/decoding.
8788
See RFC 4648 for further details.
8889

0 commit comments

Comments
 (0)