Skip to content

fix: omit site attributes the server version does not support - #1931

Open
ranjithguggilla wants to merge 1 commit into
tableau:developmentfrom
ranjithguggilla:fix/806-site-create-version-gate
Open

ranjithguggilla wants to merge 1 commit into
tableau:developmentfrom
ranjithguggilla:fix/806-site-create-version-gate

Conversation

@ranjithguggilla

Copy link
Copy Markdown

Closes #806

Motivation

Creating a site sent every site setting, including the ones added for Tableau Server 2020.3 (REST API 3.9, TSC #777). Older servers reject a create-site body that contains attributes they do not know. Jac Fitzgerald asked for those attributes to be version-gated the way flow settings already are.

Behavior change

When a Server is passed into the site create or update request, attributes are omitted outside the API version that accepts them:

  • tier capacities: API 3.7 and later
  • dataAccelerationMode: API 3.8 through 3.15
  • the 2020.3 site settings (commenting, guest access, cache warmup, and the rest of that group): API 3.9 and later
  • cacheWarmupEnabled: also omitted from API 3.19, where it was removed
  • attributeCaptureEnabled: API 3.25 and later

A request built without a server still includes the attributes, so existing request snapshots stay the same. Name, content URL, admin mode, storage, subscriptions, and revision history are unchanged.

Test plan

test_create_req_omits_attributes_the_server_version_does_not_have checks API 2.8, 3.10, 3.19, 3.24, and 3.25. test/test_site.py passes.

Not covered: creating a site on an old Tableau Server.

Site creation always sent the settings added for API 3.9, so older
Tableau Servers rejected the request. Those attributes, and the ones
with a documented version window, are now left out unless the negotiated
API version accepts them.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Site creation with v0.15.0 fails with older Tableau Server versions

1 participant