Uh oh!
There was an error while loading. Please reload this page.
docs: document route ownership conventions for FastAPI AI extensions (fixes #120) - #171
Conversation
Warning Review limit reached
Next review available in:46 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe PR adds FastAPI AI route ownership guidance, updates extension conflict documentation, and links the new guide from the README and AI/ML authoring documentation. ChangesFastAPI AI route ownership
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/recipes/FASTAPI_AI_ROUTE_OWNERSHIP.md`:
- Around line 9-16: Update the route-order statement in the documented routing
guidance to clarify that shadowing occurs only when an earlier route has both
the same path and the same HTTP method; routes sharing a path but serving
different methods may still be matched separately.
- Line 36: Update the route-order warning in the ownership guidance to apply
only when another router claims the same path and HTTP method; clarify that
differing methods may still be handled by a later route. Preserve the existing
guidance about avoiding occupied `/rag` paths and the `/chat` ownership
boundary.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 2e09ccc4-4351-40c4-a8c4-69a36c5ad6c3
📒 Files selected for processing (3)
README.mddocs/AI_ML_AUTHORING.mddocs/recipes/FASTAPI_AI_ROUTE_OWNERSHIP.md
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Records which extension owns which route prefix, how routers are mounted, the provider hook used for middleware, and the env namespaces in use. /rag is left unclaimed: fastapi-rag-pgvector ships a service layer with no router, so it composes with fastapi-ai-chat instead of competing for it. Also corrects the incompatibleWith row in AI_ML_AUTHORING.md, which still said fastapi-ai-chat did not exist yet. ClosesCreate-Python-App#120
5c7171c to
7ef156bCompareStarlette matches on path and method, so a later route on the same path can still serve a different method. Only a same-path, same-method route is shadowed by the earlier registration.
Uh oh!
There was an error while loading. Please reload this page.
Summary
Adds
docs/recipes/FASTAPI_AI_ROUTE_OWNERSHIP.mdfor #120, so contributors can see which route prefixes are taken before adding a FastAPI AI extension. Covers how routers reach the generated app, the prefixes in use, the provider hook for middleware, and the env namespaces./ragis documented as unclaimed on purpose:fastapi-rag-pgvectorships a service layer with no router, so it composes withfastapi-ai-chatinstead of competing for the prefix.Also corrects the
incompatibleWithrow inAI_ML_AUTHORING.md, which still saidfastapi-ai-chatdid not exist yet, and links both docs from the README table.Closes#120
Testing
Docs only, no generated-project behavior changes.
python scripts/ci/validate-registry.pypassespython scripts/ci/generate-matrix.py --layer validate-profilespassesChecklist