docs: add Known server-side limitations section to api-ref.md - #1842
Open
jacalata wants to merge 3 commits into
Open
docs: add Known server-side limitations section to api-ref.md#1842jacalata wants to merge 3 commits into
jacalata wants to merge 3 commits into
Conversation
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) <noreply@anthropic.com>
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) <noreply@anthropic.com>
3 tasks
There was a problem hiding this comment.
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 Enhancementlabel and relevant issues.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+10964
to
+10966
| Some behaviors you may hit while using TSC are not bugs in the TSC library. They are limitations of the Tableau Server REST API itself, and cannot be fixed in TSC alone. This section lists the currently-tracked server-side gaps so you can identify them quickly and follow the appropriate issues. | ||
|
|
||
| For the live, maintainer-updated view of these issues, filter open issues in this repository by the [`Server-Side Enhancement`](https://github.com/tableau/server-client-python/labels/Server-Side%20Enhancement) label. |
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
Users hitting a REST API limitation often assume TSC itself is the
problem and file an issue here.
api-ref.mdhad no place to list gapsthat 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 Enhancementlabel 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.mdon thegh-pagesdocs branch:seeded with five current gaps
Seed entries (each with its tracking issue where one exists):
vf_view filter query parameters support exact match only -- nooperator prefixes, wildcards, or ranges. Tracked in Wildcard filter docs clarification #1431.
vf_view filter is silently dropped when the server-side viewalready has an operator-based filter on the same field. No tracking
issue yet.
Tableau Cloud (returns 500). Tracked in Extract Refresh task with a Daily schedule don't work as expected #1508.
API. Tracked in Unabled to create Subscriptions with schedule as "On Extract Refresh" #1658.
the REST API. Tracked in Flow image unavailable when using flows publish method #1537.
Test plan
api-ref.mdon the gh-pages Jekyll site* TOCauto-generator)#known-server-side-limitationsfrom top-of-page note resolvesServer-Side Enhancementlabel link resolvesRelationship to #1835
#1835 also touches
api-ref.mdand adds inline caveats near therequest-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