Skip to content

Add preview deployment API reference docs#5053

Open
mintlify[bot] wants to merge 2 commits intomainfrom
mintlify/preview-api-docs-1775028357
Open

Add preview deployment API reference docs#5053
mintlify[bot] wants to merge 2 commits intomainfrom
mintlify/preview-api-docs-1775028357

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify bot commented Apr 1, 2026

Summary

  • Adds API reference documentation for four new preview deployment endpoints: create, list, get status, and delete
  • Updates OpenAPI specs (all locales: en, fr, es, zh) with full request/response schemas
  • Adds new "Preview deployments" navigation group to the API reference tab across all languages
  • Updates the API introduction page to list the new endpoints and add a "Preview deployments" use case

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/create page (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.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify bot commented Apr 1, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 1, 2026, 7:28 AM

Copy link
Copy Markdown

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

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