docs: clarify provider-specific routing for aliased models#2371
docs: clarify provider-specific routing for aliased models#2371luispater merged 3 commits intorouter-for-me:devfrom
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the documentation in README.md, README_CN.md, README_JA.md, and config.example.yaml to advise users on using provider-specific API paths for deterministic routing. These additions clarify that provider-specific endpoints should be preferred over merged OpenAI-compatible endpoints when model aliases or fallback mappings create ambiguity in backend selection. I have no feedback to provide as there were no review comments.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d54de441d3
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
Updated the docs section in commit 224f0de. The provider-specific routing examples now use neutral |
luispater
left a comment
There was a problem hiding this comment.
Summary
This PR updates documentation only (README EN/CN/JA and config.example.yaml) to clarify how /api/provider/{provider}/... routes should be interpreted versus merged /v1/... routes.
Key findings
- No blocking issues found.
- The final wording is consistent with current implementation behavior: provider-specific paths select protocol surface, while inference backend resolution still follows model/alias resolution.
- The warning added near
oauth-model-aliasinconfig.example.yamlmatches the runtime routing behavior and helps prevent operator misunderstanding.
Test plan
- Not applicable (docs-only PR).
This is an automated Codex review result and still requires manual verification by a human reviewer.
Summary
/api/provider/{provider}/...over the merged/v1/...endpointsconfig.example.yamlnearoauth-model-aliasWhy
In a real multi-provider setup, the merged
/v1/modelsinventory can reflect alias-renamed or pooled model names rather than the backend a client is trying to force. The provider-specific request paths are the reliable way to select an executor family when routing needs to stay deterministic.Concrete examples from a live setup:
POST /api/provider/anthropic/v1/messagesreturned Anthropic headers for a Claude requestPOST /api/provider/google/v1beta/models/...:generateContentreturned Google/Gemini headers for a Gemini request/v1/modelsview remained alias-oriented, which is why the docs now call out the distinction