Fix docs Swagger UI rendering for REST API pages#3729
Merged
peterschmidt85 merged 1 commit intomasterfrom Apr 2, 2026
Merged
Conversation
Replace mkdocs_gen_files.open() with direct file writes so that render_swagger can find the JSON files on the real filesystem. Also fix the rest plugin output path (rest_plugin/ -> rest/) and remove the committed openapi.json in favor of always generating it. Skip writing when content is unchanged to avoid livereload loops. Fixes #3724 Fixes #3725 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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
render_swaggerplugin not finding OpenAPI JSON files generated bymkdocs_gen_files(which writes to a temp dir, not the real filesystem)mkdocs_gen_files.open()with direct file writes sorender_swaggercan resolve the filesrest_plugin/→rest/) to match the page directoryopenapi.jsonin favor of always generating at build timeFixes #3724
Fixes #3725
Test plan
mkdocs build -spasses with noSWAGGER ERRORin output sitemkdocs serverenders both Swagger pages without errors🤖 Generated with Claude Code