Open
Conversation
Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
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.
Summary
POST /project/preview/{projectId}API endpoint introduced in mintlify/server#4633Changes
openapi.json,fr/openapi.json,es/openapi.json,zh/openapi.json): Added the preview deployment endpoint with request body schema, 202/400/403 responsesapi/preview/trigger.mdx+ localized variants): New API reference page for the endpointdocs.json: Added the new page to the Admin navigation group in all localesapi/introduction.mdx+ localized variants): Listed the new endpoint, added a "Preview deployments" use case, and included it in the admin API key authentication listNote
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 astatusId+previewUrl.Updates the OpenAPI specs (en/fr/es/zh) with request/response schemas (202/400/403), adds new
api/preview/trigger.mdxreference pages in all locales, wires them intodocs.jsonnavigation, 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.