Skip to content

Update API pages#6091

Open
ethanpalm wants to merge 2 commits into
mainfrom
api-overhaul
Open

Update API pages#6091
ethanpalm wants to merge 2 commits into
mainfrom
api-overhaul

Conversation

@ethanpalm
Copy link
Copy Markdown
Collaborator

@ethanpalm ethanpalm commented Jun 5, 2026

Note

Medium Risk
Large URL and navigation churn may break external links and bookmarks; behavior of the live APIs is unchanged but published doc paths and visible endpoints differ.

Overview
The REST API reference is regenerated from OpenAPI instead of per-endpoint MDX. In docs.json and localized nav (es.json, fr.json, zh.json), Admin, Agent, Assistant, and Analytics groups now use "openapi": "<spec>.json" rather than long pages lists; the old api/** MDX files for those operations are removed (English and translations).

api/introduction.mdx (and locale copies) retarget links to the new slug layout—e.g. /api/admin/trigger-update, /api/agent/create-agent-job, /api/analytics/get-feedback—dropping explicit v2 paths and version-suffixed assistant pages.

OpenAPI specs gain x-hidden on selected deprecated v1 agent and assistant routes, deprecated on assistant v1, and deprecation copy that points at the non-v2 doc URLs. openapi.json updates the preview deployment statusId description to link to Get deployment status at /api/admin/get-update-status.

Reviewed by Cursor Bugbot for commit 4ac42e9. Bugbot is set up for automated code reviews on this repo. Configure here.

ethanpalm added 2 commits June 4, 2026 17:14
- Updated discovery-openapi.json
- Updated es/admin-openapi.json
- Updated es/discovery-openapi.json
- Updated fr/admin-openapi.json
- Updated fr/discovery-openapi.json
- Updated zh/admin-openapi.json
- Updated zh/discovery-openapi.json
- Updated api/introduction.mdx
- Updated admin-openapi.json
- Updated openapi.json
- Updated es/api/introduction.mdx
- Updated fr/api/introduction.mdx
- Updated zh/api/introduction.mdx
- Deleted api/agent/create-agent-job.mdx
- Deleted api/agent/get-agent-job.mdx
- Deleted api/agent/get-all-jobs.mdx
- Deleted api/agent/v2/create-agent-job.mdx
- Deleted api/agent/v2/get-agent-job.mdx
- Deleted api/agent/v2/send-message.mdx
- Deleted api/analytics/assistant-caller-stats.mdx
- Deleted api/analytics/assistant-conversations.mdx
- Deleted api/analytics/feedback-by-page.mdx
- Deleted api/analytics/feedback.mdx
- Deleted api/analytics/searches.mdx
- Deleted api/analytics/views.mdx
- Deleted api/analytics/visitors.mdx
- Deleted api/assistant/create-assistant-message-v2.mdx
- Deleted api/assistant/create-assistant-message.mdx
- Deleted api/assistant/get-page-content.mdx
- Deleted api/assistant/search.mdx
- Deleted api/preview/trigger.mdx
- Deleted api/update/status.mdx
- Deleted api/update/trigger.mdx
- Deleted es/api/agent/create-agent-job.mdx
- Deleted es/api/agent/get-agent-job.mdx
- Deleted es/api/agent/get-all-jobs.mdx
- Deleted es/api/agent/v2/create-agent-job.mdx
- Deleted es/api/agent/v2/get-agent-job.mdx
- Deleted es/api/agent/v2/send-message.mdx
- Deleted es/api/analytics/assistant-caller-stats.mdx
- Deleted es/api/analytics/assistant-conversations.mdx
- Deleted es/api/analytics/feedback-by-page.mdx
- Deleted es/api/analytics/feedback.mdx
- Deleted es/api/analytics/searches.mdx
- Deleted es/api/analytics/views.mdx
- Deleted es/api/analytics/visitors.mdx
- Deleted es/api/assistant/create-assistant-message-v2.mdx
- Deleted es/api/assistant/create-assistant-message.mdx
- Deleted es/api/assistant/get-page-content.mdx
- Deleted es/api/assistant/search.mdx
- Deleted es/api/preview/trigger.mdx
- Deleted es/api/update/status.mdx
- Deleted es/api/update/trigger.mdx
- Deleted fr/api/agent/create-agent-job.mdx
- Deleted fr/api/agent/get-agent-job.mdx
- Deleted fr/api/agent/get-all-jobs.mdx
- Deleted fr/api/agent/v2/create-agent-job.mdx
- Deleted fr/api/agent/v2/get-agent-job.mdx
- Deleted fr/api/agent/v2/send-message.mdx
- Deleted fr/api/analytics/assistant-caller-stats.mdx
- Deleted fr/api/analytics/assistant-conversations.mdx
- Deleted fr/api/analytics/feedback-by-page.mdx
- Deleted fr/api/analytics/feedback.mdx
- Deleted fr/api/analytics/searches.mdx
- Deleted fr/api/analytics/views.mdx
- Deleted fr/api/analytics/visitors.mdx
- Deleted fr/api/assistant/create-assistant-message-v2.mdx
- Deleted fr/api/assistant/create-assistant-message.mdx
- Deleted fr/api/assistant/get-page-content.mdx
- Deleted fr/api/assistant/search.mdx
- Deleted fr/api/preview/trigger.mdx
- Deleted fr/api/update/status.mdx
- Deleted fr/api/update/trigger.mdx
- Deleted zh/api/agent/create-agent-job.mdx
- Deleted zh/api/agent/get-agent-job.mdx
- Deleted zh/api/agent/get-all-jobs.mdx
- Deleted zh/api/agent/v2/create-agent-job.mdx
- Deleted zh/api/agent/v2/get-agent-job.mdx
- Deleted zh/api/agent/v2/send-message.mdx
- Deleted zh/api/analytics/assistant-caller-stats.mdx
- Deleted zh/api/analytics/assistant-conversations.mdx
- Deleted zh/api/analytics/feedback-by-page.mdx
- Deleted zh/api/analytics/feedback.mdx
- Deleted zh/api/analytics/searches.mdx
- Deleted zh/api/analytics/views.mdx
- Deleted zh/api/analytics/visitors.mdx
- Deleted zh/api/assistant/create-assistant-message-v2.mdx
- Deleted zh/api/assistant/create-assistant-message.mdx
- Deleted zh/api/assistant/get-page-content.mdx
- Deleted zh/api/assistant/search.mdx
- Deleted zh/api/preview/trigger.mdx
- Deleted zh/api/update/status.mdx
- Deleted zh/api/update/trigger.mdx
- Updated docs.json
- Updated es.json
- Updated fr.json
- Updated zh.json

Mintlify-Source: dashboard-editor
- Updated discovery-openapi.json
- Updated es/admin-openapi.json
- Updated es/discovery-openapi.json
- Updated fr/admin-openapi.json
- Updated fr/discovery-openapi.json
- Updated zh/admin-openapi.json
- Updated zh/discovery-openapi.json
- Updated api/introduction.mdx
- Updated admin-openapi.json
- Updated openapi.json
- Updated es/api/introduction.mdx
- Updated fr/api/introduction.mdx
- Updated zh/api/introduction.mdx

Mintlify-Source: dashboard-editor
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Jun 5, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
smartac 🟢 Ready View Preview Jun 5, 2026, 12:18 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Jun 5, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
testsignup415 🟢 Ready View Preview Jun 5, 2026, 12:19 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Jun 5, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
adminroletesting 🟢 Ready View Preview Jun 5, 2026, 12:20 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Jun 5, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
hfh-d7a4d643 🟢 Ready View Preview Jun 5, 2026, 12:21 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Jun 5, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
gwgwgw 🟢 Ready View Preview Jun 5, 2026, 12:22 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Jun 5, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Jun 5, 2026, 12:23 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants