rename writeable + ACLs (#166)

* rename writeable + ACLs * Automated docs update --------- Co-authored-by: Dean Oren <[email protected]> Co-authored-by: do87 <[email protected]>
SchwarzIT · Jul 25, 2023 · d00ef5f · d00ef5f
1 parent 7ad93c2
commit d00ef5f
Show file tree

Hide file tree

Showing 13 changed files with 32 additions and 32 deletions.
diff --git a/docs/data-sources/secrets_manager_instance.md b/docs/data-sources/secrets_manager_instance.md
@@ -40,7 +40,7 @@ data "stackit_secrets_manager_instance" "example" {
 
 ### Read-Only
 
-- `acl` (Set of String) Specifies the ACLs for the instance.
+- `acl` (Set of String) Specifies the access list for the instance.
 - `api_url` (String) Specifies the API URL for managing secrets.
 - `frontend_url` (String) Specifies the frontend for managing secrets.
 - `name` (String) Specifies the instance name.

diff --git a/docs/data-sources/secrets_manager_user.md b/docs/data-sources/secrets_manager_user.md
@@ -25,10 +25,10 @@ resource "stackit_secrets_manager_instance" "example" {
 }
 
 resource "stackit_secrets_manager_user" "example" {
-  project_id  = var.project_id
-  instance_id = stackit_secrets_manager_instance.example.id
-  description = "test"
-  writable    = true
+  project_id    = var.project_id
+  instance_id   = stackit_secrets_manager_instance.example.id
+  description   = "test"
+  write_enabled = true
 }
 
 data "stackit_secrets_manager_user" "example" {
@@ -49,7 +49,7 @@ data "stackit_secrets_manager_user" "example" {
 
 ### Optional
 
-- `writable` (Boolean) Specifies if the user can write secrets. `false` by default.
+- `write_enabled` (Boolean) Specifies if the user can write secrets. `false` by default.
 
 ### Read-Only
 

diff --git a/docs/resources/secrets_manager_instance.md b/docs/resources/secrets_manager_instance.md
@@ -35,7 +35,7 @@ resource "stackit_secrets_manager_instance" "example" {
 
 ### Optional
 
-- `acl` (Set of String) Specifies the ACLs for the instance. Each item must be CIDR notation.
+- `acl` (Set of String) Specifies the access list for the instance. Each item must be CIDR notation.
 
 ### Read-Only
 

diff --git a/docs/resources/secrets_manager_user.md b/docs/resources/secrets_manager_user.md
@@ -25,10 +25,10 @@ resource "stackit_secrets_manager_instance" "example" {
 }
 
 resource "stackit_secrets_manager_user" "example" {
-  project_id  = var.project_id
-  instance_id = stackit_secrets_manager_instance.example.id
-  description = "example"
-  writable    = true
+  project_id    = var.project_id
+  instance_id   = stackit_secrets_manager_instance.example.id
+  description   = "example"
+  write_enabled = true
 }
 ```
 
@@ -43,7 +43,7 @@ resource "stackit_secrets_manager_user" "example" {
 ### Optional
 
 - `description` (String) Specifies the description of the user. Changing this value requires the resource to be recreated.
-- `writable` (Boolean) Specifies if the user can write secrets. `false` by default.
+- `write_enabled` (Boolean) Specifies if the user can write secrets. `false` by default.
 
 ### Read-Only
 

diff --git a/examples/data-sources/stackit_secrets_manager_user/data-source.tf b/examples/data-sources/stackit_secrets_manager_user/data-source.tf
@@ -4,10 +4,10 @@ resource "stackit_secrets_manager_instance" "example" {
 }
 
 resource "stackit_secrets_manager_user" "example" {
-  project_id  = var.project_id
-  instance_id = stackit_secrets_manager_instance.example.id
-  description = "test"
-  writable    = true
+  project_id    = var.project_id
+  instance_id   = stackit_secrets_manager_instance.example.id
+  description   = "test"
+  write_enabled = true
 }
 
 data "stackit_secrets_manager_user" "example" {

diff --git a/examples/resources/stackit_secrets_manager_user/resource.tf b/examples/resources/stackit_secrets_manager_user/resource.tf
@@ -4,8 +4,8 @@ resource "stackit_secrets_manager_instance" "example" {
 }
 
 resource "stackit_secrets_manager_user" "example" {
-  project_id  = var.project_id
-  instance_id = stackit_secrets_manager_instance.example.id
-  description = "example"
-  writable    = true
+  project_id    = var.project_id
+  instance_id   = stackit_secrets_manager_instance.example.id
+  description   = "example"
+  write_enabled = true
 }
diff --git a/stackit/internal/data-sources/secrets-manager/instance/schema.go b/stackit/internal/data-sources/secrets-manager/instance/schema.go
@@ -56,7 +56,7 @@ func (d *DataSource) Schema(ctx context.Context, req datasource.SchemaRequest, r
 				Computed:    true,
 			},
 			"acl": schema.SetAttribute{
-				Description: "Specifies the ACLs for the instance.",
+				Description: "Specifies the access list for the instance.",
 				Computed:    true,
 				ElementType: types.StringType,
 			},

diff --git a/stackit/internal/data-sources/secrets-manager/user/data_source_test.go b/stackit/internal/data-sources/secrets-manager/user/data_source_test.go
@@ -33,7 +33,7 @@ func TestAcc_SecretsManagerUser(t *testing.T) {
 					resource.TestCheckTypeSetElemAttrPair("stackit_secrets_manager_user.example", "username", "data.stackit_secrets_manager_user.example", "username"),
 					resource.TestCheckTypeSetElemAttrPair("stackit_secrets_manager_user.example", "id", "data.stackit_secrets_manager_user.example", "id"),
 					resource.TestCheckTypeSetElemAttrPair("stackit_secrets_manager_user.example", "instance_id", "data.stackit_secrets_manager_user.example", "instance_id"),
-					resource.TestCheckTypeSetElemAttrPair("stackit_secrets_manager_user.example", "writable", "data.stackit_secrets_manager_user.example", "writable"),
+					resource.TestCheckTypeSetElemAttrPair("stackit_secrets_manager_user.example", "write_enabled", "data.stackit_secrets_manager_user.example", "write_enabled"),
 					resource.TestCheckTypeSetElemAttrPair("stackit_secrets_manager_user.example", "description", "data.stackit_secrets_manager_user.example", "description"),
 				),
 			},
@@ -52,7 +52,7 @@ resource "stackit_secrets_manager_user" "example" {
 	project_id         = stackit_secrets_manager_instance.example.project_id
 	instance_id        = stackit_secrets_manager_instance.example.id
 	description        = "test"
-	writable           = true
+	write_enabled      = true
 }
 
 data "stackit_secrets_manager_user" "example" {

diff --git a/stackit/internal/data-sources/secrets-manager/user/schema.go b/stackit/internal/data-sources/secrets-manager/user/schema.go
@@ -18,7 +18,7 @@ type User struct {
 	ProjectID   types.String `tfsdk:"project_id"`
 	InstanceID  types.String `tfsdk:"instance_id"`
 	Description types.String `tfsdk:"description"`
-	Write       types.Bool   `tfsdk:"writable"`
+	Write       types.Bool   `tfsdk:"write_enabled"`
 	Username    types.String `tfsdk:"username"`
 }
 
@@ -55,7 +55,7 @@ func (d *DataSource) Schema(ctx context.Context, req datasource.SchemaRequest, r
 				Description: "Specifies the description of the user. Changing this value requires the resource to be recreated.",
 				Computed:    true,
 			},
-			"writable": schema.BoolAttribute{
+			"write_enabled": schema.BoolAttribute{
 				Description: "Specifies if the user can write secrets. `false` by default.",
 				Optional:    true,
 			},

diff --git a/stackit/internal/resources/secrets-manager/instance/schema.go b/stackit/internal/resources/secrets-manager/instance/schema.go
@@ -56,7 +56,7 @@ func (r *Resource) Schema(ctx context.Context, req resource.SchemaRequest, resp
 				},
 			},
 			"acl": schema.SetAttribute{
-				Description: "Specifies the ACLs for the instance. Each item must be CIDR notation.",
+				Description: "Specifies the access list for the instance. Each item must be CIDR notation.",
 				Optional:    true,
 				Computed:    true,
 				ElementType: types.StringType,

diff --git a/stackit/internal/resources/secrets-manager/user/actions.go b/stackit/internal/resources/secrets-manager/user/actions.go
@@ -97,7 +97,7 @@ func (r Resource) Update(ctx context.Context, req resource.UpdateRequest, resp *
 		return
 	}
 
-	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("writable"), write)...)
+	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("write_enabled"), write)...)
 	if resp.Diagnostics.HasError() {
 		return
 	}

diff --git a/stackit/internal/resources/secrets-manager/user/resource_test.go b/stackit/internal/resources/secrets-manager/user/resource_test.go
@@ -33,7 +33,7 @@ func TestAcc_SecretsManagerUser(t *testing.T) {
 				Config: config(name, true),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr("stackit_secrets_manager_user.example", "description", "test"),
-					resource.TestCheckResourceAttr("stackit_secrets_manager_user.example", "writable", "true"),
+					resource.TestCheckResourceAttr("stackit_secrets_manager_user.example", "write_enabled", "true"),
 					resource.TestCheckResourceAttrSet("stackit_secrets_manager_user.example", "username"),
 					resource.TestCheckResourceAttrSet("stackit_secrets_manager_user.example", "password"),
 					resource.TestCheckResourceAttrSet("stackit_secrets_manager_user.example", "id"),
@@ -42,7 +42,7 @@ func TestAcc_SecretsManagerUser(t *testing.T) {
 			{
 				Config: config(name, false),
 				Check: resource.ComposeTestCheckFunc(
-					resource.TestCheckResourceAttr("stackit_secrets_manager_user.example", "writable", "false"),
+					resource.TestCheckResourceAttr("stackit_secrets_manager_user.example", "write_enabled", "false"),
 				),
 			},
 			// test import
@@ -83,7 +83,7 @@ func config(name string, writeable bool) string {
 		project_id         = stackit_secrets_manager_instance.example.project_id
 		instance_id        = stackit_secrets_manager_instance.example.id
 		description        = "test"
-		writable           = %v
+		write_enabled      = %v
 	}
 	  `,
 		common.GetAcceptanceTestsProjectID(),

diff --git a/stackit/internal/resources/secrets-manager/user/schema.go b/stackit/internal/resources/secrets-manager/user/schema.go
@@ -22,7 +22,7 @@ type User struct {
 	ProjectID   types.String `tfsdk:"project_id"`
 	InstanceID  types.String `tfsdk:"instance_id"`
 	Description types.String `tfsdk:"description"`
-	Write       types.Bool   `tfsdk:"writable"`
+	Write       types.Bool   `tfsdk:"write_enabled"`
 	Username    types.String `tfsdk:"username"`
 	Password    types.String `tfsdk:"password"`
 }
@@ -70,7 +70,7 @@ func (r *Resource) Schema(ctx context.Context, req resource.SchemaRequest, resp
 					stringplanmodifier.RequiresReplace(),
 				},
 			},
-			"writable": schema.BoolAttribute{
+			"write_enabled": schema.BoolAttribute{
 				Description: "Specifies if the user can write secrets. `false` by default.",
 				Optional:    true,
 				Computed:    true,