Skip to content

Add preview deployment API endpoint docs#5429

Open
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/preview-api-docs-1776384740
Open

Add preview deployment API endpoint docs#5429
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/preview-api-docs-1776384740

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify bot commented Apr 17, 2026

Summary

  • Adds documentation for the new POST /project/preview/{projectId} API endpoint introduced in mintlify/server#4633
  • Adds the endpoint to the OpenAPI spec, creates MDX pages, updates navigation, and updates the API introduction page across all four locales (en, fr, es, zh)

Changes

  • OpenAPI specs (openapi.json, fr/openapi.json, es/openapi.json, zh/openapi.json): Added the preview deployment endpoint with request body schema, 202/400/403 responses
  • MDX pages (api/preview/trigger.mdx + localized variants): New API reference page for the endpoint
  • docs.json: Added the new page to the Admin navigation group in all locales
  • Introduction pages (api/introduction.mdx + localized variants): Listed the new endpoint, added a "Preview deployments" use case, and included it in the admin API key authentication list

Note

Low Risk
Docs-only changes (MDX/navigation/OpenAPI specs) with no runtime or security-sensitive code paths modified.

Overview
Adds documentation for a new admin endpoint, POST /project/preview/{projectId}, to programmatically create/rebuild branch preview deployments and return a statusId + previewUrl.

Updates the OpenAPI specs (en/fr/es/zh) with request/response schemas (202/400/403), adds new api/preview/trigger.mdx reference pages in all locales, wires them into docs.json navigation, and lists the endpoint/use case + admin-key auth coverage in each locale’s API introduction page.

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

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify bot commented Apr 17, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 17, 2026, 12:20 AM

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.

0 participants