Skip to content

docs: correct delete_obj_default_permissions sig #1483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 11, 2024
Merged

docs: correct delete_obj_default_permissions sig #1483

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions docs/api-ref.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2429,17 +2429,17 @@ Name | Description
TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow
}

rules = TSC.PermissionsRule(
rule = TSC.PermissionsRule(
grantee=project_item,
capabilities=capabilities
)

server.projects.update_flow_default_permissions(project_item, [rules])
server.projects.update_flow_default_permissions(project_item, [rule])
```

#### projects.delete_workbook_default_permissions
```py
projects.delete_workbook_default_permissions(item, rules)
projects.delete_workbook_default_permissions(item, rule)
```

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

**Example**

Expand All @@ -2467,17 +2467,17 @@ Name | Description
TSC.Permission.Capability.ViewComments: TSC.Permission.Mode.Allow
}

rules = TSC.PermissionsRule(
rule = TSC.PermissionsRule(
grantee=project_item,
capabilities=capabilities
)

server.projects.delete_workbook_default_permissions(project_item, [rules])
server.projects.delete_workbook_default_permissions(project_item, rule)
```

#### projects.delete_datasource_default_permissions
```py
projects.delete_datasource_default_permissions(item, rules)
projects.delete_datasource_default_permissions(item, rule)
```

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

**Example**

Expand All @@ -2505,17 +2505,17 @@ Name | Description
TSC.Permission.Capability.ExportXml: TSC.Permission.Mode.Allow
}

rules = TSC.PermissionsRule(
rule = TSC.PermissionsRule(
grantee=project_item,
capabilities=capabilities
)

server.projects.delete_datasource_default_permissions(project_item, [rules])
server.projects.delete_datasource_default_permissions(project_item, rule)
```

#### projects.delete_flow_default_permissions
```py
projects.delete_flow_default_permissions(item, rules)
projects.delete_flow_default_permissions(item, rule)
```

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

**Example**

Expand All @@ -2543,12 +2543,12 @@ Name | Description
TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow
}

rules = TSC.PermissionsRule(
rule = TSC.PermissionsRule(
grantee=project_item,
capabilities=capabilities
)

server.projects.delete_flow_default_permissions(project_item, [rules])
server.projects.delete_flow_default_permissions(project_item, rule)
```

<br>
Expand Down