djpbessems/ContainerImage.Pinniped
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix documentation comment for the UpstreamOIDCProvider's spec.client.secretName type.

Browse Source 
The value is correctly validated as `secrets.pinniped.dev/oidc-client` elsewhere, only this comment was wrong.

Signed-off-by: Matt Moyer <moyerm@vmware.com>
This commit is contained in:
Matt Moyer 2020-12-15 21:52:07 -06:00
parent 3d4717b772
commit 404ff93102
No known key found for this signature in database
GPG Key ID: EAE88AD172C5AE2D
11 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apis/supervisor/idp/v1alpha1/types_upstreamoidcprovider.go.tmpl
View File

@ -62,7 +62,7 @@ type OIDCClaims struct {
type OIDCClient struct { type OIDCClient struct {
// SecretName contains the name of a namespace-local Secret object that provides the clientID and // SecretName contains the name of a namespace-local Secret object that provides the clientID and
// clientSecret for an OIDC client. If only the SecretName is specified in an OIDCClient // clientSecret for an OIDC client. If only the SecretName is specified in an OIDCClient
// struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc" with keys // struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc-client" with keys
// "clientID" and "clientSecret". // "clientID" and "clientSecret".
SecretName string `json:"secretName"` SecretName string `json:"secretName"`
} }

2
deploy/supervisor/idp.supervisor.pinniped.dev_upstreamoidcproviders.yaml
View File

@ -86,7 +86,7 @@ spec:
description: SecretName contains the name of a namespace-local description: SecretName contains the name of a namespace-local
Secret object that provides the clientID and clientSecret for Secret object that provides the clientID and clientSecret for
an OIDC client. If only the SecretName is specified in an OIDCClient an OIDC client. If only the SecretName is specified in an OIDCClient
struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc" struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc-client"
with keys "clientID" and "clientSecret". with keys "clientID" and "clientSecret".
type: string type: string
required: required:

2
generated/1.17/README.adoc generated
View File

@ -442,7 +442,7 @@ OIDCClient contains information about an OIDC client (e.g., client ID and client
[cols="25a,75a", options="header"] [cols="25a,75a", options="header"]
|=== |===
| Field | Description | Field | Description
| *`secretName`* __string__ | SecretName contains the name of a namespace-local Secret object that provides the clientID and clientSecret for an OIDC client. If only the SecretName is specified in an OIDCClient struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc" with keys "clientID" and "clientSecret". | *`secretName`* __string__ | SecretName contains the name of a namespace-local Secret object that provides the clientID and clientSecret for an OIDC client. If only the SecretName is specified in an OIDCClient struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc-client" with keys "clientID" and "clientSecret".
|=== |===

2
generated/1.17/apis/supervisor/idp/v1alpha1/types_upstreamoidcprovider.go generated
View File

@ -62,7 +62,7 @@ type OIDCClaims struct {
type OIDCClient struct { type OIDCClient struct {
// SecretName contains the name of a namespace-local Secret object that provides the clientID and // SecretName contains the name of a namespace-local Secret object that provides the clientID and
// clientSecret for an OIDC client. If only the SecretName is specified in an OIDCClient // clientSecret for an OIDC client. If only the SecretName is specified in an OIDCClient
// struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc" with keys // struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc-client" with keys
// "clientID" and "clientSecret". // "clientID" and "clientSecret".
SecretName string `json:"secretName"` SecretName string `json:"secretName"`
} }

2
generated/1.17/crds/idp.supervisor.pinniped.dev_upstreamoidcproviders.yaml generated
View File

@ -86,7 +86,7 @@ spec:
description: SecretName contains the name of a namespace-local description: SecretName contains the name of a namespace-local
Secret object that provides the clientID and clientSecret for Secret object that provides the clientID and clientSecret for
an OIDC client. If only the SecretName is specified in an OIDCClient an OIDC client. If only the SecretName is specified in an OIDCClient
struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc" struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc-client"
with keys "clientID" and "clientSecret". with keys "clientID" and "clientSecret".
type: string type: string
required: required:

2
generated/1.18/README.adoc generated
View File

@ -442,7 +442,7 @@ OIDCClient contains information about an OIDC client (e.g., client ID and client
[cols="25a,75a", options="header"] [cols="25a,75a", options="header"]
|=== |===
| Field | Description | Field | Description
| *`secretName`* __string__ | SecretName contains the name of a namespace-local Secret object that provides the clientID and clientSecret for an OIDC client. If only the SecretName is specified in an OIDCClient struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc" with keys "clientID" and "clientSecret". | *`secretName`* __string__ | SecretName contains the name of a namespace-local Secret object that provides the clientID and clientSecret for an OIDC client. If only the SecretName is specified in an OIDCClient struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc-client" with keys "clientID" and "clientSecret".
|=== |===

2
generated/1.18/apis/supervisor/idp/v1alpha1/types_upstreamoidcprovider.go generated
View File

@ -62,7 +62,7 @@ type OIDCClaims struct {
type OIDCClient struct { type OIDCClient struct {
// SecretName contains the name of a namespace-local Secret object that provides the clientID and // SecretName contains the name of a namespace-local Secret object that provides the clientID and
// clientSecret for an OIDC client. If only the SecretName is specified in an OIDCClient // clientSecret for an OIDC client. If only the SecretName is specified in an OIDCClient
// struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc" with keys // struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc-client" with keys
// "clientID" and "clientSecret". // "clientID" and "clientSecret".
SecretName string `json:"secretName"` SecretName string `json:"secretName"`
} }

2
generated/1.18/crds/idp.supervisor.pinniped.dev_upstreamoidcproviders.yaml generated
View File

@ -86,7 +86,7 @@ spec:
description: SecretName contains the name of a namespace-local description: SecretName contains the name of a namespace-local
Secret object that provides the clientID and clientSecret for Secret object that provides the clientID and clientSecret for
an OIDC client. If only the SecretName is specified in an OIDCClient an OIDC client. If only the SecretName is specified in an OIDCClient
struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc" struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc-client"
with keys "clientID" and "clientSecret". with keys "clientID" and "clientSecret".
type: string type: string
required: required:

2
generated/1.19/README.adoc generated
View File

@ -442,7 +442,7 @@ OIDCClient contains information about an OIDC client (e.g., client ID and client
[cols="25a,75a", options="header"] [cols="25a,75a", options="header"]
|=== |===
| Field | Description | Field | Description
| *`secretName`* __string__ | SecretName contains the name of a namespace-local Secret object that provides the clientID and clientSecret for an OIDC client. If only the SecretName is specified in an OIDCClient struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc" with keys "clientID" and "clientSecret". | *`secretName`* __string__ | SecretName contains the name of a namespace-local Secret object that provides the clientID and clientSecret for an OIDC client. If only the SecretName is specified in an OIDCClient struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc-client" with keys "clientID" and "clientSecret".
|=== |===

2
generated/1.19/apis/supervisor/idp/v1alpha1/types_upstreamoidcprovider.go generated
View File

@ -62,7 +62,7 @@ type OIDCClaims struct {
type OIDCClient struct { type OIDCClient struct {
// SecretName contains the name of a namespace-local Secret object that provides the clientID and // SecretName contains the name of a namespace-local Secret object that provides the clientID and
// clientSecret for an OIDC client. If only the SecretName is specified in an OIDCClient // clientSecret for an OIDC client. If only the SecretName is specified in an OIDCClient
// struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc" with keys // struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc-client" with keys
// "clientID" and "clientSecret". // "clientID" and "clientSecret".
SecretName string `json:"secretName"` SecretName string `json:"secretName"`
} }

2
generated/1.19/crds/idp.supervisor.pinniped.dev_upstreamoidcproviders.yaml generated
View File

@ -86,7 +86,7 @@ spec:
description: SecretName contains the name of a namespace-local description: SecretName contains the name of a namespace-local
Secret object that provides the clientID and clientSecret for Secret object that provides the clientID and clientSecret for
an OIDC client. If only the SecretName is specified in an OIDCClient an OIDC client. If only the SecretName is specified in an OIDCClient
struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc" struct, then it is expected that the Secret is of type "secrets.pinniped.dev/oidc-client"
with keys "clientID" and "clientSecret". with keys "clientID" and "clientSecret".
type: string type: string
required: required: