CLOUDP-355972: More CRD Comment Updates (#3019)

roothorp · web-flow · commit f9b80104e44d · 2025-12-15T14:57:51.000Z
* update comments per doc team review

* make api-docs
diff --git a/api/condition.go b/api/condition.go
@@ -134,7 +134,7 @@ const (
 type Condition struct {
 	// Type of Atlas Custom Resource condition.
 	Type ConditionType `json:"type"`
-	// Status of the condition, one of True, False, Unknown.
+	// 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.
@@ -143,7 +143,7 @@ type Condition struct {
 	// The reason for the condition's last transition.
 	// +optional
 	Reason string `json:"reason,omitempty"`
-	// A human readable message indicating details about the transition.
+	// A message providing details about the transition.
 	// +optional
 	Message string `json:"message,omitempty"`
 }
diff --git a/api/status.go b/api/status.go
@@ -44,8 +44,8 @@ type Common struct {
 	// Conditions is the list of statuses showing the current state of the Atlas Custom Resource
 	Conditions []Condition `json:"conditions"`
 
-	// ObservedGeneration indicates the generation of the resource specification that the Atlas Operator is aware of.
-	// The Atlas Operator updates this field to the 'metadata.generation' as soon as it starts reconciliation of the resource.
+	// ObservedGeneration indicates the generation of the resource specification of which the Atlas Operator is aware.
+	// The Atlas Operator updates this field to the value of 'metadata.generation' as soon as it starts reconciliation of the resource.
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 }
 
diff --git a/api/v1/atlasbackupcompliancepolicy_types.go b/api/v1/atlasbackupcompliancepolicy_types.go
@@ -30,7 +30,7 @@ func init() {
 	SchemeBuilder.Register(&AtlasBackupCompliancePolicy{}, &AtlasBackupCompliancePolicyList{})
 }
 
-// AtlasBackupCompliancePolicy defines the desired state of a compliance policy in Atlas.
+// AtlasBackupCompliancePolicy defines the target state of a compliance policy in Atlas.
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
@@ -46,29 +46,30 @@ type AtlasBackupCompliancePolicy struct {
 	Status status.BackupCompliancePolicyStatus `json:"status,omitempty"`
 }
 
-// AtlasBackupCompliancePolicySpec is the specification of the desired configuration of backup compliance policy
+// AtlasBackupCompliancePolicySpec is the specification of the desired backup compliance policy configuration.
 type AtlasBackupCompliancePolicySpec struct {
-	// Email address of the user who authorized to update the Backup Compliance Policy settings.
+	// Email address of the user authorized to update Backup Compliance Policy settings.
 	// +kubebuilder:validation:Required
 	AuthorizedEmail string `json:"authorizedEmail"`
-	// First name of the user who authorized to updated the Backup Compliance Policy settings.
+	// First name of the user authorized to update the Backup Compliance Policy settings.
 	// +kubebuilder:validation:Required
 	AuthorizedUserFirstName string `json:"authorizedUserFirstName"`
-	// Last name of the user who authorized to updated the Backup Compliance Policy settings.
+	// Last name of the user authorized to update the Backup Compliance Policy settings.
 	// +kubebuilder:validation:Required
 	AuthorizedUserLastName string `json:"authorizedUserLastName"`
 	// Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed.
 	// +kubebuilder:validation:default:=false
 	CopyProtectionEnabled bool `json:"copyProtectionEnabled,omitempty"`
-	// Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy.
+	// Flag that indicates whether to require Encryption at Rest using Customer Key Management for all clusters with a Backup Compliance Policy.
 	// +kubebuilder:validation:default:=false
 	EncryptionAtRestEnabled bool `json:"encryptionAtRestEnabled,omitempty"`
-	// Flag that indicates whether to overwrite non-complying backup policies with the new data protection settings or not.
+	// Flag that indicates whether to overwrite non-complying backup policies with the new data protection settings.
 	OverwriteBackupPolicies bool `json:"overwriteBackupPolicies,omitempty"`
 	// Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy.
 	// +kubebuilder:validation:default:=false
 	PITEnabled bool `json:"pointInTimeEnabled,omitempty"`
-	// Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
+	// Number of previous days from which you can restore with Continuous Cloud Backup with a Backup Compliance Policy.
+	// This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
 	RestoreWindowDays int `json:"restoreWindowDays,omitempty"`
 	// List that contains the specifications for one scheduled policy.
 	ScheduledPolicyItems []AtlasBackupPolicyItem `json:"scheduledPolicyItems,omitempty"`
diff --git a/api/v1/atlasbackuppolicy_types.go b/api/v1/atlasbackuppolicy_types.go
@@ -21,19 +21,19 @@ import (
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/api/v1/status"
 )
 
-// AtlasBackupPolicySpec defines the desired state of AtlasBackupPolicy
+// AtlasBackupPolicySpec defines the target state of AtlasBackupPolicy.
 type AtlasBackupPolicySpec struct {
 	// A list of BackupPolicy items.
 	Items []AtlasBackupPolicyItem `json:"items"`
 }
 
 type AtlasBackupPolicyItem struct {
-	// Frequency associated with the backup policy item. You cannot specify multiple hourly and daily backup policy items.
+	// Frequency associated with the backup policy item. You can specify only one each of hourly or daily backup policy items.
 	// +kubebuilder:validation:Enum:=hourly;daily;weekly;monthly;yearly
 	FrequencyType string `json:"frequencyType"`
 
-	// Desired frequency of the new backup policy item specified by FrequencyType. A value of 1 specifies the first instance of the corresponding FrequencyType.
-	// The only accepted value you can set for frequency interval with NVMe clusters is 12.
+	// Frequency of the new backup policy item specified by FrequencyType. A value of 1 specifies the first instance of the corresponding FrequencyType.
+	// You can set FrequencyInterval only to 12 for NVMe clusters.
 	// +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"`
 
diff --git a/api/v1/atlasbackupschedule_types.go b/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 target 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
diff --git a/api/v1/atlascustomrole_types.go b/api/v1/atlascustomrole_types.go
@@ -66,7 +66,7 @@ type AtlasCustomRoleList struct {
 	Items           []AtlasCustomRole `json:"items"`
 }
 
-// AtlasCustomRoleSpec defines the desired state of CustomRole in Atlas.
+// AtlasCustomRoleSpec defines the target 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 {
diff --git a/api/v1/atlasdatabaseuser_types.go b/api/v1/atlasdatabaseuser_types.go
@@ -48,7 +48,7 @@ const (
 	DataLakeScopeType   ScopeType = "DATA_LAKE"
 )
 
-// AtlasDatabaseUserSpec defines the desired state of Database User in Atlas
+// AtlasDatabaseUserSpec defines the target state of Database User 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 AtlasDatabaseUserSpec struct {
diff --git a/api/v1/atlasdatafederation_types.go b/api/v1/atlasdatafederation_types.go
@@ -28,7 +28,7 @@ func init() {
 	SchemeBuilder.Register(&AtlasDataFederation{}, &AtlasDataFederationList{})
 }
 
-// DataFederationSpec defines the desired state of AtlasDataFederation.
+// DataFederationSpec defines the target state of AtlasDataFederation.
 type DataFederationSpec struct {
 	// Project is a reference to AtlasProject resource the deployment belongs to.
 	Project common.ResourceRefNamespaced `json:"projectRef"`
diff --git a/api/v1/atlasdeployment_types.go b/api/v1/atlasdeployment_types.go
@@ -39,7 +39,7 @@ const (
 	TypeGeoSharded DeploymentType = "GEOSHARDED"
 )
 
-// AtlasDeploymentSpec defines the desired state of AtlasDeployment.
+// AtlasDeploymentSpec defines the target state of AtlasDeployment.
 // Only one of DeploymentSpec, AdvancedDeploymentSpec and ServerlessSpec should be defined.
 // +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"
@@ -185,7 +185,7 @@ func (s *AdvancedDeploymentSpec) SearchNodesToAtlas() []admin.ApiSearchDeploymen
 	return result
 }
 
-// ServerlessSpec defines the desired state of Atlas Serverless Instance.
+// ServerlessSpec defines the target state of Atlas Serverless Instance.
 // DEPRECATED: Serverless instances are deprecated. See https://dochub.mongodb.org/core/atlas-flex-migration for details.
 type ServerlessSpec struct {
 	// Name of the serverless deployment as it appears in Atlas.
diff --git a/api/v1/atlasfederatedauth_types.go b/api/v1/atlasfederatedauth_types.go
@@ -32,7 +32,7 @@ func init() {
 	SchemeBuilder.Register(&AtlasFederatedAuth{}, &AtlasFederatedAuthList{})
 }
 
-// AtlasFederatedAuthSpec defines the desired state of AtlasFederatedAuth.
+// AtlasFederatedAuthSpec defines the target state of AtlasFederatedAuth.
 type AtlasFederatedAuthSpec struct {
 	// +kubebuilder:default:=false
 	Enabled bool `json:"enabled,omitempty"`
diff --git a/api/v1/atlasipaccesslist_types.go b/api/v1/atlasipaccesslist_types.go
@@ -28,7 +28,7 @@ func init() {
 // +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"
 
-// AtlasIPAccessListSpec defines the desired state of AtlasIPAccessList.
+// AtlasIPAccessListSpec defines the target state of AtlasIPAccessList.
 type AtlasIPAccessListSpec struct {
 	// ProjectReference is the dual external or kubernetes reference with access credentials.
 	ProjectDualReference `json:",inline"`
diff --git a/api/v1/atlasnetworkcontainer_types.go b/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 target state of an AtlasNetworkContainer.
 type AtlasNetworkContainerSpec struct {
 	ProjectDualReference `json:",inline"`
 
diff --git a/api/v1/atlasnetworkpeering_types.go b/api/v1/atlasnetworkpeering_types.go
@@ -52,7 +52,7 @@ type AtlasNetworkPeeringList struct {
 	Items           []AtlasNetworkPeering `json:"items"`
 }
 
-// AtlasNetworkPeeringSpec defines the desired state of AtlasNetworkPeering
+// AtlasNetworkPeeringSpec defines the target state of AtlasNetworkPeering.
 // +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"
 // +kubebuilder:validation:XValidation:rule="(has(self.containerRef.name) && !has(self.containerRef.id)) || (!has(self.containerRef.name) && has(self.containerRef.id))",message="must either have a container Atlas id or Kubernetes name, but not both (or neither)"
diff --git a/api/v1/atlasproject_types.go b/api/v1/atlasproject_types.go
@@ -39,7 +39,7 @@ func init() {
 	SchemeBuilder.Register(&AtlasProject{}, &AtlasProjectList{})
 }
 
-// AtlasProjectSpec defines the desired state of Project in Atlas
+// AtlasProjectSpec defines the target state of Project in Atlas
 type AtlasProjectSpec struct {
 
 	// Name is the name of the Project that is created in Atlas by the Operator if it doesn't exist yet.
diff --git a/api/v1/atlassearchindexconfig_types.go b/api/v1/atlassearchindexconfig_types.go
@@ -49,7 +49,7 @@ type AtlasSearchIndexConfigList struct {
 	Items           []AtlasSearchIndexConfig `json:"items"`
 }
 
-// AtlasSearchIndexConfigSpec defines the desired state of AtlasSearchIndexConfig.
+// AtlasSearchIndexConfigSpec defines the target state of AtlasSearchIndexConfig.
 type AtlasSearchIndexConfigSpec struct {
 	// Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text.
 	// These units are called a term or token. This process, known as tokenization, involves a variety of changes made to the text in fields:
diff --git a/api/v1/atlasstreamconnection_types.go b/api/v1/atlasstreamconnection_types.go
@@ -22,7 +22,7 @@ import (
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/api/v1/status"
 )
 
-// AtlasStreamConnectionSpec defines the desired state of AtlasStreamConnection.
+// AtlasStreamConnectionSpec defines the target state of AtlasStreamConnection.
 type AtlasStreamConnectionSpec struct {
 	// Human-readable label that uniquely identifies the stream connection.
 	Name string `json:"name"`
diff --git a/api/v1/atlasstreaminstance_types.go b/api/v1/atlasstreaminstance_types.go
@@ -24,7 +24,7 @@ import (
 	"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/kube"
 )
 
-// AtlasStreamInstanceSpec defines the desired state of AtlasStreamInstance.
+// AtlasStreamInstanceSpec defines the target state of AtlasStreamInstance.
 type AtlasStreamInstanceSpec struct {
 	// Human-readable label that identifies the stream connection.
 	Name string `json:"name"`
diff --git a/api/v1/atlasteam_types.go b/api/v1/atlasteam_types.go
@@ -45,7 +45,7 @@ type AtlasTeam struct {
 
 type TeamUser string
 
-// TeamSpec defines the desired state of a Team in Atlas.
+// TeamSpec defines the target state of a Team in Atlas.
 type TeamSpec struct {
 	// The name of the team you want to create.
 	Name string `json:"name"`
diff --git a/docs/api-docs.md b/docs/api-docs.md
diff --git a/test/helper/cel/fake/resource.go b/test/helper/cel/fake/resource.go

Original file line number	Diff line number	Diff line change
`@@ -44,8 +44,8 @@ type Common struct {`
`44`	`44`	`// Conditions is the list of statuses showing the current state of the Atlas Custom Resource`
`45`	`45`	Conditions []Condition `json:"conditions"`
`46`	`46`
`47`		`- // ObservedGeneration indicates the generation of the resource specification that the Atlas Operator is aware of.`
`48`		`- // The Atlas Operator updates this field to the 'metadata.generation' as soon as it starts reconciliation of the resource.`
	`47`	`+ // ObservedGeneration indicates the generation of the resource specification of which the Atlas Operator is aware.`
	`48`	`+ // The Atlas Operator updates this field to the value of 'metadata.generation' as soon as it starts reconciliation of the resource.`
`49`	`49`	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
`50`	`50`	`}`
`51`	`51`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ import (`
`26`	`26`	`"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/pointer"`
`27`	`27`	`)`
`28`	`28`
`29`		`-// AtlasBackupScheduleSpec defines the desired state of AtlasBackupSchedule.`
	`29`	`+// AtlasBackupScheduleSpec defines the target state of AtlasBackupSchedule.`
`30`	`30`	`type AtlasBackupScheduleSpec struct {`
`31`	`31`	`// 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.`
`32`	`32`	`// +optional`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ type AtlasCustomRoleList struct {`
`66`	`66`	Items []AtlasCustomRole `json:"items"`
`67`	`67`	`}`
`68`	`68`
`69`		`-// AtlasCustomRoleSpec defines the desired state of CustomRole in Atlas.`
	`69`	`+// AtlasCustomRoleSpec defines the target state of CustomRole in Atlas.`
`70`	`70`	`// +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"`
`71`	`71`	`// +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"`
`72`	`72`	`type AtlasCustomRoleSpec struct {`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ const (`
`48`	`48`	`DataLakeScopeType ScopeType = "DATA_LAKE"`
`49`	`49`	`)`
`50`	`50`
`51`		`-// AtlasDatabaseUserSpec defines the desired state of Database User in Atlas`
	`51`	`+// AtlasDatabaseUserSpec defines the target state of Database User in Atlas`
`52`	`52`	`// +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"`
`53`	`53`	`// +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"`
`54`	`54`	`type AtlasDatabaseUserSpec struct {`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ func init() {`
`28`	`28`	`SchemeBuilder.Register(&AtlasDataFederation{}, &AtlasDataFederationList{})`
`29`	`29`	`}`
`30`	`30`
`31`		`-// DataFederationSpec defines the desired state of AtlasDataFederation.`
	`31`	`+// DataFederationSpec defines the target state of AtlasDataFederation.`
`32`	`32`	`type DataFederationSpec struct {`
`33`	`33`	`// Project is a reference to AtlasProject resource the deployment belongs to.`
`34`	`34`	Project common.ResourceRefNamespaced `json:"projectRef"`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ func init() {`
`32`	`32`	`SchemeBuilder.Register(&AtlasFederatedAuth{}, &AtlasFederatedAuthList{})`
`33`	`33`	`}`
`34`	`34`
`35`		`-// AtlasFederatedAuthSpec defines the desired state of AtlasFederatedAuth.`
	`35`	`+// AtlasFederatedAuthSpec defines the target state of AtlasFederatedAuth.`
`36`	`36`	`type AtlasFederatedAuthSpec struct {`
`37`	`37`	`// +kubebuilder:default:=false`
`38`	`38`	Enabled bool `json:"enabled,omitempty"`