Specify base64url rather than base64. Also correct other links to the base64url section of RFC4648
Signed-off-by: Mike Bush <mpbush@gmail.com>
| ... | ... |
@@ -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 |
{
|
| ... | ... |
@@ -3738,7 +3738,7 @@ definitions: |
| 3738 | 3738 |
com.example.some-other-label: "some-other-value" |
| 3739 | 3739 |
Data: |
| 3740 | 3740 |
description: | |
| 3741 |
- Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-3.2)) |
|
| 3741 |
+ Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) |
|
| 3742 | 3742 |
data to store as secret. |
| 3743 | 3743 |
|
| 3744 | 3744 |
This field is only used to _create_ a secret, and is not returned by |
| ... | ... |
@@ -3788,7 +3788,7 @@ definitions: |
| 3788 | 3788 |
type: "string" |
| 3789 | 3789 |
Data: |
| 3790 | 3790 |
description: | |
| 3791 |
- Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-3.2)) |
|
| 3791 |
+ Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) |
|
| 3792 | 3792 |
config data. |
| 3793 | 3793 |
type: "string" |
| 3794 | 3794 |
Templating: |
| ... | ... |
@@ -6840,7 +6840,7 @@ paths: |
| 6840 | 6840 |
required: false |
| 6841 | 6841 |
- name: "X-Registry-Auth" |
| 6842 | 6842 |
in: "header" |
| 6843 |
- description: "A base64-encoded auth configuration. [See the authentication section for details.](#section/Authentication)" |
|
| 6843 |
+ description: "A base64url-encoded auth configuration. [See the authentication section for details.](#section/Authentication)" |
|
| 6844 | 6844 |
type: "string" |
| 6845 | 6845 |
- name: "platform" |
| 6846 | 6846 |
in: "query" |
| ... | ... |
@@ -7068,7 +7068,7 @@ paths: |
| 7068 | 7068 |
type: "string" |
| 7069 | 7069 |
- name: "X-Registry-Auth" |
| 7070 | 7070 |
in: "header" |
| 7071 |
- description: "A base64-encoded auth configuration. [See the authentication section for details.](#section/Authentication)" |
|
| 7071 |
+ description: "A base64url-encoded auth configuration. [See the authentication section for details.](#section/Authentication)" |
|
| 7072 | 7072 |
type: "string" |
| 7073 | 7073 |
required: true |
| 7074 | 7074 |
tags: ["Image"] |
| ... | ... |
@@ -8774,7 +8774,7 @@ paths: |
| 8774 | 8774 |
type: "string" |
| 8775 | 8775 |
- name: "X-Registry-Auth" |
| 8776 | 8776 |
in: "header" |
| 8777 |
- description: "A base64-encoded auth configuration to use when pulling a plugin from a registry. [See the authentication section for details.](#section/Authentication)" |
|
| 8777 |
+ description: "A base64url-encoded auth configuration to use when pulling a plugin from a registry. [See the authentication section for details.](#section/Authentication)" |
|
| 8778 | 8778 |
type: "string" |
| 8779 | 8779 |
- name: "body" |
| 8780 | 8780 |
in: "body" |
| ... | ... |
@@ -8939,7 +8939,7 @@ paths: |
| 8939 | 8939 |
type: "string" |
| 8940 | 8940 |
- name: "X-Registry-Auth" |
| 8941 | 8941 |
in: "header" |
| 8942 |
- description: "A base64-encoded auth configuration to use when pulling a plugin from a registry. [See the authentication section for details.](#section/Authentication)" |
|
| 8942 |
+ description: "A base64url-encoded auth configuration to use when pulling a plugin from a registry. [See the authentication section for details.](#section/Authentication)" |
|
| 8943 | 8943 |
type: "string" |
| 8944 | 8944 |
- name: "body" |
| 8945 | 8945 |
in: "body" |
| ... | ... |
@@ -9636,7 +9636,7 @@ paths: |
| 9636 | 9636 |
foo: "bar" |
| 9637 | 9637 |
- name: "X-Registry-Auth" |
| 9638 | 9638 |
in: "header" |
| 9639 |
- description: "A base64-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" |
|
| 9639 |
+ description: "A base64url-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" |
|
| 9640 | 9640 |
type: "string" |
| 9641 | 9641 |
tags: ["Service"] |
| 9642 | 9642 |
/services/{id}:
|
| ... | ... |
@@ -9795,7 +9795,7 @@ paths: |
| 9795 | 9795 |
type: "string" |
| 9796 | 9796 |
- name: "X-Registry-Auth" |
| 9797 | 9797 |
in: "header" |
| 9798 |
- description: "A base64-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" |
|
| 9798 |
+ description: "A base64url-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)" |
|
| 9799 | 9799 |
type: "string" |
| 9800 | 9800 |
|
| 9801 | 9801 |
tags: ["Service"] |