chore: update api descriptions

apis/user/v1alpha1/accesskey_types.go

@@ -27,22 +27,22 @@ import (
 
 // AccessKeyParameters are the configurable fields of a AccessKey.
 type AccessKeyParameters struct {
-	// GroupID for the new access key.
+	// GroupID of the access key.
 	// +optional
 	// +immutable
 	GroupID string `json:"groupId,omitempty"`
 
-	// User for the new access key.
+	// UserId of the access key.
 	// +optional
 	// +immutable
 	UserID string `json:"userId,omitempty"`
 
-	// UserIDRef is a reference to a user to retrieve its userId.
+	// UserIDRef references a user to retrieve its userId.
 	// +optional
 	// +immutable
 	UserIDRef *xpv1.Reference `json:"userIdRef,omitempty"`
 
-	// UserIDSelector selects reference to a user to retrieve its userId.
+	// UserIDSelector selects a user to retrieve its userId.
 	// +optional
 	UserIDSelector *xpv1.Selector `json:"userIdSelector,omitempty"`
 }
@@ -67,7 +67,7 @@ type AccessKeyStatus struct {
 
 // +kubebuilder:object:root=true
 
-// A AccessKey is an example API type.
+// AccessKey represents an access key for a Cloudian user.
 // +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status"
 // +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status"
 // +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name"

apis/user/v1alpha1/group_types.go

@@ -75,7 +75,7 @@ type GroupStatus struct {
 
 // +kubebuilder:object:root=true
 
-// A Group is an example API type.
+// Group represents a Cloudian group.
 // +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status"
 // +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status"
 // +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name"

apis/user/v1alpha1/groupqualityofservicelimits_types.go

@@ -69,17 +69,17 @@ type QualityOfServiceLimits struct {
 
 // GroupQualityOfServiceLimitsParameters are the configurable fields of a GroupQualityOfServiceLimits.
 type GroupQualityOfServiceLimitsParameters struct {
-	// Group for the quality of service limits.
+	// GroupID of the quality of service limits.
 	// +optional
 	// +immutable
 	GroupID string `json:"groupId,omitempty"`
 
-	// GroupIDRef is a reference to a group to retrieve its groupId.
+	// GroupIDRef references a group to retrieve its groupId.
 	// +optional
 	// +immutable
 	GroupIDRef *xpv1.Reference `json:"groupIdRef,omitempty"`
 
-	// GroupIDSelector selects reference to a group to retrieve its groupId.
+	// GroupIDSelector selects a group to retrieve its groupId.
 	// +optional
 	GroupIDSelector *xpv1.Selector `json:"groupIdSelector,omitempty"`
 
@@ -114,7 +114,7 @@ type GroupQualityOfServiceLimitsStatus struct {
 
 // +kubebuilder:object:root=true
 
-// A GroupQualityOfServiceLimits is an example API type.
+// GroupQualityOfServiceLimits represents the quality of service limits for a Cloudian group, within a region.
 // +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status"
 // +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status"
 // +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name"

apis/user/v1alpha1/user_types.go

@@ -60,7 +60,7 @@ type UserStatus struct {
 
 // +kubebuilder:object:root=true
 
-// A User is an example API type.
+// User represents a Cloudian user.
 // +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status"
 // +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status"
 // +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name"

package/crds/user.cloudian.crossplane.io_accesskeys.yaml

@@ -34,7 +34,7 @@ spec:
     name: v1alpha1
     schema:
       openAPIV3Schema:
-        description: A AccessKey is an example API type.
+        description: AccessKey represents an access key for a Cloudian user.
         properties:
           apiVersion:
             description: |-
@@ -75,14 +75,13 @@ spec:
                   AccessKey.
                 properties:
                   groupId:
-                    description: GroupID for the new access key.
+                    description: GroupID of the access key.
                     type: string
                   userId:
-                    description: User for the new access key.
+                    description: UserId of the access key.
                     type: string
                   userIdRef:
-                    description: UserIDRef is a reference to a user to retrieve its
-                      userId.
+                    description: UserIDRef references a user to retrieve its userId.
                     properties:
                       name:
                         description: Name of the referenced object.
@@ -116,8 +115,7 @@ spec:
                     - name
                     type: object
                   userIdSelector:
-                    description: UserIDSelector selects reference to a user to retrieve
-                      its userId.
+                    description: UserIDSelector selects a user to retrieve its userId.
                     properties:
                       matchControllerRef:
                         description: |-

package/crds/user.cloudian.crossplane.io_groupqualityofservicelimits.yaml

@@ -34,7 +34,8 @@ spec:
     name: v1alpha1
     schema:
       openAPIV3Schema:
-        description: A GroupQualityOfServiceLimits is an example API type.
+        description: GroupQualityOfServiceLimits represents the quality of service
+          limits for a Cloudian group, within a region.
         properties:
           apiVersion:
             description: |-
@@ -76,11 +77,10 @@ spec:
                   fields of a GroupQualityOfServiceLimits.
                 properties:
                   groupId:
-                    description: Group for the quality of service limits.
+                    description: GroupID of the quality of service limits.
                     type: string
                   groupIdRef:
-                    description: GroupIDRef is a reference to a group to retrieve
-                      its groupId.
+                    description: GroupIDRef references a group to retrieve its groupId.
                     properties:
                       name:
                         description: Name of the referenced object.
@@ -114,8 +114,7 @@ spec:
                     - name
                     type: object
                   groupIdSelector:
-                    description: GroupIDSelector selects reference to a group to retrieve
-                      its groupId.
+                    description: GroupIDSelector selects a group to retrieve its groupId.
                     properties:
                       matchControllerRef:
                         description: |-

package/crds/user.cloudian.crossplane.io_groups.yaml

@@ -34,7 +34,7 @@ spec:
     name: v1alpha1
     schema:
       openAPIV3Schema:
-        description: A Group is an example API type.
+        description: Group represents a Cloudian group.
         properties:
           apiVersion:
             description: |-

package/crds/user.cloudian.crossplane.io_users.yaml

@@ -34,7 +34,7 @@ spec:
     name: v1alpha1
     schema:
       openAPIV3Schema:
-        description: A User is an example API type.
+        description: User represents a Cloudian user.
         properties:
           apiVersion:
             description: |-