Skip to content

Workbook update Description #1516

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
jacalata merged 3 commits into from
Nov 1, 2024
Merged

Workbook update Description #1516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c4a3a09
Allows workbook updates to change the description starting with api v…
LehmD Oct 25, 2024
e11d098
Fixes formatting
LehmD Oct 28, 2024
56a781a
Fixes style issues caused by using black and python version 3.13
LehmD Oct 31, 2024
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
2 changes: 1 addition & 1 deletion tableauserverclient/server/endpoint/workbooks_endpoint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ def update(
if include_view_acceleration_status:
url += "?includeViewAccelerationStatus=True"

update_req = RequestFactory.Workbook.update_req(workbook_item)
update_req = RequestFactory.Workbook.update_req(workbook_item, self.parent_srv)
server_response = self.put_request(url, update_req)
logger.info(f"Updated workbook item (ID: {workbook_item.id})")
updated_workbook = copy.copy(workbook_item)
Expand Down
8 changes: 7 additions & 1 deletion tableauserverclient/server/request_factory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -960,7 +960,7 @@ def _generate_xml(
_add_hiddenview_element(views_element, view_name)
return ET.tostring(xml_request)

def update_req(self, workbook_item):
def update_req(self, workbook_item, parent_srv: Optional["Server"] = None):
xml_request = ET.Element("tsRequest")
workbook_element = ET.SubElement(xml_request, "workbook")
if workbook_item.name:
Expand All @@ -973,6 +973,12 @@ def update_req(self, workbook_item):
if workbook_item.owner_id:
owner_element = ET.SubElement(workbook_element, "owner")
owner_element.attrib["id"] = workbook_item.owner_id
if (
workbook_item.description is not None
and parent_srv is not None
and parent_srv.check_at_least_version("3.21")
):
workbook_element.attrib["description"] = workbook_item.description
if workbook_item._views is not None:
views_element = ET.SubElement(workbook_element, "views")
for view in workbook_item.views:
Expand Down