docs: add Known server-side limitations section to api-ref.md - #1842
Open
jacalata wants to merge 2 commits into
Open
docs: add Known server-side limitations section to api-ref.md#1842jacalata wants to merge 2 commits into
jacalata wants to merge 2 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
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
1 participant
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