InTheForest/moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2026-01-11 10:41:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix base64 encoding description for secrets and configs

Browse Source 
The API documentation incorrectly stated that the Data field for
secrets and configs should use Base64-url-safe-encoded format
(RFC 4648 section 5). However, Docker actually uses standard base64
encoding (RFC 4648 section 4).

This caused confusion when users tried to use URL-safe base64 encoding
and received "illegal base64 data" errors.

Update the documentation to correctly reference RFC 4648 section 4
(standard base64) instead of section 5 (URL-safe base64).

Fixes #37671

Signed-off-by: majiayu000 <1835304752@qq.com>
This commit is contained in:
majiayu000
2025-12-26 17:42:08 +08:00
parent 3bd2edb375
commit 955897fe21
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
api/swagger.yaml
View File

@@ -5700,8 +5700,8 @@ definitions:
com.example.some-other-label: "some-other-value" com.example.some-other-label: "some-other-value"
Data: Data:
description: | description: |
Data is the data to store as a secret, formatted as a Base64-url-safe-encoded Data is the data to store as a secret, formatted as a standard base64-encoded
([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-4)) string.
It must be empty if the Driver field is set, in which case the data is It must be empty if the Driver field is set, in which case the data is
loaded from an external secret store. The maximum allowed size is 500KB, loaded from an external secret store. The maximum allowed size is 500KB,
as defined in [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0/api/validation#MaxSecretSize). as defined in [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0/api/validation#MaxSecretSize).
@@ -5755,8 +5755,8 @@ definitions:
type: "string" type: "string"
Data: Data:
description: | description: |
Data is the data to store as a config, formatted as a Base64-url-safe-encoded Data is the data to store as a config, formatted as a standard base64-encoded
([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-4)) string.
The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize). The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize).
type: "string" type: "string"
Templating: Templating: