CLOUDP-355972: Further CRD Comment Fixes (#2924)

Author: roothorp

api/condition.go

@@ -137,6 +137,7 @@ type Condition struct {
 	// Status of the condition, one of True, False, Unknown.
 	Status corev1.ConditionStatus `json:"status"`
 	// Last time the condition transitioned from one status to another.
+	// Represented in ISO 8601 format.
 	// +optional
 	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
 	// The reason for the condition's last transition.

api/v1/atlasbackuppolicy_types.go

@@ -28,7 +28,7 @@ type AtlasBackupPolicySpec struct {
 }
 
 type AtlasBackupPolicyItem struct {
-	// Frequency associated with the backup policy item. One of the following values: hourly, daily, weekly or monthly. You cannot specify multiple hourly and daily backup policy items.
+	// Frequency associated with the backup policy item. You cannot specify multiple hourly and daily backup policy items.
 	// +kubebuilder:validation:Enum:=hourly;daily;weekly;monthly;yearly
 	FrequencyType string `json:"frequencyType"`
 
@@ -37,11 +37,12 @@ type AtlasBackupPolicyItem struct {
 	// +kubebuilder:validation:Enum:=1;2;3;4;5;6;7;8;9;10;11;12;13;14;15;16;17;18;19;20;21;22;23;24;25;26;27;28;40
 	FrequencyInterval int `json:"frequencyInterval"`
 
-	// Scope of the backup policy item: days, weeks, or months.
+	// Unit of time in which MongoDB Atlas measures snapshot retention.
 	// +kubebuilder:validation:Enum:=days;weeks;months;years
 	RetentionUnit string `json:"retentionUnit"`
 
-	// Value to associate with RetentionUnit.
+	// Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot.
+	// For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.
 	RetentionValue int `json:"retentionValue"`
 }
 

api/v1/atlasbackupschedule_types.go

@@ -26,7 +26,7 @@ import (
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/pointer"
 )
 
-// AtlasBackupScheduleSpec defines the desired state of AtlasBackupSchedule
+// AtlasBackupScheduleSpec defines the desired state of AtlasBackupSchedule.
 type AtlasBackupScheduleSpec struct {
 	// Specify true to enable automatic export of cloud backup snapshots to the AWS bucket. You must also define the export policy using export. If omitted, defaults to false.
 	// +optional
@@ -100,7 +100,7 @@ var _ api.AtlasCustomResource = &AtlasBackupSchedule{}
 // +kubebuilder:resource:categories=atlas,shortName=abs
 // +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=`.status.conditions[?(@.type=="Ready")].status`
 //
-// AtlasBackupSchedule is the Schema for the atlasbackupschedules API
+// AtlasBackupSchedule is the Schema for the atlasbackupschedules API.
 type AtlasBackupSchedule struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

api/v1/atlascustomrole_types.go

@@ -66,11 +66,11 @@ type AtlasCustomRoleList struct {
 	Items           []AtlasCustomRole `json:"items"`
 }
 
-// AtlasCustomRoleSpec defines the desired state of CustomRole in Atlas
+// AtlasCustomRoleSpec defines the desired state of CustomRole in Atlas.
 // +kubebuilder:validation:XValidation:rule="(has(self.externalProjectRef) && !has(self.projectRef)) || (!has(self.externalProjectRef) && has(self.projectRef))",message="must define only one project reference through externalProjectRef or projectRef"
 // +kubebuilder:validation:XValidation:rule="(has(self.externalProjectRef) && has(self.connectionSecret)) || !has(self.externalProjectRef)",message="must define a local connection secret when referencing an external project"
 type AtlasCustomRoleSpec struct {
-	// ProjectReference is the dual external or kubernetes reference with access credentials
+	// ProjectReference is the dual external or kubernetes reference with access credentials.
 	ProjectDualReference `json:",inline"`
 	// Role represents a Custom Role in Atlas.
 	Role CustomRole `json:"role"`

api/v1/atlasfederatedauth_types.go

@@ -129,7 +129,7 @@ type RoleAssignment struct {
 	// The Atlas project in the same org in which the role should be given.
 	ProjectName string `json:"projectName,omitempty"`
 	// The role in Atlas that should be given to group members.
-	// +kubebuilder:validation:Enum=ORG_MEMBER;ORG_READ_ONLY;ORG_BILLING_ADMIN;ORG_GROUP_CREATOR;ORG_OWNER;ORG_BILLING_READ_ONLY;ORG_TEAM_MEMBERS_ADMIN;GROUP_AUTOMATION_ADMIN;GROUP_BACKUP_ADMIN;GROUP_MONITORING_ADMIN;GROUP_OWNER;GROUP_READ_ONLY;GROUP_USER_ADMIN;GROUP_BILLING_ADMIN;GROUP_DATA_ACCESS_ADMIN;GROUP_DATA_ACCESS_READ_ONLY;GROUP_DATA_ACCESS_READ_WRITE;GROUP_CHARTS_ADMIN;GROUP_CLUSTER_MANAGER;GROUP_SEARCH_INDEX_EDITOR
+	// +kubebuilder:validation:Enum=ORG_MEMBER;ORG_READ_ONLY;ORG_BILLING_ADMIN;ORG_GROUP_CREATOR;ORG_OWNER;ORG_BILLING_READ_ONLY;ORG_TEAM_MEMBERS_ADMIN;GROUP_AUTOMATION_ADMIN;GROUP_BACKUP_ADMIN;GROUP_MONITORING_ADMIN;GROUP_OWNER;GROUP_READ_ONLY;GROUP_USER_ADMIN;GROUP_BILLING_ADMIN;GROUP_DATA_ACCESS_ADMIN;GROUP_DATA_ACCESS_READ_ONLY;GROUP_DATA_ACCESS_READ_WRITE;GROUP_CHARTS_ADMIN;GROUP_CLUSTER_MANAGER;GROUP_SEARCH_INDEX_EDITOR;GROUP_DATABASE_ACCESS_ADMIN;GROUP_BACKUP_MANAGER;GROUP_STREAM_PROCESSING_OWNER;ORG_STREAM_PROCESSING_ADMIN;GROUP_OBSERVABILITY_VIEWER
 	Role string `json:"role,omitempty"`
 }
 

api/v1/atlasnetworkcontainer_types.go

@@ -58,7 +58,7 @@ type AtlasNetworkContainerList struct {
 // +kubebuilder:validation:XValidation:rule="(self.id == oldSelf.id) || (!has(self.id) && !has(oldSelf.id))",message="id is immutable"
 // +kubebuilder:validation:XValidation:rule="(self.region == oldSelf.region) || (!has(self.region) && !has(oldSelf.region))",message="region is immutable"
 
-// AtlasNetworkContainerSpec defines the desired state of an AtlasNetworkContainer
+// AtlasNetworkContainerSpec defines the desired state of an AtlasNetworkContainer.
 type AtlasNetworkContainerSpec struct {
 	ProjectDualReference `json:",inline"`
 
@@ -67,10 +67,11 @@ type AtlasNetworkContainerSpec struct {
 	// +kubebuilder:validation:Required
 	Provider string `json:"provider"`
 
+	// Collection of settings that configures the network container for a virtual private connection in a cloud provider.
 	AtlasNetworkContainerConfig `json:",inline"`
 }
 
-// AtlasNetworkContainerConfig defines the Atlas specifics of the desired state of a Network Container
+// AtlasNetworkContainerConfig defines the Atlas specifics of the desired state of a Network Container.
 type AtlasNetworkContainerConfig struct {
 	// ID is the container identifier for an already existent network container to be managed by the operator.
 	// This field can be used in conjunction with cidrBlock to update the cidrBlock of an existing container.

api/v1/atlasstreamconnection_types.go

@@ -44,7 +44,7 @@ type ClusterConnectionConfig struct {
 type StreamsClusterDBRole struct {
 	// The name of the role to use. Can be a built-in role or a custom role.
 	Name string `json:"name"`
-	// Type of the DB role. Can be either BuiltIn or Custom.
+	// Type of the DB role. Can be either BUILT_IN or CUSTOM.
 	// +kubebuilder:validation:Enum:=BUILT_IN;CUSTOM
 	RoleType string `json:"type"`
 }

api/v1/projectref.go

@@ -19,19 +19,17 @@ import (
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/api/v1/common"
 )
 
-// ProjectDualReference encapsulates together the frequnet construct to refer to
-// a parent projet by a Kubernetes references, or an external ID, which also
-// reqwuires access credentials in such case
+// ProjectDualReference encapsulates the common constructs to refer to a parent project;
+// by either a Kubernetes reference or an external ID, which also requires access credentials.
 type ProjectDualReference struct {
-	// "projectRef" is a reference to the parent AtlasProject resource.
-	// Mutually exclusive with the "externalProjectRef" field
+	// projectRef is a reference to the parent AtlasProject resource.
+	// Mutually exclusive with the "externalProjectRef" field.
 	// +kubebuilder:validation:Optional
 	ProjectRef *common.ResourceRefNamespaced `json:"projectRef,omitempty"`
-	// "externalProjectRef" holds the parent Atlas project ID.
-	// Mutually exclusive with the "projectRef" field
+	// externalProjectRef holds the parent Atlas project ID.
+	// Mutually exclusive with the "projectRef" field.
 	// +kubebuilder:validation:Optional
 	ExternalProjectRef *ExternalProjectReference `json:"externalProjectRef,omitempty"`
-
-	// Name of the secret containing Atlas API private and public keys
+	// Name of the secret containing Atlas API private and public keys.
 	ConnectionSecret *api.LocalObjectReference `json:"connectionSecret,omitempty"`
 }

api/v1/status/backupschedule.go

@@ -42,5 +42,6 @@ func AtlasBackupScheduleUnsetDeploymentID(ID string) AtlasBackupScheduleStatusOp
 type BackupScheduleStatus struct {
 	api.Common `json:",inline"`
 
+	// List of the human-readable names of all deployments utilizing this backup schedule.
 	DeploymentIDs []string `json:"deploymentID,omitempty"`
 }