Skip to content

Document that publish server_address matches connections rather than changing them - #1903

Open
jacalata wants to merge 2 commits into
gh-pagesfrom
jac/docs-publish-server-address
Open

jacalata wants to merge 2 commits into
gh-pagesfrom
jac/docs-publish-server-address

Conversation

@jacalata

Copy link
Copy Markdown
Contributor

Summary

  • Explains that the server_address of a ConnectionItem passed to workbooks.publish identifies which embedded connection the credentials belong to. It does not change the connection's server.
  • Adds an example that publishes, then changes the address with workbooks.update_connection.
  • Corrects the workbooks.publish signature, a doubled workbook_item code span, and the update_connection return value.

Closes #337

🤖 Generated with Claude Code

jacalata and others added 2 commits November 9, 2026 13:51
…changing them

Users passing a ConnectionItem with a new server_address to
workbooks.publish expected the published connection to point at that
server, and got error 403007 instead. The server uses server_address to
find the matching connection embedded in the workbook file; it does not
change it. Explain this, show how to change the address afterwards with
workbooks.update_connection, and correct the ConnectionItem
server_address description (it is the data source host, not the Tableau
Server host).

Closes #337

Co-Authored-By: Claude Code <noreply@anthropic.com>
The publish signature listed file_path and publish_mode (the parameters
are file and mode) and omitted the parameters argument and defaults, a
parameter description repeated workbook_item twice, and
workbooks.update_connection was documented as returning None when it
returns the updated ConnectionItem.

Co-Authored-By: Claude Code <noreply@anthropic.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant