Skip to content

🧭 Atlas: Document API routes with OpenAPI schema generation - #927

Draft
ToolchainLab wants to merge 1 commit into
mainfrom
atlas/doc-api-routes-13810648023311945202
Draft

🧭 Atlas: Document API routes with OpenAPI schema generation#927
ToolchainLab wants to merge 1 commit into
mainfrom
atlas/doc-api-routes-13810648023311945202

Conversation

@ToolchainLab

Copy link
Copy Markdown
Collaborator

💡 What: Replaced the hand-written "Built-in routes" section in README.md with 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.py to verify parity, or uv run scripts/check_doc_routes.py --update to regenerate the docs.
🔒 Drift Prevention: The check_doc_routes.py script now dynamically computes the list from the actual app.openapi().get("paths") mapping and mandates an exact match with the <!-- BEGIN ROUTES --> block.
🗺️ Evidence: Used h4ckath0n.app.create_app and app.openapi() as the definitive source of truth for the codebase's behavior.


PR created automatically by Jules for task 13810648023311945202 started by @ToolchainLab

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>
@google-labs-jules

Copy link
Copy Markdown
Contributor

👋 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 @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

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.

1 participant