Type 2: Update Data Source Field Description

Open
#1,223 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
api

Research direction

Start with the Tableau REST API entry points and the linked Metadata API update_column documentation, then determine whether Tableau exposes a direct Data Source Field Description operation, including calculated fields. Trace how this repository represents REST operations and confirm the expected request and response before adding support; done means descriptions can be updated directly through the library and the behavior is verified against Tableau.

Written by the indexing model from the issue text.

Description

enhancement needs investigation Server-Side Enhancement ui-exists

Summary

It would be very helpful to be able to edit a Data Source Field Description via REST api (and subsequently scp).

Description

With the Metadata API, it is possible to update a Table's Column Description which does get inherited into the Data Source Field Description, however, it would be very helpful to be able to edit the Data Source Field Description directly.

We are trying to fully leverage the Data Management addon and automate the copy of our data dictionaries to Tableau descriptions, but only being able to add these to add the Table Column level is limiting. We can't add descriptions for Calculated Fields, for example.

Dominant language
Python
Stars
716
Forks
446
Avg merge
8d 8h
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from tableau/server-client-python

All issues in tableau/server-client-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.