Repository navigation
Document the Traffic tab and traffic history (DEPLOY-200) - #1358
Merged
Merged
Conversation
- New traffic-tab.mdx documents the assistant Traffic tab: per-version volume, configured vs actual share, duration, cost per minute, latency, and ended reasons, plus the metrics API and a worked canary-ramp example - New traffic-history.mdx documents the traffic history panel: every split change with its shares, note, author, and timestamp, plus the List traffic allocations API - Cross-link both new pages from traffic-splitting.mdx so readers can jump from editing a split to reviewing its performance or history - Promote "Traffic splitting" from a page to a section in docs.yml nav, nesting "Compare versions" and "Traffic history" underneath it Fixes DEPLOY-200 OpenCode session ID: ses_e961a8a91ffeceqON7606jgiGn
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a16a00-abfa-76ae-829f-7c85e4dd88eb.docs.buildwithfern.com |
- Replace the org-enablement and split-read-permission bullet with a direct statement naming the built-in Admin, Editor, and Viewer roles that can open the tab, falling back to permission language only for custom roles - Remove the paragraphs describing the empty-state messaging and the URL-persisted range/version selection, since bets review flagged them as unnecessary detail for this section OpenCode session ID: ses_e961a8a91ffeceqON7606jgiGn
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a16aba-4766-71cd-a015-1bf8262be270.docs.buildwithfern.com |
Traffic splitting left beta on 2026-10-23 (DEPLOY-200), but the vapi controller still stamps these endpoints beta by default. - Override x-fern-availability to generally-available for all five /traffic-allocations endpoints (list/create, latest, metrics, get by id) - Drop the beta availability flag from the Traffic splitting nav section in docs.yml so the sidebar badge matches the API reference OpenCode session ID: ses_e961a8a91ffeceqON7606jgiGn
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a16abc-670b-723a-989f-4a651fa266af.docs.buildwithfern.com |
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a17910-3bb7-702f-af82-df29100023f4.docs.buildwithfern.com |
stephenvapiai
left a comment
stephenvapiai
left a comment
Contributor
There was a problem hiding this comment.
Edit pass on the new and changed passages. These are editorial suggestions, with a few for terminology consistency, plus one question on line 161 of traffic-tab.mdx, notes to add chart screenshots once the format is locked, and one request on openapi-overrides.yml.
stephenvapiai
approved these changes
Oct 26, 2026
- Shorten frontmatter descriptions across traffic-history,
traffic-splitting, and traffic-tab docs for conciseness
- Standardize on "latest published version" phrasing instead of
"newest published version" throughout
- Prefer "calls" over "traffic" where it's calls being measured, and
spell out "configured share" vs "actual share" instead of reusing
bare "share"
- Explain that calls setting assistantVersion in the create call
request skip the split, with a link to the API reference
- Fix link title to match the actual page title ("Get traffic split
metrics" instead of the API path), and align step titles/headings
with their content ("Confirm the canary is getting calls", "Decide
whether to ramp", "Which calls and splits the tab shows")
- Replace the internal beta-tracking comment in openapi-overrides.yml
with a public-safe note, dropping the internal ticket reference
(DEPLOY-200) and team name
OpenCode session ID: ses_e961a8a91ffeceqON7606jgiGn
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a17965-3c5b-7349-be4d-e68ec47dd041.docs.buildwithfern.com |
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.
Description
Documents the assistant Traffic tab, its per-version metrics, and the traffic history panel. All three rolled out to every org that has traffic splitting on 2026-10-23. Requested by Bets after the rollout; text only, no screenshots. Linear: DEPLOY-200 (follow-up to DEPLOY-183).
New
fern/assistants/versioning/traffic-tab.mdx, titled "Compare versions on the Traffic tab". It explains what each view answers, how to open the tab (Dashboard and API tabs), the range menu including the five previous splits, focusing on versions, how to read each card (p50/p95, cost and latency parts, ended reasons), and a worked canary-ramp example.New
fern/assistants/versioning/traffic-history.mdx, titled "Review traffic history". It explains opening the panel from More actions, reading an entry, opening a split's metrics on the Traffic tab, Edit split, and the list API.traffic-splitting.mdxlinks to both pages, renames "the traffic pill" to the Traffic header entry, and points "Comparing versions fairly" at the tab.docs.yml: "Traffic splitting" changes from a page to a section that keeps the same path, now without the beta badge, with "Compare versions" and "Traffic history" nested under it.openapi-overrides.yml: the five/traffic-allocationsendpoints are overridden togenerally-available, since the vapi controller still stamps them beta.No merge dependency. Per Bets's review, the empty-state paragraph (which described the unmerged VapiAI/vapi#23891) is removed, along with the org-enablement prerequisite; the permissions bullet now names the built-in roles. Everything describes behavior already on
main, written so it holds whether or not David's PAL-1190 polish (#24139–#24141) lands.Testing Steps
fern docs devor navigate to preview deployment