Skip to content

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

Merged
ehcaw merged 3 commits into
mainfrom
mintlify/accd9370
Aug 24, 2026
Merged

Update from code changes: static export API projectId scope#7016
ehcaw merged 3 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-only changes; risk is limited to readers following outdated integration steps until they adopt the new URLs and two-step flow.

Overview
Updates the static export API reference (English, Spanish, French, Chinese) to match the shipped external API.

Route and flow changes: Job start and status are now under POST/GET /static-export/{projectId}/jobs…. Starting a job no longer accepts a JSON body (domain, version, paths); callers use projectId from the API keys page instead. The separate Generate export bundle endpoint and docs page are removed; when status is completed, Get job status returns bundleUrl, sizeBytes, and expiresAt (replacing live progress / pageCount).

Docs and examples: Overview, nav (docs.json and locale configs), OpenAPI specs, and the sample GitHub Action / Helm workflow now describe a two-step flow and document 409 (one active job), 429 (10 starts/org/hour), and deployment-scoped 403.

Reviewed by Cursor Bugbot for commit 4f741dd. 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.

@ehcaw
ehcaw merged commit 04ed35e into main Aug 24, 2026
5 checks passed
@ehcaw
ehcaw deleted the mintlify/accd9370 branch August 24, 2026 17:28
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.

3 participants