add description for the types

snapp-incubator · Jan 19, 2024 · 62dff8c · 62dff8c
1 parent 202dfbf
commit 62dff8c
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 1 deletion.
diff --git a/api/v1alpha1/s3bucket_types.go b/api/v1alpha1/s3bucket_types.go
@@ -52,7 +52,7 @@ type S3BucketStatus struct {
 // +kubebuilder:printcolumn:name="S3USERREF",type=string,JSONPath=`.spec.s3UserRef`
 // +kubebuilder:resource:shortName=s3b
 
-// S3Bucket is the Schema for the s3buckets API
+// S3 Bucket Instance
 type S3Bucket struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha1/s3user_types.go b/api/v1alpha1/s3user_types.go
@@ -48,6 +48,7 @@ type S3UserStatus struct {
 // +kubebuilder:printcolumn:name="MAX BUCKETS",type=string,JSONPath=`.spec.quota.maxBuckets`
 // +kubebuilder:printcolumn:name="AGE",type=date,JSONPath=`.metadata.creationTimestamp`
 
+// S3 User is created by the S3 User Claim instance. It's not applicable for the operator user.
 type S3User struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha1/s3userclaim_types.go b/api/v1alpha1/s3userclaim_types.go
@@ -61,6 +61,7 @@ type S3UserClaimStatus struct {
 // +kubebuilder:printcolumn:name="AGE",type=date,JSONPath=`.metadata.creationTimestamp`
 // +kubebuilder:resource:shortName=s3u
 
+// S3 User Claim Instance
 type S3UserClaim struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`