add desc to schema for google_project_iam_custom_role (#3683) (#2219)

Co-authored-by: Edward Sun <[email protected]> Signed-off-by: Modular Magician <[email protected]> Co-authored-by: Edward Sun <[email protected]>
hashicorp · Jun 24, 2020 · 8ae6861 · 8ae6861
1 parent 99fd4cb
commit 8ae6861
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 16 deletions.
diff --git a/.changelog/3683.txt b/.changelog/3683.txt
@@ -0,0 +1,3 @@
+```release-note:none
+
+```
diff --git a/google-beta/resource_google_project_iam_custom_role.go b/google-beta/resource_google_project_iam_custom_role.go
@@ -25,42 +25,50 @@ func resourceGoogleProjectIamCustomRole() *schema.Resource {
 				Type:         schema.TypeString,
 				Required:     true,
 				ForceNew:     true,
+				Description:  `The camel case role id to use for this role. Cannot contain - characters.`,
 				ValidateFunc: validateIAMCustomRoleID,
 			},
 			"title": {
-				Type:     schema.TypeString,
-				Required: true,
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: `A human-readable title for the role.`,
 			},
 			"permissions": {
-				Type:     schema.TypeSet,
-				Required: true,
-				MinItems: 1,
-				Elem:     &schema.Schema{Type: schema.TypeString},
+				Type:        schema.TypeSet,
+				Required:    true,
+				MinItems:    1,
+				Description: `The names of the permissions this role grants when bound in an IAM policy. At least one permission must be specified.`,
+				Elem:        &schema.Schema{Type: schema.TypeString},
 			},
 			"project": {
-				Type:     schema.TypeString,
-				Optional: true,
-				Computed: true,
-				ForceNew: true,
+				Type:        schema.TypeString,
+				Optional:    true,
+				Computed:    true,
+				ForceNew:    true,
+				Description: `The project that the service account will be created in. Defaults to the provider project configuration.`,
 			},
 			"stage": {
 				Type:             schema.TypeString,
 				Optional:         true,
 				Default:          "GA",
+				Description:      `The current launch stage of the role. Defaults to GA.`,
 				ValidateFunc:     validation.StringInSlice([]string{"ALPHA", "BETA", "GA", "DEPRECATED", "DISABLED", "EAP"}, false),
 				DiffSuppressFunc: emptyOrDefaultStringSuppress("ALPHA"),
 			},
 			"description": {
-				Type:     schema.TypeString,
-				Optional: true,
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: `A human-readable description for the role.`,
 			},
 			"deleted": {
-				Type:     schema.TypeBool,
-				Computed: true,
+				Type:        schema.TypeBool,
+				Computed:    true,
+				Description: `The current deleted state of the role.`,
 			},
 			"name": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: `The name of the role in the format projects/{{project}}/roles/{{role_id}}. Like id, this field can be used as a reference in other resources such as IAM role bindings.`,
 			},
 		},
 	}