[19.03 backport] Update API docs to specify using base64url
| ... | ... |
@@ -65,7 +65,7 @@ info: |
| 65 | 65 |
|
| 66 | 66 |
# Authentication |
| 67 | 67 |
|
| 68 |
- Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a Base64 encoded (JSON) string with the following structure: |
|
| 68 |
+ Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: |
|
| 69 | 69 |
|
| 70 | 70 |
``` |
| 71 | 71 |
{
|
| ... | ... |
@@ -3639,7 +3639,7 @@ definitions: |
| 3639 | 3639 |
com.example.some-other-label: "some-other-value" |
| 3640 | 3640 |
Data: |
| 3641 | 3641 |
description: | |
| 3642 |
- Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-3.2)) |
|
| 3642 |
+ Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) |
|
| 3643 | 3643 |
data to store as secret. |
| 3644 | 3644 |
|
| 3645 | 3645 |
This field is only used to _create_ a secret, and is not returned by |
| ... | ... |
@@ -3689,7 +3689,7 @@ definitions: |
| 3689 | 3689 |
type: "string" |
| 3690 | 3690 |
Data: |
| 3691 | 3691 |
description: | |
| 3692 |
- Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-3.2)) |
|
| 3692 |
+ Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) |
|
| 3693 | 3693 |
config data. |
| 3694 | 3694 |
type: "string" |
| 3695 | 3695 |
Templating: |
| ... | ... |
@@ -6771,7 +6771,7 @@ paths: |
| 6771 | 6771 |
required: false |
| 6772 | 6772 |
- name: "X-Registry-Auth" |
| 6773 | 6773 |
in: "header" |
| 6774 |
- description: "A base64-encoded auth configuration. [See the authentication section for details.](#section/Authentication)" |
|
| 6774 |
+ description: "A base64url-encoded auth configuration. [See the authentication section for details.](#section/Authentication)" |
|
| 6775 | 6775 |
type: "string" |
| 6776 | 6776 |
- name: "platform" |
| 6777 | 6777 |
in: "query" |
| ... | ... |
@@ -6999,7 +6999,7 @@ paths: |
| 6999 | 6999 |
type: "string" |
| 7000 | 7000 |
- name: "X-Registry-Auth" |
| 7001 | 7001 |
in: "header" |
| 7002 |
- description: "A base64-encoded auth configuration. [See the authentication section for details.](#section/Authentication)" |
|
| 7002 |
+ description: "A base64url-encoded auth configuration. [See the authentication section for details.](#section/Authentication)" |
|
| 7003 | 7003 |
type: "string" |
| 7004 | 7004 |
required: true |
| 7005 | 7005 |
tags: ["Image"] |
| ... | ... |
@@ -8705,7 +8705,7 @@ paths: |
| 8705 | 8705 |
type: "string" |
| 8706 | 8706 |
- name: "X-Registry-Auth" |
| 8707 | 8707 |
in: "header" |
| 8708 |
- description: "A base64-encoded auth configuration to use when pulling a plugin from a registry. [See the authentication section for details.](#section/Authentication)" |
|
| 8708 |
+ description: "A base64url-encoded auth configuration to use when pulling a plugin from a registry. [See the authentication section for details.](#section/Authentication)" |
|
| 8709 | 8709 |
type: "string" |
| 8710 | 8710 |
- name: "body" |
| 8711 | 8711 |
in: "body" |
| ... | ... |
@@ -8870,7 +8870,7 @@ paths: |
| 8870 | 8870 |
type: "string" |
| 8871 | 8871 |
- name: "X-Registry-Auth" |
| 8872 | 8872 |
in: "header" |
| 8873 |
- description: "A base64-encoded auth configuration to use when pulling a plugin from a registry. [See the authentication section for details.](#section/Authentication)" |
|
| 8873 |
+ description: "A base64url-encoded auth configuration to use when pulling a plugin from a registry. [See the authentication section for details.](#section/Authentication)" |
|
| 8874 | 8874 |
type: "string" |
| 8875 | 8875 |
- name: "body" |
| 8876 | 8876 |
in: "body" |
| ... | ... |
@@ -9563,7 +9563,7 @@ paths: |
| 9563 | 9563 |
foo: "bar" |
| 9564 | 9564 |
- name: "X-Registry-Auth" |
| 9565 | 9565 |
in: "header" |
| 9566 |
- description: "A base64-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" |
|
| 9566 |
+ description: "A base64url-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" |
|
| 9567 | 9567 |
type: "string" |
| 9568 | 9568 |
tags: ["Service"] |
| 9569 | 9569 |
/services/{id}:
|
| ... | ... |
@@ -9722,7 +9722,7 @@ paths: |
| 9722 | 9722 |
type: "string" |
| 9723 | 9723 |
- name: "X-Registry-Auth" |
| 9724 | 9724 |
in: "header" |
| 9725 |
- description: "A base64-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" |
|
| 9725 |
+ description: "A base64url-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" |
|
| 9726 | 9726 |
type: "string" |
| 9727 | 9727 |
|
| 9728 | 9728 |
tags: ["Service"] |