Skip to content

Update from code changes: static export API projectId scope - #7016

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/accd9370
Open

Update from code changes: static export API projectId scope#7016
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/accd9370

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Summary

Realigns the static export API reference with the shipped external API: routes are now scoped by projectId, the separate bundle-generation endpoint was folded into the job status response, and the flow drops to two steps. See mintlify/server#7479.

Changes

  • Rewrote static-export-openapi.json (en/es/fr/zh):
    • Renamed paths to POST /static-export/{projectId}/jobs and GET /static-export/{projectId}/jobs/{jobId}.
    • Removed the POST /static-export/jobs/{jobId}/bundle endpoint and its request/response schemas.
    • Removed the request body from job start (no more domain / version / paths).
    • Removed progress and pageCount from the job schema; added bundleUrl, sizeBytes, and expiresAt on completed jobs.
    • Documented 403 (entitlement gate), 409 (one active job per deployment), and 429 (10 job starts per org per hour).
  • Rewrote the overview page to a 2-step flow (start, then poll for status and download link) and updated the GitHub Action example to use the projectId-scoped URLs.
  • Removed api/static-export/generate-bundle.mdx (and translations) and dropped it from the navigation in docs.json, es.json, fr.json, zh.json.
  • Updated the openapi frontmatter on start-job.mdx and get-job-status.mdx in every language to the new paths.

Context

Triggered by https://github.com/mintlify/server/pull/7479.


Note

Low Risk
Documentation and OpenAPI-only changes for an enterprise API reference; no runtime code paths in this repo.

Overview
Realigns static export API docs and OpenAPI with the shipped external API (routes scoped by projectId, bundle download folded into job status).

The generate export bundle endpoint and its MDX pages (en/es/fr/zh) are removed; navigation in docs.json and locale JSON files drops that page. Paths become POST /static-export/{projectId}/jobs and GET /static-export/{projectId}/jobs/{jobId} in all static-export-openapi.json variants.

Start job no longer documents a JSON body (domain, version, paths). Job status is the single place to get bundleUrl, sizeBytes, and expiresAt when status is completed; progress and pageCount are removed from the schema. OpenAPI adds 409 (one active job per deployment) and 429 (10 starts per org per hour).

Overview pages and the GitHub Actions example use PROJECT_ID, project-scoped URLs, and polling that captures bundleUrl from the status response instead of a separate bundle POST.

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

@mintlify

mintlify Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Aug 18, 2026, 11:26 PM

@mintlify

mintlify Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Aug 18, 2026, 11:26 PM

💡 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