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.
Summary
Adds a new Known server-side limitations section at the end of
docs/api-ref.mdon thegh-pagesdocs branch. The section helps TSC users identify when a problem they are hitting is caused by a limitation in the Tableau Server REST API rather than by TSC itself, and directs them to the relevant tracking issues.The section is seeded with five currently-known server-side gaps, each linking to its GitHub issue where one exists:
vf_view filter query parameters support exact match only — no operator prefixes (gt:,lt:,in:), wildcards, or ranges. Tracked in #1431.vf_view filter is silently dropped when the server-side view already has an operator-based filter on the same field.The top-of-page Note now cross-links to the new section, and the new section points at the
Server-Side Enhancementlabel as the live, maintainer-updated view of the same issues.Relationship to other in-flight docs work
#1835 also touches
docs/api-ref.mdand adds a note aboutvf_in the request-options area. The two changes are complementary and edit different regions of the file — this PR adds a new section at the end plus a one-sentence cross-link in the top-of-page note; #1835 adds inline caveats near the request-options docs. There should be no merge conflict, but a maintainer reviewing both should confirm.Test plan
docs/api-ref.mdon the gh-pages Jekyll site and confirm the new Known server-side limitations section renders correctly.* TOCauto-generator).#known-server-side-limitations) resolves.Server-Side Enhancementlabel link resolves to the labels view.🤖 Generated with Claude Code