search

tableau / server-client-python

A Python library for the Tableau Server REST API
https://tableau.github.io/server-client-python/
MIT License
657 stars 422 forks source link

Add Workbook Item Description #1147

Open allturnip opened 1 year ago

allturnip commented 1 year ago

Summary

Provide a setter for the workbook item Description Field

Request Type

Support a REST API

The API: PUT /api/api-version/sites/site-id/workbooks/workbook-id supports a description field. the Schema definition for WorkbookType contains an element xs:attribute name="description" type="xs:string"

The Python API currently does not support this element. It could be added by modifying:

  1. tableauserverclient/models/workbook_item.py -- adding a setter for description

  2. tableauserverclient/server/request_factory.py: update class WorkbookRequest : _generate_xml : in the same method as other elements, add a description :
    if workbook_item.description: workbook_element.attrib['description'] = workbook_item.description

    add same code to procedure update_req.

This change allows a workbook description to be added at time of upload, preventing manual intervention after report promotions, migrations, or other automated processes.

nosnilmot commented 1 year ago

The current REST API Workbooks Methods documentation does not include a description field in any publish or update methods, only in responses

jacalata commented 1 year ago

That's correct: the description field is not settable through the API currently. I don't think there's a real reason for that, so I'll prod the team that owns that area.

geerties99 commented 4 months ago

Has the setter for description been added already? Could need it for a current project.

AverageJoeGuy-tech commented 4 months ago

Has the status of this changed? The REST API currently allows workbook description to be set/changed in PUT.