You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When reviewing documentation PRs, please consider:
✅ Technical accuracy
Code examples work as written
Commands and configurations are correct
Links resolve to the right destinations
Prerequisites and requirements are accurate
✅ Clarity and completeness
Instructions are clear and easy to follow
Steps are in logical order
Nothing important is missing
Examples help illustrate the concepts
✅ User experience
A new user could follow these docs successfully
Common gotchas or edge cases are addressed
Error messages or troubleshooting guidance is helpful
Note
Low Risk
Documentation and URL routing only; redirects mitigate broken links, with no application runtime changes in this diff.
Overview
This PR refreshes Mintlify REST API documentation by driving most reference pages from OpenAPI instead of hand-written MDX wrappers.
OpenAPI consolidation: Deployment routes from deleted openapi.json move into admin-openapi.json with /v1 paths, operationIds, Deployments / Agent tags, examples, cURL x-codeSamples, and x-mcp on the admin spec. V1 agent routes stay in the spec but are deprecated + x-hidden. analytics.openapi.json and discovery-openapi.json gain root-level security, clearer pagination/rate-limit copy, and cURL samples; assistant operations are labeled AI SDK v4 vs v5+.
Site navigation:docs.json wires Deployments, Agent, and Analytics groups to OpenAPI operation paths; removes MDX pages for update/preview/agent v2/analytics endpoints; adds a Search group and registers admin, analytics, and discovery OpenAPI files globally.
Content & URLs:api/introduction.mdx is shortened and links to /api-reference/.... Assistant guides keep integration docs but add billing notes and rename titles. redirects.json maps legacy /api/update/*, /api/agent/v2/*, and /api/analytics/* to the new api-reference slugs.
Reviewed by Cursor Bugbot for commit 1796a34. Bugbot is set up for automated code reviews on this repo. Configure here.
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
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.
Documentation changes
Compare to #6091 created with agent editor.
This PR was made with Claude Code
For Reviewers
When reviewing documentation PRs, please consider:
✅ Technical accuracy
✅ Clarity and completeness
✅ User experience
Note
Low Risk
Documentation and URL routing only; redirects mitigate broken links, with no application runtime changes in this diff.
Overview
This PR refreshes Mintlify REST API documentation by driving most reference pages from OpenAPI instead of hand-written MDX wrappers.
OpenAPI consolidation: Deployment routes from deleted
openapi.jsonmove intoadmin-openapi.jsonwith/v1paths,operationIds, Deployments / Agent tags, examples, cURLx-codeSamples, andx-mcpon the admin spec. V1 agent routes stay in the spec but aredeprecated+x-hidden.analytics.openapi.jsonanddiscovery-openapi.jsongain root-level security, clearer pagination/rate-limit copy, and cURL samples; assistant operations are labeled AI SDK v4 vs v5+.Site navigation:
docs.jsonwires Deployments, Agent, and Analytics groups to OpenAPI operation paths; removes MDX pages for update/preview/agent v2/analytics endpoints; adds a Search group and registersadmin,analytics, anddiscoveryOpenAPI files globally.Content & URLs:
api/introduction.mdxis shortened and links to/api-reference/.... Assistant guides keep integration docs but add billing notes and rename titles.redirects.jsonmaps legacy/api/update/*,/api/agent/v2/*, and/api/analytics/*to the new api-reference slugs.Reviewed by Cursor Bugbot for commit 1796a34. Bugbot is set up for automated code reviews on this repo. Configure here.