docs(api-reference): add hidden Simulations API reference#1060
Open
nickrobin wants to merge 1 commit into
Open
docs(api-reference): add hidden Simulations API reference#1060nickrobin wants to merge 1 commit into
nickrobin wants to merge 1 commit into
Conversation
nickrobin
force-pushed
the
nickrobin/api-docs-simulations
branch
from
535040a to
a540529
Compare
Contributor
|
🌿 Preview your docs: https://vapi-preview-db79a7e6-9489-4bfe-9541-0b03e1783800.docs.buildwithfern.com |
Documents the simulation endpoints (15 paths across Simulations, Simulation Runs, Run Items, Suites, Scenarios, Personalities) in the API reference sidebar. These endpoints are tagged 'alpha' in the backend and stripped from the public api-json the docs auto-sync from, so they're added in apis/api/openapi-overrides.yml (which the daily sync doesn't overwrite). They reuse the Assistant/voice/etc. schemas already in the spec; only 6 newer provider schemas are added. No vapi backend changes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
nickrobin
force-pushed
the
nickrobin/api-docs-simulations
branch
from
a540529 to
180653d
Compare
Contributor
|
🌿 Preview your docs: https://vapi-preview-8ae08fb1-0ccf-497b-93be-9b4e2eaf2c83.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
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.
Adds the alpha simulation endpoints (Simulations, Runs, Run Items, Suites, Scenarios, Personalities — 15 paths) to the API reference as a hidden page: not shown in the sidebar or search (noindex), but reachable by direct URL.
These endpoints are tagged 'alpha' in the backend and are stripped from the public api-json that the docs sync pulls from, so they are documented here via a self-contained, docs-only API definition (apis/simulations/, no SDK generators) snapshotted from the alpha OpenAPI. No vapi backend changes.
Description
Testing Steps
fern docs devor navigate to preview deployment