Merge pull request #1453 from turkenf/add-desc-mquser

Add description to consoleAccess field for MQ User
crossplane-contrib · Aug 8, 2024 · ad89d40 · ad89d40
2 parents 5a775c6 + 863d372
commit ad89d40
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/apis/mq/v1alpha1/zz_user_types.go b/apis/mq/v1alpha1/zz_user_types.go
diff --git a/config/mq/config.go b/config/mq/config.go
@@ -8,6 +8,7 @@ import (
 	"fmt"
 
 	"github.com/crossplane/upjet/pkg/config"
+	"github.com/crossplane/upjet/pkg/registry"
 )
 
 // Configure adds configurations for the mq group.
@@ -68,5 +69,9 @@ func Configure(p *config.Provider) {
 			TerraformName: "aws_mq_broker",
 		}
 		r.Version = "v1alpha1"
+		r.MetaResource = &registry.Resource{
+			ArgumentDocs: make(map[string]string),
+		}
+		r.MetaResource.ArgumentDocs["console_access"] = `- (Optional) Setting consoleAccess will result in an update loop till the MQ Broker to which this user belongs is restarted.`
 	})
 }
diff --git a/package/crds/mq.aws.upbound.io_users.yaml b/package/crds/mq.aws.upbound.io_users.yaml
@@ -34,7 +34,7 @@ spec:
     name: v1alpha1
     schema:
       openAPIV3Schema:
-        description: User is the Schema for the Users API. <no value>
+        description: User is the Schema for the Users API.
         properties:
           apiVersion:
             description: |-
@@ -149,6 +149,8 @@ spec:
                         type: object
                     type: object
                   consoleAccess:
+                    description: Setting consoleAccess will result in an update loop
+                      till the MQ Broker to which this user belongs is restarted.
                     type: boolean
                   groups:
                     items:
@@ -273,6 +275,8 @@ spec:
                         type: object
                     type: object
                   consoleAccess:
+                    description: Setting consoleAccess will result in an update loop
+                      till the MQ Broker to which this user belongs is restarted.
                     type: boolean
                   groups:
                     items:
@@ -486,6 +490,8 @@ spec:
                   brokerId:
                     type: string
                   consoleAccess:
+                    description: Setting consoleAccess will result in an update loop
+                      till the MQ Broker to which this user belongs is restarted.
                     type: boolean
                   groups:
                     items: