fix: preserve docs.json key order to prevent OpenAPI embed 404s#154
Merged
fix: preserve docs.json key order to prevent OpenAPI embed 404s#154
Conversation
pretty-format-json was sorting keys alphabetically, moving the `openapi` field to after `navigation` (o > n). Mintlify parses docs.json sequentially, so when it processes `GET /api/v1/...` navigation entries before encountering the `openapi` spec declaration, those embedded API pages return 404. Add --no-sort-keys to freeze the author-controlled ordering, ensuring `openapi` stays declared before `navigation`. Also add fail_fast: true so hooks stop on first failure rather than running all checks on already-broken files.
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
--no-sort-keystopretty-format-jsonhook soopenapikey stays declared beforenavigationin docs.jsonfail_fast: trueto stop on first hook failureopenapiafternavigation(o > n), causing Mintlify to 404 embedded API pages that it encounters before finding the OpenAPI spec declarationTest plan
GET /api/v1/apps) no longer 404 on the preview deploymentgit commitwith docs.json changes no longer reorders keys