Merge pull request #21 from mineiros-io/soerenmartius/fix-readme

Add missing id attribute to memberships documentation

README.md

@@ -123,21 +123,32 @@ See [variables.tf] and [examples/] for details and use-cases.
 
   Default is `[]`.
 
+  Example:
+
+  ```hcl
+  memberships = [
+    {
+      id = "[email protected]"
+      roles = ["MEMBER", "MANAGER"]
+    }
+  ]
+  ```
+
   Each `membership` object in the list accepts the following attributes:
 
+  - [**`id`**](#attr-memberships-id): *(**Required** `string`)*<a name="attr-memberships-id"></a>
+
+    The id of the entity. For Google-managed entities, the id must be
+    the email address of an existing group or user. For external-identity-mapped
+    entities, the id must be a string conforming to the identity source's requirements.
+
   - [**`roles`**](#attr-memberships-roles): *(Optional `list(string)`)*<a name="attr-memberships-roles"></a>
 
     A list of roles to bind to this Membership. Possible values are `OWNER`, `MANAGER`, and `MEMBER`.
     **Note:** The `OWNER` and `MANAGER` roles are supplementary roles that require the `MEMBER` role to be assigned.
 
     Default is `["MEMBER"]`.
 
-    Example:
-
-    ```hcl
-    roles = ["MEMBER", "MANAGER"]
-    ```
-
 ### Module Configuration
 
 - [**`module_enabled`**](#var-module_enabled): *(Optional `bool`)*<a name="var-module_enabled"></a>

README.tfdoc.hcl

@@ -160,11 +160,29 @@ section {
       }
 
       variable "memberships" {
-        type        = list(membership)
-        description = <<-END
+        type           = list(membership)
+        description    = <<-END
           A list of memberships (id, roles) to get attached to the group resource created.
         END
-        default     = []
+        readme_example = <<-END
+          memberships = [
+            {
+              id = "[email protected]"
+              roles = ["MEMBER", "MANAGER"]
+            }
+          ]
+        END
+        default        = []
+
+        attribute "id" {
+          required    = true
+          type        = string
+          description = <<-END
+            The id of the entity. For Google-managed entities, the id must be
+            the email address of an existing group or user. For external-identity-mapped
+            entities, the id must be a string conforming to the identity source's requirements.
+          END
+        }
 
         attribute "roles" {
           type        = list(string)
@@ -173,10 +191,6 @@ section {
             A list of roles to bind to this Membership. Possible values are `OWNER`, `MANAGER`, and `MEMBER`.
             **Note:** The `OWNER` and `MANAGER` roles are supplementary roles that require the `MEMBER` role to be assigned.
           END
-
-          readme_example = <<-END
-          roles = ["MEMBER", "MANAGER"]
-        END
         }
       }
     }