Add preview deployment API reference docs#5053
Open
mintlify[bot] wants to merge 2 commits intomainfrom
Open
Conversation
Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Generated-By: mintlify-agent
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
Triggered by mintlify/server#4363.
Note
Low Risk
Documentation-only changes, but the large OpenAPI JSON edits (especially the expanded preview endpoints in
fr/openapi.json) could introduce spec inconsistencies or navigation mislinks if incorrect.Overview
Adds API reference docs for preview deployments, including a new
api/preview/createpage (and localized variants) and updates the API introductions to list the endpoint, a preview-deployments use case, and include it under admin-key authentication.Updates site navigation (
docs.json) across all supported languages to add a dedicated Preview deployments group under the API reference tab.Extends the OpenAPI specs to document
POST /project/{projectId}/preview(EN/ES/ZH), and in French also adds additional preview deployment operations (list, status, delete) under the preview paths.Written by Cursor Bugbot for commit 8e9c6d7. This will update automatically on new commits. Configure here.