docs: document what AuthConfig.Auth is

Signed-off-by: Hsing-Yu (David) Chen <davidhsingyuchen@gmail.com>
This commit is contained in:
Hsing-Yu (David) Chen 2022-12-06 21:34:20 -08:00
parent 65d3f7830d
commit 7e1255c3d6
1 changed files with 2 additions and 1 deletions

View File

@ -4,7 +4,8 @@ package types
type AuthConfig struct {
Username string `json:"username,omitempty"`
Password string `json:"password,omitempty"`
Auth string `json:"auth,omitempty"`
// Auth is the base64 encoding of the concatenation of username and password.
Auth string `json:"auth,omitempty"`
// Email is an optional value associated with the username.
// This field is deprecated and will be removed in a later