🧭 Atlas: Document API routes with OpenAPI schema generation - #927
🧭 Atlas: Document API routes with OpenAPI schema generation#927ToolchainLab wants to merge 1 commit into
Conversation
Replaces hand-written, drift-prone API route documentation in README.md with an automated drift-prevention script that parses the FastAPI OpenAPI schema. The script verifies exact match or updates the list automatically between HTML markers to prevent regression. Co-authored-by: ToolchainLab <263750431+ToolchainLab@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
💡 What: Replaced the hand-written "Built-in routes" section in
README.mdwith an automatically generated list of routes derived directly from the app's OpenAPI schema.🎯 Why: Hand-written route lists drift silently as the API evolves. This change ensures 100% parity between the running code and the documentation.
🧪 Verification: Run
uv run scripts/check_doc_routes.pyto verify parity, oruv run scripts/check_doc_routes.py --updateto regenerate the docs.🔒 Drift Prevention: The
check_doc_routes.pyscript now dynamically computes the list from the actualapp.openapi().get("paths")mapping and mandates an exact match with the<!-- BEGIN ROUTES -->block.🗺️ Evidence: Used
h4ckath0n.app.create_appandapp.openapi()as the definitive source of truth for the codebase's behavior.PR created automatically by Jules for task 13810648023311945202 started by @ToolchainLab