GeezerVison is showing github.com — docs: add Known server-side limitations section to api-ref.md by jacalata · Pull Request #1842 · tableau/server-client-python
Conversation
jacalata
commented
Jul 30, 2026
•
edited
Loading
Uh oh!
There was an error while loading. Please reload this page.
Motivation
Users hitting a REST API limitation often assume TSC itself is the
problem and file an issue here. api-ref.md had no place to list gaps
that are actually server-side. Add a "Known server-side limitations"
section that points readers at the tracking issue for each gap and at
the Server-Side Enhancement label as the live index of the same.
Paired with #1841 which stops the stale bot from closing these
tracker issues.
Behavior change
None to the runtime library. Adds ~43 lines to docs/api-ref.md on the
gh-pages docs branch:
- New "Known server-side limitations" section at the end of the file,
seeded with five current gaps
- One-sentence cross-link from the top-of-page Note
Seed entries (each with its tracking issue where one exists):
Test plan
- Preview the rendered
api-ref.md on the gh-pages Jekyll site
- TOC entry for the new section renders (file uses
* TOC auto-generator)
- Cross-link
#known-server-side-limitations from top-of-page note resolves
- Each of the five GitHub issue links opens the expected issue
-
Server-Side Enhancement label link resolves
Relationship to #1835
#1835 also touches api-ref.md and adds inline caveats near the
request-options docs. This PR adds a new section at the end plus one
cross-link in the top-of-page note. The two edits target different
regions of the file so should not conflict; a maintainer reviewing
both should confirm merge order.
🤖 Generated with Claude Code
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Add a new user-facing section to docs/api-ref.md that lists behaviors
users may hit that are constrained by the Tableau Server REST API
rather than by TSC. Each entry links its tracking issue and notes
where the fix is expected to land. Cross-link the new section from
the top-of-page note, and point at the `Server-Side Enhancement`
label as the live tracker maintained by this repo.
Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
Public docs on gh-pages will be indexed, so remove the internal
work-item numbers (W-...) from the Known server-side limitations
section along with the paragraph that described what they were.
Also strip the redundant per-bullet "Fix expected: server-side"
tag: the section title already scopes the whole list to server-side
gaps.
Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Adds documentation to help users distinguish Tableau Server REST API limitations from Tableau Server Client (TSC) library gaps, reducing misfiled issues and directing readers to the right trackers.
Changes:
- Adds a cross-link in the top “Note” pointing to a new limitations section.
- Introduces a “Known server-side limitations” section listing current REST API constraints and linking to the
Server-Side Enhancement label and relevant issues.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Three fresh-eyes findings:
- Remove the "Subscriptions cannot use On Extract Refresh" entry. The
REST API's refreshExtractTriggered attribute does support this, and
TSC support is landing in #1861 (which closes the tracker #1658). The
entry is about to be factually wrong on both counts.
- Soften the intro: it promised "follow the appropriate issues" for
every item, but the vf_-silently-dropped entry has no tracker filed.
New wording says "where filed" so the doc doesn't overpromise.
- Reword the daily-schedules note to describe behavior neutrally
("currently runs daily schedules hourly instead") rather than calling
it a "bug", which reads punchy on a public docs page.
Opus-5 review found the entry's tracker link (#1431) points at a
closed-not-planned issue; the underlying gap was filed with the
Tableau REST API docs team internally and there's no realistic
timeline for it being tracked back in the TSC repo. Rather than
carry an untracked entry indefinitely, drop it. The behavior claim
(vf_ is exact-match / OR-list only) is now covered by the expanded
docstring on RequestOptions.vf() in #1840.
|
docs only change, merging with AI review only
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
Milestone
No milestone
Development
Successfully merging this pull request may close these issues.
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
|