From 955897fe210e0a9ee87ee412c65b218b321b3bb4 Mon Sep 17 00:00:00 2001 From: majiayu000 <1835304752@qq.com> Date: Fri, 26 Dec 2025 17:42:08 +0800 Subject: [PATCH] docs: fix base64 encoding description for secrets and configs 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> --- api/swagger.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/api/swagger.yaml b/api/swagger.yaml index 610dc778d8..0be5c5b880 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -5700,8 +5700,8 @@ definitions: com.example.some-other-label: "some-other-value" Data: description: | - Data is the data to store as a secret, formatted as a Base64-url-safe-encoded - ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. + Data is the data to store as a secret, formatted as a standard base64-encoded + ([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 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). @@ -5755,8 +5755,8 @@ definitions: type: "string" Data: description: | - Data is the data to store as a config, formatted as a Base64-url-safe-encoded - ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. + Data is the data to store as a config, formatted as a standard base64-encoded + ([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). type: "string" Templating: