docs: document forward_resource parameter on OAuthProxy#3788
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f1109a2a96
ℹ️ 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".
| upstream OAuth provider. When enabled, the proxy includes the resource indicator | ||
| in authorization and token requests, allowing providers that support RFC 8707 to |
There was a problem hiding this comment.
Remove claim that resource is sent on token requests
The new parameter description says forward_resource includes the RFC 8707 resource indicator in both authorization and token requests, but the implementation only adds resource when building the upstream authorize URL (_build_upstream_authorize_url in consent.py). The upstream token exchange path builds token_params without resource (_handle_upstream_callback in proxy.py), so this documentation overstates behavior and can mislead users integrating providers that expect resource during token exchange.
Useful? React with 👍 / 👎.
The
forward_resourceflag was added in #3711 but not documented. Added a ParamField entry alongsideforward_pkceand updated the RFC 8707 prose section to reference the parameter.