docs: remove fabricated API from enterprise environments guide - #1237
Draft
chris-garber-vapi wants to merge 1 commit into
Draft
chris-garber-vapi wants to merge 1 commit into
chris-garber-vapi wants to merge 1 commit into
Conversation
The enterprise environments page documented an API and tooling that do not exist. It taught readers to call `https://api.vendor.com/v1/assistants`, use an invented resource schema (`kind: Assistant`, `apiVersion: v1`, `spec.systemPromptRef`, `safetyPolicyRef`), and run invented commands (`npm run plan -- --env uat`, `npm run validate:all`), including a GitHub Actions workflow and a Node deployer built on all of it. None of it corresponds to Vapi or to the VapiAI/gitops template. Remove the fabricated schema, curl examples, Node deployer, and CI workflow. Keep the environment topology, RBAC and secrets guidance, promotion workflow, runbooks, checklist, and the built-in versioning FAQ answer, which are accurate. Point readers to https://github.com/VapiAI/gitops for the supported implementation, and correct the managed-resource list to the nine resource types that template actually supports. Also state explicitly that storing configuration in Git does not by itself enforce review, testing, or release gates. A follow-up PR expands this into a full GitOps guide. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Lightsage docs evalsResult: passed Average score: 100/100
|
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a0b334-9c8b-73af-a58f-f7c6168a05f5.docs.buildwithfern.com |
chris-garber-vapi
marked this pull request as draft
September 18, 2026 20:37
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.
Problem
fern/enterprise/dev-uat-prod.mdxdocuments an API and tooling that do not exist. It currently teaches readers, as if real:https://api.vendor.com/v1/assistantsin curl examples and a Node deployerkind: Assistant,apiVersion: v1,spec.systemPromptRef,safetyPolicyRefnpm run plan -- --env uat,npm run validate:all,npm run apply -- --env prod --approveNone of it corresponds to Vapi or to VapiAI/gitops, which uses
.md/.ymlresource files,.env.<org>, andsetup/validate/apply/promote/audit/rollback.This is live at docs.vapi.ai/documentation/best-practices/enterprise-environments-dev-uat-prod.
Change
Removes the fabricated schema, curl examples, Node deployer, and CI workflow — about 80% of the page.
Keeps what is accurate: environment topology, RBAC and secrets guidance, promotion workflow, operational runbooks, promotion checklist, and the built-in versioning FAQ answer.
Two corrections beyond deletion:
Runtimes/Policies,safetyPolicyRef). Replaced with the nine resource types the GitOps template actually supports: assistants, squads, tools, structured outputs, personalities, scenarios, simulations, simulation suites, evals.Points readers to the GitOps template as the authoritative reference until the follow-up lands.
Scope
Deliberately a deletion, not a rewrite. The full GitOps guide — real setup, the command table, promotion via the template's shipped
promotion.yml, and a redirect to a/gitopsslug — is the next PR in the stack. This one is separated so the incorrect content can come down without waiting on review of new pages.No navigation or slug changes, so the public URL is unaffected.
Verification
vendor.com,apiVersion,systemPromptRef,safetyPolicyRef,npm run plan,validate:all,secrets://,Idempotency-Key)./assistants/versioning,/observability/simulations-quickstart,/test/run-and-maintain-tests.<Note>tags balanced and no stray<that would break MDX parsing.fern checknot run locally —FERN_CLI_PATHis unset and the Fern CLI isn't installed here. This change touches only MDX body content, nodocs.ymlor API spec, so CI's run should be the meaningful one.🤖 Generated with Claude Code