add desc to schema for 2 org iam resources (#3681) (#2215)

Co-authored-by: Edward Sun <[email protected]> Signed-off-by: Modular Magician <[email protected]> Co-authored-by: Edward Sun <[email protected]>
hashicorp · Jun 23, 2020 · 2a6952f · 2a6952f
1 parent 9d5432e
commit 2a6952f
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 32 deletions.
diff --git a/.changelog/3681.txt b/.changelog/3681.txt
@@ -0,0 +1,3 @@
+```release-note:none
+
+```
diff --git a/google-beta/iam_organization.go b/google-beta/iam_organization.go
@@ -9,9 +9,10 @@ import (
 
 var IamOrganizationSchema = map[string]*schema.Schema{
 	"org_id": {
-		Type:     schema.TypeString,
-		Required: true,
-		ForceNew: true,
+		Type:        schema.TypeString,
+		Required:    true,
+		ForceNew:    true,
+		Description: `The numeric ID of the organization in which you want to manage the audit logging config.`,
 	},
 }
 

diff --git a/google-beta/resource_google_organization_iam_custom_role.go b/google-beta/resource_google_organization_iam_custom_role.go
@@ -21,43 +21,51 @@ func resourceGoogleOrganizationIamCustomRole() *schema.Resource {
 
 		Schema: map[string]*schema.Schema{
 			"role_id": {
-				Type:     schema.TypeString,
-				Required: true,
-				ForceNew: true,
+				Type:        schema.TypeString,
+				Required:    true,
+				ForceNew:    true,
+				Description: `The role id to use for this role.`,
 			},
 			"org_id": {
-				Type:     schema.TypeString,
-				Required: true,
-				ForceNew: true,
+				Type:        schema.TypeString,
+				Required:    true,
+				ForceNew:    true,
+				Description: `The numeric ID of the organization in which you want to create a custom role.`,
 			},
 			"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},
 			},
 			"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 organizations/{{org_id}}/roles/{{role_id}}. Like id, this field can be used as a reference in other resources such as IAM role bindings.`,
 			},
 		},
 	}

diff --git a/google-beta/resource_iam_audit_config.go b/google-beta/resource_iam_audit_config.go
@@ -12,29 +12,34 @@ import (
 
 var iamAuditConfigSchema = map[string]*schema.Schema{
 	"service": {
-		Type:     schema.TypeString,
-		Required: true,
+		Type:        schema.TypeString,
+		Required:    true,
+		Description: `Service which will be enabled for audit logging. The special value allServices covers all services.`,
 	},
 	"audit_log_config": {
-		Type:     schema.TypeSet,
-		Required: true,
+		Type:        schema.TypeSet,
+		Required:    true,
+		Description: `The configuration for logging of each type of permission. This can be specified multiple times.`,
 		Elem: &schema.Resource{
 			Schema: map[string]*schema.Schema{
 				"log_type": {
-					Type:     schema.TypeString,
-					Required: true,
+					Type:        schema.TypeString,
+					Required:    true,
+					Description: `Permission type for which logging is to be configured. Must be one of DATA_READ, DATA_WRITE, or ADMIN_READ.`,
 				},
 				"exempted_members": {
-					Type:     schema.TypeSet,
-					Elem:     &schema.Schema{Type: schema.TypeString},
-					Optional: true,
+					Type:        schema.TypeSet,
+					Elem:        &schema.Schema{Type: schema.TypeString},
+					Optional:    true,
+					Description: `Identities that do not cause logging for this type of permission. Each entry can have one of the following values:user:{emailid}: An email address that represents a specific Google account. For example, [email protected] or [email protected]. serviceAccount:{emailid}: An email address that represents a service account. For example, [email protected]. group:{emailid}: An email address that represents a Google group. For example, [email protected]. domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.`,
 				},
 			},
 		},
 	},
 	"etag": {
-		Type:     schema.TypeString,
-		Computed: true,
+		Type:        schema.TypeString,
+		Computed:    true,
+		Description: `The etag of iam policy`,
 	},
 }