Skip to content

Commit 53733ee

Browse files
authored
fix: [REL-8605] add documentation note on discrepancy in default base permissions with current API version (#336)
* add note on base permission default to doc * make generate
1 parent 3164e17 commit 53733ee

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/resources/custom_role.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ resource "launchdarkly_custom_role" "example" {
4747

4848
### Optional
4949

50-
- `base_permissions` (String) The base permission level - either reader or no_access. Defaults to reader.
50+
- `base_permissions` (String) The base permission level - either `reader` or `no_access`. While newer API versions default to `no_access`, this field defaults to `reader` in keeping with previous API versions.
5151
- `description` (String) Description of the custom role.
5252
- `policy` (Block Set, Deprecated) (see [below for nested schema](#nestedblock--policy))
5353
- `policy_statements` (Block List) An array of the policy statements that define the permissions for the custom role. This field accepts [role attributes](https://docs.launchdarkly.com/home/getting-started/vocabulary#role-attribute). To use role attributes, use the syntax `$${roleAttribute/<YOUR_ROLE_ATTRIBUTE>}` in lieu of your usual resource keys. (see [below for nested schema](#nestedblock--policy_statements))

launchdarkly/resource_launchdarkly_custom_role.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ This resource allows you to create and manage custom roles within your LaunchDar
5151
BASE_PERMISSIONS: {
5252
Type: schema.TypeString,
5353
Optional: true,
54-
Description: "The base permission level - either reader or no_access. Defaults to reader.",
54+
Description: "The base permission level - either `reader` or `no_access`. While newer API versions default to `no_access`, this field defaults to `reader` in keeping with previous API versions.",
5555
ValidateDiagFunc: validation.ToDiagFunc(validation.StringInSlice([]string{"reader", "no_access"}, false)),
5656
Default: "reader",
5757
},

0 commit comments

Comments
 (0)