diff --git a/deploy/supervisor/idp.supervisor.pinniped.dev_githubidentityproviders.yaml b/deploy/supervisor/idp.supervisor.pinniped.dev_githubidentityproviders.yaml index d14c6773d..0e3b0171d 100644 --- a/deploy/supervisor/idp.supervisor.pinniped.dev_githubidentityproviders.yaml +++ b/deploy/supervisor/idp.supervisor.pinniped.dev_githubidentityproviders.yaml @@ -214,15 +214,20 @@ spec: description: |- Host is required only for GitHub Enterprise Server. Defaults to using GitHub's public API ("github.com"). + For convenience, specifying "github.com" is equivalent to specifying "api.github.com". Do not specify a protocol or scheme since "https://" will always be used. Port is optional. Do not specify a path, query, fragment, or userinfo. - Only domain name or IP address, subdomains (optional), and port (optional). + Only specify domain name or IP address, subdomains (optional), and port (optional). IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address in square brackets. Example: "[::1]:443". minLength: 1 type: string tls: - description: TLS configuration for GitHub Enterprise Server. + description: |- + TLS configuration for GitHub Enterprise Server. + Note that this field should not be needed when using GitHub's public API ("github.com"). + However, if you choose to specify this field when using GitHub's public API, you must + specify a CA bundle that will verify connections to "api.github.com". properties: certificateAuthorityData: description: X.509 Certificate Authority (base64-encoded PEM diff --git a/generated/1.24/README.adoc b/generated/1.24/README.adoc index 55d1e9a75..47daec230 100644 --- a/generated/1.24/README.adoc +++ b/generated/1.24/README.adoc @@ -1740,12 +1740,16 @@ GitHubAPIConfig allows configuration for GitHub Enterprise Server | Field | Description | *`host`* __string__ | Host is required only for GitHub Enterprise Server. + Defaults to using GitHub's public API ("github.com"). + +For convenience, specifying "github.com" is equivalent to specifying "api.github.com". + Do not specify a protocol or scheme since "https://" will always be used. + Port is optional. Do not specify a path, query, fragment, or userinfo. + -Only domain name or IP address, subdomains (optional), and port (optional). + +Only specify domain name or IP address, subdomains (optional), and port (optional). + IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address + in square brackets. Example: "[::1]:443". + | *`tls`* __xref:{anchor_prefix}-go-pinniped-dev-generated-1-24-apis-supervisor-idp-v1alpha1-tlsspec[$$TLSSpec$$]__ | TLS configuration for GitHub Enterprise Server. + +Note that this field should not be needed when using GitHub's public API ("github.com"). + +However, if you choose to specify this field when using GitHub's public API, you must + +specify a CA bundle that will verify connections to "api.github.com". + |=== diff --git a/generated/1.24/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go b/generated/1.24/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go index 437974778..41e05e7ad 100644 --- a/generated/1.24/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go +++ b/generated/1.24/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go @@ -53,9 +53,10 @@ type GitHubIdentityProviderStatus struct { type GitHubAPIConfig struct { // Host is required only for GitHub Enterprise Server. // Defaults to using GitHub's public API ("github.com"). + // For convenience, specifying "github.com" is equivalent to specifying "api.github.com". // Do not specify a protocol or scheme since "https://" will always be used. // Port is optional. Do not specify a path, query, fragment, or userinfo. - // Only domain name or IP address, subdomains (optional), and port (optional). + // Only specify domain name or IP address, subdomains (optional), and port (optional). // IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address // in square brackets. Example: "[::1]:443". // @@ -65,6 +66,9 @@ type GitHubAPIConfig struct { Host *string `json:"host"` // TLS configuration for GitHub Enterprise Server. + // Note that this field should not be needed when using GitHub's public API ("github.com"). + // However, if you choose to specify this field when using GitHub's public API, you must + // specify a CA bundle that will verify connections to "api.github.com". // // +optional TLS *TLSSpec `json:"tls,omitempty"` diff --git a/generated/1.24/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml b/generated/1.24/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml index d14c6773d..0e3b0171d 100644 --- a/generated/1.24/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml +++ b/generated/1.24/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml @@ -214,15 +214,20 @@ spec: description: |- Host is required only for GitHub Enterprise Server. Defaults to using GitHub's public API ("github.com"). + For convenience, specifying "github.com" is equivalent to specifying "api.github.com". Do not specify a protocol or scheme since "https://" will always be used. Port is optional. Do not specify a path, query, fragment, or userinfo. - Only domain name or IP address, subdomains (optional), and port (optional). + Only specify domain name or IP address, subdomains (optional), and port (optional). IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address in square brackets. Example: "[::1]:443". minLength: 1 type: string tls: - description: TLS configuration for GitHub Enterprise Server. + description: |- + TLS configuration for GitHub Enterprise Server. + Note that this field should not be needed when using GitHub's public API ("github.com"). + However, if you choose to specify this field when using GitHub's public API, you must + specify a CA bundle that will verify connections to "api.github.com". properties: certificateAuthorityData: description: X.509 Certificate Authority (base64-encoded PEM diff --git a/generated/1.25/README.adoc b/generated/1.25/README.adoc index 6c20c0159..92794f1b1 100644 --- a/generated/1.25/README.adoc +++ b/generated/1.25/README.adoc @@ -1740,12 +1740,16 @@ GitHubAPIConfig allows configuration for GitHub Enterprise Server | Field | Description | *`host`* __string__ | Host is required only for GitHub Enterprise Server. + Defaults to using GitHub's public API ("github.com"). + +For convenience, specifying "github.com" is equivalent to specifying "api.github.com". + Do not specify a protocol or scheme since "https://" will always be used. + Port is optional. Do not specify a path, query, fragment, or userinfo. + -Only domain name or IP address, subdomains (optional), and port (optional). + +Only specify domain name or IP address, subdomains (optional), and port (optional). + IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address + in square brackets. Example: "[::1]:443". + | *`tls`* __xref:{anchor_prefix}-go-pinniped-dev-generated-1-25-apis-supervisor-idp-v1alpha1-tlsspec[$$TLSSpec$$]__ | TLS configuration for GitHub Enterprise Server. + +Note that this field should not be needed when using GitHub's public API ("github.com"). + +However, if you choose to specify this field when using GitHub's public API, you must + +specify a CA bundle that will verify connections to "api.github.com". + |=== diff --git a/generated/1.25/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go b/generated/1.25/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go index 437974778..41e05e7ad 100644 --- a/generated/1.25/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go +++ b/generated/1.25/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go @@ -53,9 +53,10 @@ type GitHubIdentityProviderStatus struct { type GitHubAPIConfig struct { // Host is required only for GitHub Enterprise Server. // Defaults to using GitHub's public API ("github.com"). + // For convenience, specifying "github.com" is equivalent to specifying "api.github.com". // Do not specify a protocol or scheme since "https://" will always be used. // Port is optional. Do not specify a path, query, fragment, or userinfo. - // Only domain name or IP address, subdomains (optional), and port (optional). + // Only specify domain name or IP address, subdomains (optional), and port (optional). // IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address // in square brackets. Example: "[::1]:443". // @@ -65,6 +66,9 @@ type GitHubAPIConfig struct { Host *string `json:"host"` // TLS configuration for GitHub Enterprise Server. + // Note that this field should not be needed when using GitHub's public API ("github.com"). + // However, if you choose to specify this field when using GitHub's public API, you must + // specify a CA bundle that will verify connections to "api.github.com". // // +optional TLS *TLSSpec `json:"tls,omitempty"` diff --git a/generated/1.25/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml b/generated/1.25/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml index d14c6773d..0e3b0171d 100644 --- a/generated/1.25/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml +++ b/generated/1.25/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml @@ -214,15 +214,20 @@ spec: description: |- Host is required only for GitHub Enterprise Server. Defaults to using GitHub's public API ("github.com"). + For convenience, specifying "github.com" is equivalent to specifying "api.github.com". Do not specify a protocol or scheme since "https://" will always be used. Port is optional. Do not specify a path, query, fragment, or userinfo. - Only domain name or IP address, subdomains (optional), and port (optional). + Only specify domain name or IP address, subdomains (optional), and port (optional). IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address in square brackets. Example: "[::1]:443". minLength: 1 type: string tls: - description: TLS configuration for GitHub Enterprise Server. + description: |- + TLS configuration for GitHub Enterprise Server. + Note that this field should not be needed when using GitHub's public API ("github.com"). + However, if you choose to specify this field when using GitHub's public API, you must + specify a CA bundle that will verify connections to "api.github.com". properties: certificateAuthorityData: description: X.509 Certificate Authority (base64-encoded PEM diff --git a/generated/1.26/README.adoc b/generated/1.26/README.adoc index d38453a85..2e291f103 100644 --- a/generated/1.26/README.adoc +++ b/generated/1.26/README.adoc @@ -1740,12 +1740,16 @@ GitHubAPIConfig allows configuration for GitHub Enterprise Server | Field | Description | *`host`* __string__ | Host is required only for GitHub Enterprise Server. + Defaults to using GitHub's public API ("github.com"). + +For convenience, specifying "github.com" is equivalent to specifying "api.github.com". + Do not specify a protocol or scheme since "https://" will always be used. + Port is optional. Do not specify a path, query, fragment, or userinfo. + -Only domain name or IP address, subdomains (optional), and port (optional). + +Only specify domain name or IP address, subdomains (optional), and port (optional). + IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address + in square brackets. Example: "[::1]:443". + | *`tls`* __xref:{anchor_prefix}-go-pinniped-dev-generated-1-26-apis-supervisor-idp-v1alpha1-tlsspec[$$TLSSpec$$]__ | TLS configuration for GitHub Enterprise Server. + +Note that this field should not be needed when using GitHub's public API ("github.com"). + +However, if you choose to specify this field when using GitHub's public API, you must + +specify a CA bundle that will verify connections to "api.github.com". + |=== diff --git a/generated/1.26/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go b/generated/1.26/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go index 437974778..41e05e7ad 100644 --- a/generated/1.26/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go +++ b/generated/1.26/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go @@ -53,9 +53,10 @@ type GitHubIdentityProviderStatus struct { type GitHubAPIConfig struct { // Host is required only for GitHub Enterprise Server. // Defaults to using GitHub's public API ("github.com"). + // For convenience, specifying "github.com" is equivalent to specifying "api.github.com". // Do not specify a protocol or scheme since "https://" will always be used. // Port is optional. Do not specify a path, query, fragment, or userinfo. - // Only domain name or IP address, subdomains (optional), and port (optional). + // Only specify domain name or IP address, subdomains (optional), and port (optional). // IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address // in square brackets. Example: "[::1]:443". // @@ -65,6 +66,9 @@ type GitHubAPIConfig struct { Host *string `json:"host"` // TLS configuration for GitHub Enterprise Server. + // Note that this field should not be needed when using GitHub's public API ("github.com"). + // However, if you choose to specify this field when using GitHub's public API, you must + // specify a CA bundle that will verify connections to "api.github.com". // // +optional TLS *TLSSpec `json:"tls,omitempty"` diff --git a/generated/1.26/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml b/generated/1.26/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml index d14c6773d..0e3b0171d 100644 --- a/generated/1.26/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml +++ b/generated/1.26/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml @@ -214,15 +214,20 @@ spec: description: |- Host is required only for GitHub Enterprise Server. Defaults to using GitHub's public API ("github.com"). + For convenience, specifying "github.com" is equivalent to specifying "api.github.com". Do not specify a protocol or scheme since "https://" will always be used. Port is optional. Do not specify a path, query, fragment, or userinfo. - Only domain name or IP address, subdomains (optional), and port (optional). + Only specify domain name or IP address, subdomains (optional), and port (optional). IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address in square brackets. Example: "[::1]:443". minLength: 1 type: string tls: - description: TLS configuration for GitHub Enterprise Server. + description: |- + TLS configuration for GitHub Enterprise Server. + Note that this field should not be needed when using GitHub's public API ("github.com"). + However, if you choose to specify this field when using GitHub's public API, you must + specify a CA bundle that will verify connections to "api.github.com". properties: certificateAuthorityData: description: X.509 Certificate Authority (base64-encoded PEM diff --git a/generated/1.27/README.adoc b/generated/1.27/README.adoc index 8f76bded1..c92144a04 100644 --- a/generated/1.27/README.adoc +++ b/generated/1.27/README.adoc @@ -1740,12 +1740,16 @@ GitHubAPIConfig allows configuration for GitHub Enterprise Server | Field | Description | *`host`* __string__ | Host is required only for GitHub Enterprise Server. + Defaults to using GitHub's public API ("github.com"). + +For convenience, specifying "github.com" is equivalent to specifying "api.github.com". + Do not specify a protocol or scheme since "https://" will always be used. + Port is optional. Do not specify a path, query, fragment, or userinfo. + -Only domain name or IP address, subdomains (optional), and port (optional). + +Only specify domain name or IP address, subdomains (optional), and port (optional). + IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address + in square brackets. Example: "[::1]:443". + | *`tls`* __xref:{anchor_prefix}-go-pinniped-dev-generated-1-27-apis-supervisor-idp-v1alpha1-tlsspec[$$TLSSpec$$]__ | TLS configuration for GitHub Enterprise Server. + +Note that this field should not be needed when using GitHub's public API ("github.com"). + +However, if you choose to specify this field when using GitHub's public API, you must + +specify a CA bundle that will verify connections to "api.github.com". + |=== diff --git a/generated/1.27/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go b/generated/1.27/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go index 437974778..41e05e7ad 100644 --- a/generated/1.27/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go +++ b/generated/1.27/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go @@ -53,9 +53,10 @@ type GitHubIdentityProviderStatus struct { type GitHubAPIConfig struct { // Host is required only for GitHub Enterprise Server. // Defaults to using GitHub's public API ("github.com"). + // For convenience, specifying "github.com" is equivalent to specifying "api.github.com". // Do not specify a protocol or scheme since "https://" will always be used. // Port is optional. Do not specify a path, query, fragment, or userinfo. - // Only domain name or IP address, subdomains (optional), and port (optional). + // Only specify domain name or IP address, subdomains (optional), and port (optional). // IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address // in square brackets. Example: "[::1]:443". // @@ -65,6 +66,9 @@ type GitHubAPIConfig struct { Host *string `json:"host"` // TLS configuration for GitHub Enterprise Server. + // Note that this field should not be needed when using GitHub's public API ("github.com"). + // However, if you choose to specify this field when using GitHub's public API, you must + // specify a CA bundle that will verify connections to "api.github.com". // // +optional TLS *TLSSpec `json:"tls,omitempty"` diff --git a/generated/1.27/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml b/generated/1.27/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml index d14c6773d..0e3b0171d 100644 --- a/generated/1.27/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml +++ b/generated/1.27/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml @@ -214,15 +214,20 @@ spec: description: |- Host is required only for GitHub Enterprise Server. Defaults to using GitHub's public API ("github.com"). + For convenience, specifying "github.com" is equivalent to specifying "api.github.com". Do not specify a protocol or scheme since "https://" will always be used. Port is optional. Do not specify a path, query, fragment, or userinfo. - Only domain name or IP address, subdomains (optional), and port (optional). + Only specify domain name or IP address, subdomains (optional), and port (optional). IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address in square brackets. Example: "[::1]:443". minLength: 1 type: string tls: - description: TLS configuration for GitHub Enterprise Server. + description: |- + TLS configuration for GitHub Enterprise Server. + Note that this field should not be needed when using GitHub's public API ("github.com"). + However, if you choose to specify this field when using GitHub's public API, you must + specify a CA bundle that will verify connections to "api.github.com". properties: certificateAuthorityData: description: X.509 Certificate Authority (base64-encoded PEM diff --git a/generated/1.28/README.adoc b/generated/1.28/README.adoc index de0de6e43..11bab11c0 100644 --- a/generated/1.28/README.adoc +++ b/generated/1.28/README.adoc @@ -1740,12 +1740,16 @@ GitHubAPIConfig allows configuration for GitHub Enterprise Server | Field | Description | *`host`* __string__ | Host is required only for GitHub Enterprise Server. + Defaults to using GitHub's public API ("github.com"). + +For convenience, specifying "github.com" is equivalent to specifying "api.github.com". + Do not specify a protocol or scheme since "https://" will always be used. + Port is optional. Do not specify a path, query, fragment, or userinfo. + -Only domain name or IP address, subdomains (optional), and port (optional). + +Only specify domain name or IP address, subdomains (optional), and port (optional). + IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address + in square brackets. Example: "[::1]:443". + | *`tls`* __xref:{anchor_prefix}-go-pinniped-dev-generated-1-28-apis-supervisor-idp-v1alpha1-tlsspec[$$TLSSpec$$]__ | TLS configuration for GitHub Enterprise Server. + +Note that this field should not be needed when using GitHub's public API ("github.com"). + +However, if you choose to specify this field when using GitHub's public API, you must + +specify a CA bundle that will verify connections to "api.github.com". + |=== diff --git a/generated/1.28/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go b/generated/1.28/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go index 437974778..41e05e7ad 100644 --- a/generated/1.28/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go +++ b/generated/1.28/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go @@ -53,9 +53,10 @@ type GitHubIdentityProviderStatus struct { type GitHubAPIConfig struct { // Host is required only for GitHub Enterprise Server. // Defaults to using GitHub's public API ("github.com"). + // For convenience, specifying "github.com" is equivalent to specifying "api.github.com". // Do not specify a protocol or scheme since "https://" will always be used. // Port is optional. Do not specify a path, query, fragment, or userinfo. - // Only domain name or IP address, subdomains (optional), and port (optional). + // Only specify domain name or IP address, subdomains (optional), and port (optional). // IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address // in square brackets. Example: "[::1]:443". // @@ -65,6 +66,9 @@ type GitHubAPIConfig struct { Host *string `json:"host"` // TLS configuration for GitHub Enterprise Server. + // Note that this field should not be needed when using GitHub's public API ("github.com"). + // However, if you choose to specify this field when using GitHub's public API, you must + // specify a CA bundle that will verify connections to "api.github.com". // // +optional TLS *TLSSpec `json:"tls,omitempty"` diff --git a/generated/1.28/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml b/generated/1.28/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml index d14c6773d..0e3b0171d 100644 --- a/generated/1.28/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml +++ b/generated/1.28/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml @@ -214,15 +214,20 @@ spec: description: |- Host is required only for GitHub Enterprise Server. Defaults to using GitHub's public API ("github.com"). + For convenience, specifying "github.com" is equivalent to specifying "api.github.com". Do not specify a protocol or scheme since "https://" will always be used. Port is optional. Do not specify a path, query, fragment, or userinfo. - Only domain name or IP address, subdomains (optional), and port (optional). + Only specify domain name or IP address, subdomains (optional), and port (optional). IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address in square brackets. Example: "[::1]:443". minLength: 1 type: string tls: - description: TLS configuration for GitHub Enterprise Server. + description: |- + TLS configuration for GitHub Enterprise Server. + Note that this field should not be needed when using GitHub's public API ("github.com"). + However, if you choose to specify this field when using GitHub's public API, you must + specify a CA bundle that will verify connections to "api.github.com". properties: certificateAuthorityData: description: X.509 Certificate Authority (base64-encoded PEM diff --git a/generated/1.29/README.adoc b/generated/1.29/README.adoc index 4dc6f2bf7..17c21cf5c 100644 --- a/generated/1.29/README.adoc +++ b/generated/1.29/README.adoc @@ -1740,12 +1740,16 @@ GitHubAPIConfig allows configuration for GitHub Enterprise Server | Field | Description | *`host`* __string__ | Host is required only for GitHub Enterprise Server. + Defaults to using GitHub's public API ("github.com"). + +For convenience, specifying "github.com" is equivalent to specifying "api.github.com". + Do not specify a protocol or scheme since "https://" will always be used. + Port is optional. Do not specify a path, query, fragment, or userinfo. + -Only domain name or IP address, subdomains (optional), and port (optional). + +Only specify domain name or IP address, subdomains (optional), and port (optional). + IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address + in square brackets. Example: "[::1]:443". + | *`tls`* __xref:{anchor_prefix}-go-pinniped-dev-generated-1-29-apis-supervisor-idp-v1alpha1-tlsspec[$$TLSSpec$$]__ | TLS configuration for GitHub Enterprise Server. + +Note that this field should not be needed when using GitHub's public API ("github.com"). + +However, if you choose to specify this field when using GitHub's public API, you must + +specify a CA bundle that will verify connections to "api.github.com". + |=== diff --git a/generated/1.29/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go b/generated/1.29/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go index 437974778..41e05e7ad 100644 --- a/generated/1.29/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go +++ b/generated/1.29/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go @@ -53,9 +53,10 @@ type GitHubIdentityProviderStatus struct { type GitHubAPIConfig struct { // Host is required only for GitHub Enterprise Server. // Defaults to using GitHub's public API ("github.com"). + // For convenience, specifying "github.com" is equivalent to specifying "api.github.com". // Do not specify a protocol or scheme since "https://" will always be used. // Port is optional. Do not specify a path, query, fragment, or userinfo. - // Only domain name or IP address, subdomains (optional), and port (optional). + // Only specify domain name or IP address, subdomains (optional), and port (optional). // IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address // in square brackets. Example: "[::1]:443". // @@ -65,6 +66,9 @@ type GitHubAPIConfig struct { Host *string `json:"host"` // TLS configuration for GitHub Enterprise Server. + // Note that this field should not be needed when using GitHub's public API ("github.com"). + // However, if you choose to specify this field when using GitHub's public API, you must + // specify a CA bundle that will verify connections to "api.github.com". // // +optional TLS *TLSSpec `json:"tls,omitempty"` diff --git a/generated/1.29/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml b/generated/1.29/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml index d14c6773d..0e3b0171d 100644 --- a/generated/1.29/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml +++ b/generated/1.29/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml @@ -214,15 +214,20 @@ spec: description: |- Host is required only for GitHub Enterprise Server. Defaults to using GitHub's public API ("github.com"). + For convenience, specifying "github.com" is equivalent to specifying "api.github.com". Do not specify a protocol or scheme since "https://" will always be used. Port is optional. Do not specify a path, query, fragment, or userinfo. - Only domain name or IP address, subdomains (optional), and port (optional). + Only specify domain name or IP address, subdomains (optional), and port (optional). IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address in square brackets. Example: "[::1]:443". minLength: 1 type: string tls: - description: TLS configuration for GitHub Enterprise Server. + description: |- + TLS configuration for GitHub Enterprise Server. + Note that this field should not be needed when using GitHub's public API ("github.com"). + However, if you choose to specify this field when using GitHub's public API, you must + specify a CA bundle that will verify connections to "api.github.com". properties: certificateAuthorityData: description: X.509 Certificate Authority (base64-encoded PEM diff --git a/generated/1.30/README.adoc b/generated/1.30/README.adoc index 81cc0a298..0659827b6 100644 --- a/generated/1.30/README.adoc +++ b/generated/1.30/README.adoc @@ -1740,12 +1740,16 @@ GitHubAPIConfig allows configuration for GitHub Enterprise Server | Field | Description | *`host`* __string__ | Host is required only for GitHub Enterprise Server. + Defaults to using GitHub's public API ("github.com"). + +For convenience, specifying "github.com" is equivalent to specifying "api.github.com". + Do not specify a protocol or scheme since "https://" will always be used. + Port is optional. Do not specify a path, query, fragment, or userinfo. + -Only domain name or IP address, subdomains (optional), and port (optional). + +Only specify domain name or IP address, subdomains (optional), and port (optional). + IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address + in square brackets. Example: "[::1]:443". + | *`tls`* __xref:{anchor_prefix}-go-pinniped-dev-generated-1-30-apis-supervisor-idp-v1alpha1-tlsspec[$$TLSSpec$$]__ | TLS configuration for GitHub Enterprise Server. + +Note that this field should not be needed when using GitHub's public API ("github.com"). + +However, if you choose to specify this field when using GitHub's public API, you must + +specify a CA bundle that will verify connections to "api.github.com". + |=== diff --git a/generated/1.30/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go b/generated/1.30/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go index 437974778..41e05e7ad 100644 --- a/generated/1.30/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go +++ b/generated/1.30/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go @@ -53,9 +53,10 @@ type GitHubIdentityProviderStatus struct { type GitHubAPIConfig struct { // Host is required only for GitHub Enterprise Server. // Defaults to using GitHub's public API ("github.com"). + // For convenience, specifying "github.com" is equivalent to specifying "api.github.com". // Do not specify a protocol or scheme since "https://" will always be used. // Port is optional. Do not specify a path, query, fragment, or userinfo. - // Only domain name or IP address, subdomains (optional), and port (optional). + // Only specify domain name or IP address, subdomains (optional), and port (optional). // IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address // in square brackets. Example: "[::1]:443". // @@ -65,6 +66,9 @@ type GitHubAPIConfig struct { Host *string `json:"host"` // TLS configuration for GitHub Enterprise Server. + // Note that this field should not be needed when using GitHub's public API ("github.com"). + // However, if you choose to specify this field when using GitHub's public API, you must + // specify a CA bundle that will verify connections to "api.github.com". // // +optional TLS *TLSSpec `json:"tls,omitempty"` diff --git a/generated/1.30/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml b/generated/1.30/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml index d14c6773d..0e3b0171d 100644 --- a/generated/1.30/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml +++ b/generated/1.30/crds/idp.supervisor.pinniped.dev_githubidentityproviders.yaml @@ -214,15 +214,20 @@ spec: description: |- Host is required only for GitHub Enterprise Server. Defaults to using GitHub's public API ("github.com"). + For convenience, specifying "github.com" is equivalent to specifying "api.github.com". Do not specify a protocol or scheme since "https://" will always be used. Port is optional. Do not specify a path, query, fragment, or userinfo. - Only domain name or IP address, subdomains (optional), and port (optional). + Only specify domain name or IP address, subdomains (optional), and port (optional). IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address in square brackets. Example: "[::1]:443". minLength: 1 type: string tls: - description: TLS configuration for GitHub Enterprise Server. + description: |- + TLS configuration for GitHub Enterprise Server. + Note that this field should not be needed when using GitHub's public API ("github.com"). + However, if you choose to specify this field when using GitHub's public API, you must + specify a CA bundle that will verify connections to "api.github.com". properties: certificateAuthorityData: description: X.509 Certificate Authority (base64-encoded PEM diff --git a/generated/latest/README.adoc b/generated/latest/README.adoc index 81cc0a298..0659827b6 100644 --- a/generated/latest/README.adoc +++ b/generated/latest/README.adoc @@ -1740,12 +1740,16 @@ GitHubAPIConfig allows configuration for GitHub Enterprise Server | Field | Description | *`host`* __string__ | Host is required only for GitHub Enterprise Server. + Defaults to using GitHub's public API ("github.com"). + +For convenience, specifying "github.com" is equivalent to specifying "api.github.com". + Do not specify a protocol or scheme since "https://" will always be used. + Port is optional. Do not specify a path, query, fragment, or userinfo. + -Only domain name or IP address, subdomains (optional), and port (optional). + +Only specify domain name or IP address, subdomains (optional), and port (optional). + IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address + in square brackets. Example: "[::1]:443". + | *`tls`* __xref:{anchor_prefix}-go-pinniped-dev-generated-1-30-apis-supervisor-idp-v1alpha1-tlsspec[$$TLSSpec$$]__ | TLS configuration for GitHub Enterprise Server. + +Note that this field should not be needed when using GitHub's public API ("github.com"). + +However, if you choose to specify this field when using GitHub's public API, you must + +specify a CA bundle that will verify connections to "api.github.com". + |=== diff --git a/generated/latest/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go b/generated/latest/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go index 437974778..41e05e7ad 100644 --- a/generated/latest/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go +++ b/generated/latest/apis/supervisor/idp/v1alpha1/types_githubidentityprovider.go @@ -53,9 +53,10 @@ type GitHubIdentityProviderStatus struct { type GitHubAPIConfig struct { // Host is required only for GitHub Enterprise Server. // Defaults to using GitHub's public API ("github.com"). + // For convenience, specifying "github.com" is equivalent to specifying "api.github.com". // Do not specify a protocol or scheme since "https://" will always be used. // Port is optional. Do not specify a path, query, fragment, or userinfo. - // Only domain name or IP address, subdomains (optional), and port (optional). + // Only specify domain name or IP address, subdomains (optional), and port (optional). // IPv4 and IPv6 are supported. If using an IPv6 address with a port, you must enclose the IPv6 address // in square brackets. Example: "[::1]:443". // @@ -65,6 +66,9 @@ type GitHubAPIConfig struct { Host *string `json:"host"` // TLS configuration for GitHub Enterprise Server. + // Note that this field should not be needed when using GitHub's public API ("github.com"). + // However, if you choose to specify this field when using GitHub's public API, you must + // specify a CA bundle that will verify connections to "api.github.com". // // +optional TLS *TLSSpec `json:"tls,omitempty"`