Merge pull request #289 from mattmoyer/fix-secret-type-doc-comment
Fix documentation comment for the UpstreamOIDCProvider's spec.client.secretName type.
This commit is contained in:
commit
bc1dc0805e
@ -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"`
|
||||||
}
|
}
|
||||||
|
@ -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
2
generated/1.17/README.adoc
generated
@ -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".
|
||||||
|===
|
|===
|
||||||
|
|
||||||
|
|
||||||
|
@ -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"`
|
||||||
}
|
}
|
||||||
|
@ -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
2
generated/1.18/README.adoc
generated
@ -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".
|
||||||
|===
|
|===
|
||||||
|
|
||||||
|
|
||||||
|
@ -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"`
|
||||||
}
|
}
|
||||||
|
@ -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
2
generated/1.19/README.adoc
generated
@ -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".
|
||||||
|===
|
|===
|
||||||
|
|
||||||
|
|
||||||
|
@ -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"`
|
||||||
}
|
}
|
||||||
|
@ -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:
|
||||||
|
Loading…
Reference in New Issue
Block a user