8000 docs: correct delete_obj_default_permissions sig (#1483) · tableau/server-client-python@8bdaa67 · GitHub
[go: up one dir, main page]
Skip to content

Commit 8bdaa67

Browse files
jorwoodsjorwoods
authored
docs: correct delete_obj_default_permissions sig (#1483)
Closes #1241 The docs were incorrect as to what arguments delete_*_default_permissions accepted. This corrects the docs to show that the methods accept an object and not an iterable of objects. Co-authored-by: Jordan Woods <13803242+jorwoods@users.noreply.github.com>
1 parent 85e9682 commit 8bdaa67

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

‎docs/api-ref.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2429,17 +2429,17 @@ Name | Description
24292429
TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow
24302430
}
24312431

2432-
rules = TSC.PermissionsRule(
2432+
rule = TSC.PermissionsRule(
24332433
grantee=project_item,
24342434
capabilities=capabilities
24352435
)
24362436

2437-
server.projects.update_flow_default_permissions(project_item, [rules])
2437+
server.projects.update_flow_default_permissions(project_item, [rule])
24382438
```
24392439

24402440
#### projects.delete_workbook_default_permissions
24412441
```py
2442-
projects.delete_workbook_default_permissions(item, rules)
2442+
projects.delete_workbook_default_permissions(item, rule)
24432443
```
24442444

24452445
Delete default workbook permissions.
@@ -2451,7 +2451,7 @@ REST API: [Delete Default Workbook Permissions](https://help.tableau.com/current
24512451
Name | Description
24522452
:--- | :---
24532453
`item` | A project object.
2454-
`rules` | A list of PermissionsRule objects.
2454+
`rule` | A PermissionsRule object.
24552455

24562456
**Example**
24572457

@@ -2467,17 +2467,17 @@ Name | Description
24672467
TSC.Permission.Capability.ViewComments: TSC.Permission.Mode.Allow
24682468
}
24692469

2470-
rules = TSC.PermissionsRule(
2470+
rule = TSC.PermissionsRule(
24712471
grantee=project_item,
24722472
capabilities=capabilities
24732473
)
24742474

2475-
server.projects.delete_workbook_default_permissions(project_item, [rules])
2475+
server.projects.delete_workbook_default_permissions(project_item, rule)
24762476
```
24772477

24782478
#### projects.delete_datasource_default_permissions
24792479
```py
2480-
projects.delete_datasource_default_permissions(item, rules)
2480+
projects.delete_datasource_default_permissions(item, rule)
24812481
```
24822482

24832483
Delete default datasource permissions.
@@ -2489,7 +2489,7 @@ REST API: [Delete Default Datasource Permissions](https://help.tableau.com/curre
24892489
Name | Description
24902490
:--- | :---
24912491
`item` | A project object.
2492-
`rules` | A list of PermissionsRule objects.
2492+
`rule` | A PermissionsRule object.
24932493

24942494
**Example**
24952495

@@ -2505,17 +2505,17 @@ Name | Description
25052505
TSC.Permission.Capability.ExportXml: TSC.Permission.Mode.Allow
25062506
}
25072507

2508-
rules = TSC.PermissionsRule(
2508+
rule = TSC.PermissionsRule(
25092509
grantee=project_item,
25102510
capabilities=capabilities
25112511
)
25122512

2513-
server.projects.delete_datasource_default_permissions(project_item, [rules])
2513+
server.projects.delete_datasource_default_permissions(project_item, rule)
25142514
```
25152515

25162516
#### projects.delete_flow_default_permissions
25172517
```py
2518-
projects.delete_flow_default_permissions(item, rules)
2518+
projects.delete_flow_default_permissions(item, rule)
25192519
```
25202520

25212521
Delete default flow permissions.
@@ -2527,7 +2527,7 @@ REST API: [Delete Default Flow Permissions](https://help.tableau.com/current/api
25272527
Name | Description
25282528
:--- | :---
25292529
`item` | A project object.
2530-
`rules` | A list of PermissionsRule objects.
2530+
`rule` | A PermissionsRule object.
25312531

25322532
**Example**
25332533

@@ -2543,12 +2543,12 @@ Name | Description
25432543
TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow
25442544
}
25452545

2546-
rules = TSC.PermissionsRule(
2546+
rule = TSC.PermissionsRule(
25472547
grantee=project_item,
25482548
capabilities=capabilities
25492549
)
25502550

2551-
server.projects.delete_flow_default_permissions(project_item, [rules])
2551+
server.projects.delete_flow_default_permissions(project_item, rule)
25522552
```
25532553

25542554
<br>

0 commit comments

Comments
 (0)
0