Shipped Channel Updates: document static export basePath option - #7137
Closed
mintlify[bot] wants to merge 1 commit into
Closed
Shipped Channel Updates: document static export basePath option#7137mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
1 participant
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
Documents the optional
basePathrequest body parameter for the static export start-job endpoint, shipped inmintlify/server#7702.Changes
basePathrequest body (enum:"",/docs,/documentation) and a400response to the static export OpenAPI specbasePathoption in the static export overview pageContext
Triggered by the #shipped announcement of the static export API. The docs were already live but predated the
basePathparameter added the day before.Note
Low Risk
Documentation and OpenAPI reference updates only; no application logic or deployment behavior changes in this repo.
Overview
Documents the optional
basePathbody field on Start static export job, matching the behavior shipped in the API.The static export OpenAPI specs (English plus es, fr, zh) now describe an optional JSON body with
basePathconstrained to"",/docs, or/documentation, a400when the value is invalid, and that omitting it keeps the deployment’s configured base path. The static export overview pages in the same locales add a short note in the “start job” step explaining the same options and default.No runtime or server code changes—docs and API reference only.
Reviewed by Cursor Bugbot for commit af7b0fc. Bugbot is set up for automated code reviews on this repo. Configure here.