docs: remove id flag from docs

hashicorp · Oct 13, 2020 · 29e5de1 · 29e5de1
1 parent 2c1fc3f
commit 29e5de1
Show file tree

Hide file tree

Showing 12 changed files with 6 additions and 13 deletions.
diff --git a/Makefile b/Makefile
@@ -35,3 +35,6 @@ all:
 	GOOS=darwin go build -o $(BUILD_ALL_PATH)/terraform-provider-boundary_darwin-amd64 main.go
 	GOOS=windows go build -o $(BUILD_ALL_PATH)/terraform-provider-boundary_windows-amd64 main.go
 	GOOS=linux go build -o $(BUILD_ALL_PATH)/terraform-provider-boundary_linux-amd64 main.go
+
+rm-id-flag-from-docs:
+	find docs/ -name "*.md" -type f | xargs sed -i -e '/- \*\*id\*\*/d'
diff --git a/docs/index.md b/docs/index.md
@@ -34,4 +34,4 @@ provider "boundary" {
 - **password_auth_method_login_name** (String, Optional) The auth method login name for password-style auth methods
 - **password_auth_method_password** (String, Optional) The auth method password for password-style auth methods
 - **recovery_kms_hcl** (String, Optional) Can be a heredoc string or a path on disk. If set, the string/file will be parsed as HCL and used with the recovery KMS mechanism. While this is set, it will override any other authentication information; the KMS mechanism will always be used.
-- **token** (String, Optional) The Boundary token to use, as a string or path on disk containing just the string. If set, the token read here will be used in place of authenticating with the auth method specified in "auth_method_id", although the recovery KMS mechanism will still override this. Can also be set with the BOUNDARY_TOKEN environment variable.
+- **token** (String, Optional) The Boundary token to use, as a string or path on disk containing just the string. If set, the token read here will be used in place of authenticating with the auth method specified in "auth_method_id", although the recovery KMS mechanism will still override this. Can also be set with the BOUNDARY_TOKEN environment variable.
diff --git a/docs/resources/account.md b/docs/resources/account.md
@@ -42,7 +42,6 @@ resource "boundary_account" "jeff" {
 ### Optional
 
 - **description** (String, Optional) The account description.
-- **id** (String, Optional) The ID of this resource.
 - **login_name** (String, Optional) The login name for this account.
 - **name** (String, Optional) The account name. Defaults to the resource name.
 - **password** (String, Optional) The account password.

diff --git a/docs/resources/auth_method.md b/docs/resources/auth_method.md
@@ -35,7 +35,6 @@ resource "boundary_auth_method" "password" {
 ### Optional
 
 - **description** (String, Optional) The auth method description.
-- **id** (String, Optional) The ID of this resource.
 - **min_login_name_length** (Number, Optional) The minimum login name length.
 - **min_password_length** (Number, Optional) The minimum password length.
 - **name** (String, Optional) The auth method name. Defaults to the resource name.

diff --git a/docs/resources/group.md b/docs/resources/group.md
@@ -71,7 +71,6 @@ resource "boundary_group" "example" {
 ### Optional
 
 - **description** (String, Optional) The group description.
-- **id** (String, Optional) The ID of this resource.
 - **member_ids** (Set of String, Optional) Resource IDs for group members, these are most likely boundary users.
 - **name** (String, Optional) The group name. Defaults to the resource name.
 

diff --git a/docs/resources/host.md b/docs/resources/host.md
@@ -45,7 +45,6 @@ resource "boundary_host" "example" {
 
 - **address** (String, Optional) The static address of the host resource as `<IP>:<port>` or a domain name.
 - **description** (String, Optional) The host description.
-- **id** (String, Optional) The ID of this resource.
 - **name** (String, Optional) The host name. Defaults to the resource name.
 
 ## Import

diff --git a/docs/resources/host_catalog.md b/docs/resources/host_catalog.md
@@ -44,7 +44,6 @@ resource "boundary_host_catalog" "example" {
 ### Optional
 
 - **description** (String, Optional) The host catalog description.
-- **id** (String, Optional) The ID of this resource.
 - **name** (String, Optional) The host catalog name. Defaults to the resource name.
 
 ## Import

diff --git a/docs/resources/host_set.md b/docs/resources/host_set.md
@@ -66,7 +66,6 @@ resource "boundary_host_set" "web" {
 
 - **description** (String, Optional) The hostset description.
 - **host_ids** (Set of String, Optional) The list of host IDs contained in this set.
-- **id** (String, Optional) The ID of this resource.
 - **name** (String, Optional) The hostset name. Defaults to the resource name.
 
 ## Import

diff --git a/docs/resources/role.md b/docs/resources/role.md
@@ -125,7 +125,6 @@ resource "boundary_role" "readonly" {
 - **description** (String, Optional) The role description.
 - **grant_scope_id** (String, Optional)
 - **grant_strings** (Set of String, Optional) A list of stringified grants for the role.
-- **id** (String, Optional) The ID of this resource.
 - **name** (String, Optional) The role name. Defaults to the resource name.
 - **principal_ids** (Set of String, Optional) A list of principal (user or group) IDs to add as principals on the role.
 
@@ -135,4 +134,4 @@ Import is supported using the following syntax:
 
 ```shell
 terraform import boundary_role.foo <my-id>
-```
+```
diff --git a/docs/resources/scope.md b/docs/resources/scope.md
@@ -72,7 +72,6 @@ resource "boundary_role" "org_admin" {
 - **auto_create_default_role** (Boolean, Optional) If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives listing of scopes and auth methods and the ability to authenticate to the anonymous user. Marking this true makes for simpler HCL but results in role resources that are unmanaged by Terraform.
 - **description** (String, Optional) The scope description.
 - **global_scope** (Boolean, Optional) Indicates that the scope containing this value is the global scope, which triggers some specialized behavior to allow it to be imported and managed.
-- **id** (String, Optional) The ID of this resource.
 - **name** (String, Optional) The scope name. Defaults to the resource name.
 
 ## Import
@@ -81,4 +80,4 @@ Import is supported using the following syntax:
 
 ```shell
 terraform import boundary_scope.foo <my-id>
-```
+```
diff --git a/docs/resources/target.md b/docs/resources/target.md
@@ -86,7 +86,6 @@ resource "boundary_target" "foo" {
 - **default_port** (Number, Optional) The default port for this target.
 - **description** (String, Optional) The target description.
 - **host_set_ids** (Set of String, Optional) A list of host set ID's.
-- **id** (String, Optional) The ID of this resource.
 - **name** (String, Optional) The target name. Defaults to the resource name.
 - **session_connection_limit** (Number, Optional)
 - **session_max_seconds** (Number, Optional)

diff --git a/docs/resources/user.md b/docs/resources/user.md
@@ -49,7 +49,6 @@ resource "boundary_user" "jeff" {
 
 - **account_ids** (Set of String, Optional) Account ID's to associate with this user resource.
 - **description** (String, Optional) The user description.
-- **id** (String, Optional) The ID of this resource.
 - **name** (String, Optional) The username. Defaults to the resource name.
 
 ## Import