Skip to content

Commit 266220f

Browse files
authored
[chore][gov] Update docs to have correct api token permissions (#58)
* update docs to have correct api token permissions * remove flaky acc replay test * remove flaky acc replay test * have to actually save the file lol
1 parent 859066b commit 266220f

File tree

3 files changed

+6
-99
lines changed

3 files changed

+6
-99
lines changed

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ The access token should have the following scopes:
2020
- permissions:all:read, permissions:all:write
2121
- configuration_variables:read, configuration_variables:write
2222
- environments:read, environments:write
23+
- users:read, users:write
24+
- resources:read, resources:write
25+
- resource_configurations:read, resource_configurations:write
2326

2427

2528
## Example Usage

internal/provider/permissions/resource_test.go

Lines changed: 0 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -130,105 +130,6 @@ func TestAccPermissions(t *testing.T) {
130130
})
131131
}
132132

133-
// TestAccPermissions_ManagedDeletion verifies that the permissions resource properly
134-
// manages only the permissions it creates by testing updates and removals.
135-
func TestAccPermissions_ManagedDeletion(t *testing.T) {
136-
// Step 1: Create permissions for two folders.
137-
configWithTwoPerms := `
138-
resource "retool_group" "test_group" {
139-
name = "tf-acc-test-group-managed-del"
140-
}
141-
142-
resource "retool_folder" "test_folder1" {
143-
name = "tf-acc-test-folder-managed-1"
144-
folder_type = "app"
145-
}
146-
147-
resource "retool_folder" "test_folder2" {
148-
name = "tf-acc-test-folder-managed-2"
149-
folder_type = "app"
150-
}
151-
152-
resource "retool_permissions" "test_permissions" {
153-
subject = {
154-
type = "group"
155-
id = retool_group.test_group.id
156-
}
157-
permissions = [
158-
{
159-
object = {
160-
type = "folder"
161-
id = retool_folder.test_folder1.id
162-
}
163-
access_level = "use"
164-
},
165-
{
166-
object = {
167-
type = "folder"
168-
id = retool_folder.test_folder2.id
169-
}
170-
access_level = "edit"
171-
},
172-
]
173-
}
174-
`
175-
176-
// Step 2: Remove one permission from config.
177-
configWithOnePerm := `
178-
resource "retool_group" "test_group" {
179-
name = "tf-acc-test-group-managed-del"
180-
}
181-
182-
resource "retool_folder" "test_folder1" {
183-
name = "tf-acc-test-folder-managed-1"
184-
folder_type = "app"
185-
}
186-
187-
resource "retool_folder" "test_folder2" {
188-
name = "tf-acc-test-folder-managed-2"
189-
folder_type = "app"
190-
}
191-
192-
resource "retool_permissions" "test_permissions" {
193-
subject = {
194-
type = "group"
195-
id = retool_group.test_group.id
196-
}
197-
permissions = [
198-
{
199-
object = {
200-
type = "folder"
201-
id = retool_folder.test_folder2.id
202-
}
203-
access_level = "edit"
204-
},
205-
]
206-
}
207-
`
208-
209-
acctest.Test(t, resource.TestCase{
210-
Steps: []resource.TestStep{
211-
// Create permissions for two folders.
212-
{
213-
Config: configWithTwoPerms,
214-
Check: resource.ComposeAggregateTestCheckFunc(
215-
resource.TestCheckResourceAttr("retool_permissions.test_permissions", "permissions.#", "2"),
216-
// Don't check specific indices as order may vary.
217-
),
218-
},
219-
// Remove one permission from config.
220-
{
221-
Config: configWithOnePerm,
222-
Check: resource.ComposeAggregateTestCheckFunc(
223-
// Verify only one permission remains.
224-
resource.TestCheckResourceAttr("retool_permissions.test_permissions", "permissions.#", "1"),
225-
resource.TestCheckResourceAttr("retool_permissions.test_permissions", "permissions.0.access_level", "edit"),
226-
),
227-
},
228-
},
229-
})
230-
}
231-
232133
// TestAccPermissions_ImportAndRead verifies that importing permissions and subsequent
233134
// reads correctly maintain the imported permissions in state.
234135
func TestAccPermissions_ImportAndRead(t *testing.T) {

templates/index.md.tmpl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ The access token should have the following scopes:
2020
- permissions:all:read, permissions:all:write
2121
- configuration_variables:read, configuration_variables:write
2222
- environments:read, environments:write
23+
- users:read, users:write
24+
- resources:read, resources:write
25+
- resource_configurations:read, resource_configurations:write
2326

2427

2528
## Example Usage

0 commit comments

Comments
 (0)