document allowed enum values and default values in all CR spec fields

This commit is contained in:
Ryan Richard
2024-08-03 14:01:44 -07:00
parent 23129da3e2
commit a40c88ebf3
5 changed files with 12 additions and 3 deletions

View File

@@ -1,4 +1,4 @@
// Copyright 2020-2023 the Pinniped contributors. All Rights Reserved.
// Copyright 2020-2024 the Pinniped contributors. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
package v1alpha1
@@ -55,6 +55,7 @@ type FederationDomainTransformsConstant struct {
Name string `json:"name"`
// Type determines the type of the constant, and indicates which other field should be non-empty.
// Allowed values are "string" or "stringList".
// +kubebuilder:validation:Enum=string;stringList
Type string `json:"type"`
@@ -70,6 +71,7 @@ type FederationDomainTransformsConstant struct {
// FederationDomainTransformsExpression defines a transform expression.
type FederationDomainTransformsExpression struct {
// Type determines the type of the expression. It must be one of the supported types.
// Allowed values are "policy/v1", "username/v1", or "groups/v1".
// +kubebuilder:validation:Enum=policy/v1;username/v1;groups/v1
Type string `json:"type"`

View File

@@ -167,7 +167,10 @@ type GitHubClientSpec struct {
}
type GitHubOrganizationsSpec struct {
// Policy must be set to "AllGitHubUsers" if allowed is empty.
// Allowed values are "OnlyUsersFromAllowedOrganizations" or "AllGitHubUsers".
// Defaults to "OnlyUsersFromAllowedOrganizations".
//
// Must be set to "AllGitHubUsers" if the allowed field is empty.
//
// This field only exists to ensure that Pinniped administrators are aware that an empty list of
// allowedOrganizations means all GitHub users are allowed to log in.

View File

@@ -7,6 +7,7 @@ package v1alpha1
type CertificateAuthorityDataSourceSpec struct {
// Kind configures whether the CA bundle is being sourced from a Kubernetes secret or a configmap.
// Secrets must be of type kubernetes.io/tls or Opaque.
// Allowed values are "Secret" or "ConfigMap".
// +kubebuilder:validation:Enum=Secret;ConfigMap
Kind string `json:"kind"`
// Name is the resource name of the secret or configmap from which to read the CA bundle.