docs: add REST API links

jorwoods · Oct 18, 2024 · 30c9be2 · 30c9be2
1 parent 2690492
commit 30c9be2
Showing 1 changed file with 68 additions and 0 deletions.
diff --git a/tableauserverclient/server/endpoint/projects_endpoint.py b/tableauserverclient/server/endpoint/projects_endpoint.py
@@ -41,6 +41,8 @@ def get(self, req_options: Optional["RequestOptions"] = None) -> tuple[list[Proj
         Retrieves all projects on the site. The endpoint is paginated and can
         be filtered using the req_options parameter.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_projects.htm#query_projects
+
         Parameters
         ----------
         req_options : RequestOptions | None, default None
@@ -64,6 +66,8 @@ def delete(self, project_id: str) -> None:
         """
         Deletes a single project on the site.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_projects.htm#delete_project
+
         Parameters
         ----------
         project_id : str
@@ -95,6 +99,8 @@ def update(self, project_item: ProjectItem, samples: bool = False) -> ProjectIte
         TableauAuth instance using the content URL for the site (site_id), and
         sign in to that site.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_projects.htm#update_project
+
         Parameters
         ----------
         project_item : ProjectItem
@@ -137,6 +143,8 @@ def create(self, project_item: ProjectItem, samples: bool = False) -> ProjectIte
         project, create a TableauAuth instance using the content URL for the
         site (site_id), and sign in to that site.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_projects.htm#create_project
+
         Parameters
         ----------
         project_item : ProjectItem
@@ -168,6 +176,8 @@ def populate_permissions(self, item: ProjectItem) -> None:
         """
         Queries the project permissions, parses and stores the returned the permissions.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_project_permissions
+
         Parameters
         ----------
         item : ProjectItem
@@ -186,6 +196,8 @@ def update_permissions(self, item: ProjectItem, rules: list[PermissionsRule]) ->
         provided are expected to be a complete list of the permissions for the
         project.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_permissions_for_content
+
         Parameters
         ----------
         item : ProjectItem
@@ -207,6 +219,8 @@ def delete_permission(self, item: ProjectItem, rules: list[PermissionsRule]) ->
         """
         Deletes the specified permissions from the project item.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_project_permission
+
         Parameters
         ----------
         item : ProjectItem
@@ -227,6 +241,8 @@ def populate_workbook_default_permissions(self, item: ProjectItem) -> None:
         Queries the default workbook permissions, parses and stores the
         returned the permissions.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
+
         Parameters
         ----------
         item : ProjectItem
@@ -244,6 +260,8 @@ def populate_datasource_default_permissions(self, item: ProjectItem) -> None:
         Queries the default datasource permissions, parses and stores the
         returned the permissions.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
+
         Parameters
         ----------
         item : ProjectItem
@@ -261,6 +279,8 @@ def populate_metric_default_permissions(self, item: ProjectItem) -> None:
         Queries the default metric permissions, parses and stores the
         returned the permissions.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
+
         Parameters
         ----------
         item : ProjectItem
@@ -278,6 +298,8 @@ def populate_datarole_default_permissions(self, item: ProjectItem) -> None:
         Queries the default datarole permissions, parses and stores the
         returned the permissions.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
+
         Parameters
         ----------
         item : ProjectItem
@@ -295,6 +317,8 @@ def populate_flow_default_permissions(self, item: ProjectItem) -> None:
         Queries the default flow permissions, parses and stores the
         returned the permissions.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
+
         Parameters
         ----------
         item : ProjectItem
@@ -312,6 +336,8 @@ def populate_lens_default_permissions(self, item: ProjectItem) -> None:
         Queries the default lens permissions, parses and stores the
         returned the permissions.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
+
         Parameters
         ----------
         item : ProjectItem
@@ -329,6 +355,8 @@ def populate_virtualconnection_default_permissions(self, item: ProjectItem) -> N
         Queries the default virtualconnections permissions, parses and stores
         the returned the permissions.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
+
         Parameters
         ----------
         item : ProjectItem
@@ -347,6 +375,8 @@ def populate_database_default_permissions(self, item: ProjectItem) -> None:
         Queries the default database permissions, parses and stores the
         returned the permissions.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
+
         Parameters
         ----------
         item : ProjectItem
@@ -364,6 +394,8 @@ def populate_table_default_permissions(self, item: ProjectItem) -> None:
         Queries the default table permissions, parses and stores the
         returned the permissions.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
+
         Parameters
         ----------
         item : ProjectItem
@@ -382,6 +414,8 @@ def update_workbook_default_permissions(
         """
         Add or updates the default workbook permissions for the specified.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
+
         Parameters
         ----------
         item : ProjectItem
@@ -404,6 +438,8 @@ def update_datasource_default_permissions(
         """
         Add or updates the default datasource permissions for the specified.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
+
         Parameters
         ----------
         item : ProjectItem
@@ -426,6 +462,8 @@ def update_metric_default_permissions(
         """
         Add or updates the default metric permissions for the specified.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
+
         Parameters
         ----------
         item : ProjectItem
@@ -448,6 +486,8 @@ def update_datarole_default_permissions(
         """
         Add or updates the default datarole permissions for the specified.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
+
         Parameters
         ----------
         item : ProjectItem
@@ -468,6 +508,8 @@ def update_flow_default_permissions(self, item: ProjectItem, rules: list[Permiss
         """
         Add or updates the default flow permissions for the specified.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
+
         Parameters
         ----------
         item : ProjectItem
@@ -488,6 +530,8 @@ def update_lens_default_permissions(self, item: ProjectItem, rules: list[Permiss
         """
         Add or updates the default lens permissions for the specified.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
+
         Parameters
         ----------
         item : ProjectItem
@@ -510,6 +554,8 @@ def update_virtualconnection_default_permissions(
         """
         Add or updates the default virtualconnection permissions for the specified.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
+
         Parameters
         ----------
         item : ProjectItem
@@ -532,6 +578,8 @@ def update_database_default_permissions(
         """
         Add or updates the default database permissions for the specified.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
+
         Parameters
         ----------
         item : ProjectItem
@@ -554,6 +602,8 @@ def update_table_default_permissions(
         """
         Add or updates the default table permissions for the specified.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
+
         Parameters
         ----------
         item : ProjectItem
@@ -574,6 +624,8 @@ def delete_workbook_default_permissions(self, item: ProjectItem, rule: Permissio
         """
         Deletes the specified default permission rule from the project.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
+
         Parameters
         ----------
         item : ProjectItem
@@ -593,6 +645,8 @@ def delete_datasource_default_permissions(self, item: ProjectItem, rule: Permiss
         """
         Deletes the specified default permission rule from the project.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
+
         Parameters
         ----------
         item : ProjectItem
@@ -612,6 +666,8 @@ def delete_metric_default_permissions(self, item: ProjectItem, rule: Permissions
         """
         Deletes the specified default permission rule from the project.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
+
         Parameters
         ----------
         item : ProjectItem
@@ -631,6 +687,8 @@ def delete_datarole_default_permissions(self, item: ProjectItem, rule: Permissio
         """
         Deletes the specified default permission rule from the project.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
+
         Parameters
         ----------
         item : ProjectItem
@@ -650,6 +708,8 @@ def delete_flow_default_permissions(self, item: ProjectItem, rule: PermissionsRu
         """
         Deletes the specified default permission rule from the project.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
+
         Parameters
         ----------
         item : ProjectItem
@@ -669,6 +729,8 @@ def delete_lens_default_permissions(self, item: ProjectItem, rule: PermissionsRu
         """
         Deletes the specified default permission rule from the project.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
+
         Parameters
         ----------
         item : ProjectItem
@@ -688,6 +750,8 @@ def delete_virtualconnection_default_permissions(self, item: ProjectItem, rule:
         """
         Deletes the specified default permission rule from the project.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
+
         Parameters
         ----------
         item : ProjectItem
@@ -707,6 +771,8 @@ def delete_database_default_permissions(self, item: ProjectItem, rule: Permissio
         """
         Deletes the specified default permission rule from the project.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
+
         Parameters
         ----------
         item : ProjectItem
@@ -726,6 +792,8 @@ def delete_table_default_permissions(self, item: ProjectItem, rule: PermissionsR
         """
         Deletes the specified default permission rule from the project.
 
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
+
         Parameters
         ----------
         item : ProjectItem