From b0ea18f432e627bc5ed55320ed72ee77f6521746 Mon Sep 17 00:00:00 2001 From: Amund Tenstad Date: Thu, 6 Feb 2025 14:33:51 +0100 Subject: [PATCH] chore: update api descriptions --- apis/user/v1alpha1/accesskey_types.go | 10 +++++----- apis/user/v1alpha1/group_types.go | 2 +- .../v1alpha1/groupqualityofservicelimits_types.go | 8 ++++---- apis/user/v1alpha1/user_types.go | 2 +- .../crds/user.cloudian.crossplane.io_accesskeys.yaml | 12 +++++------- ...an.crossplane.io_groupqualityofservicelimits.yaml | 11 +++++------ package/crds/user.cloudian.crossplane.io_groups.yaml | 2 +- package/crds/user.cloudian.crossplane.io_users.yaml | 2 +- 8 files changed, 23 insertions(+), 26 deletions(-) diff --git a/apis/user/v1alpha1/accesskey_types.go b/apis/user/v1alpha1/accesskey_types.go index 3f4ecc7c..e9b16217 100644 --- a/apis/user/v1alpha1/accesskey_types.go +++ b/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" diff --git a/apis/user/v1alpha1/group_types.go b/apis/user/v1alpha1/group_types.go index 102ae730..3d35322b 100644 --- a/apis/user/v1alpha1/group_types.go +++ b/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" diff --git a/apis/user/v1alpha1/groupqualityofservicelimits_types.go b/apis/user/v1alpha1/groupqualityofservicelimits_types.go index 0cbceb14..a9a37b13 100644 --- a/apis/user/v1alpha1/groupqualityofservicelimits_types.go +++ b/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" diff --git a/apis/user/v1alpha1/user_types.go b/apis/user/v1alpha1/user_types.go index bf09fc5d..718c706e 100644 --- a/apis/user/v1alpha1/user_types.go +++ b/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" diff --git a/package/crds/user.cloudian.crossplane.io_accesskeys.yaml b/package/crds/user.cloudian.crossplane.io_accesskeys.yaml index 532bf1b9..4db51798 100644 --- a/package/crds/user.cloudian.crossplane.io_accesskeys.yaml +++ b/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: |- diff --git a/package/crds/user.cloudian.crossplane.io_groupqualityofservicelimits.yaml b/package/crds/user.cloudian.crossplane.io_groupqualityofservicelimits.yaml index 018ea034..a7830482 100644 --- a/package/crds/user.cloudian.crossplane.io_groupqualityofservicelimits.yaml +++ b/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: |- diff --git a/package/crds/user.cloudian.crossplane.io_groups.yaml b/package/crds/user.cloudian.crossplane.io_groups.yaml index 81e95253..acb51e9f 100644 --- a/package/crds/user.cloudian.crossplane.io_groups.yaml +++ b/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: |- diff --git a/package/crds/user.cloudian.crossplane.io_users.yaml b/package/crds/user.cloudian.crossplane.io_users.yaml index 2b58464a..3326c387 100644 --- a/package/crds/user.cloudian.crossplane.io_users.yaml +++ b/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: |-