Skip to content

Fix OAuth redirect URI examples#15683

Open
zz80900 wants to merge 1 commit into
infiniflow:mainfrom
zz80900:fix-oauth-redirect-uri-docs
Open

Fix OAuth redirect URI examples#15683
zz80900 wants to merge 1 commit into
infiniflow:mainfrom
zz80900:fix-oauth-redirect-uri-docs

Conversation

@zz80900
Copy link
Copy Markdown

@zz80900 zz80900 commented Jun 5, 2026

What problem does this PR solve?

OAuth/OIDC/GitHub redirect URI examples currently point to /v1/user/oauth/callback/<channel>, but the current auth callback route is /api/v1/auth/oauth/<channel>/callback. The stale examples can cause 404 errors when configuring third-party login providers.

This updates the Docker and administrator configuration examples to match the implemented callback route.

Type of change

  • Bug Fix (non-breaking change which fixes an issue)
  • New Feature (non-breaking change which adds functionality)
  • Documentation Update
  • Refactoring
  • Performance Improvement
  • Other (please describe):

Verification

  • Searched for stale /v1/user/oauth/callback examples.
  • Ran git diff --check.

@dosubot dosubot Bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Jun 5, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 5, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This pull request updates OAuth callback redirect URI paths from the legacy /v1/user/oauth/callback/<channel> format to the new /api/v1/auth/oauth/<channel>/callback format across all authentication documentation, configuration examples, and administrator guides for consistency.

Changes

OAuth callback URL path migration

Layer / File(s) Summary
Authentication module and configuration examples
api/apps/auth/README.md, conf/service_conf.yaml, docker/README.md, docker/service_conf.yaml.template
OAuth redirect_uri paths updated to /api/v1/auth/oauth/<channel>/callback in the auth module documentation and all configuration templates. Docker setup documentation step reference adjusted for numbering consistency.
Administrator configuration reference
docs/administrator/configurations/configurations.md
OAuth field description and YAML best-practices examples updated to show the new redirect_uri paths for OAuth2, OIDC, and GitHub providers under the new /api/v1/auth/oauth/ route.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 The auth paths hop along so bright,
From /v1/user/oauth to /api/v1/auth/oauth—what delight!
Through docs and configs, we've aligned the way,
Consistent redirects that guide us to stay!
One channel, one path, one loop at a time,
OAuth flows freshly—now perfectly prime! 🔐

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating OAuth redirect URI examples to use the correct callback path.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The pull request description comprehensively addresses the problem, provides clear context, identifies the outdated URIs and the correct implementation, and documents verification steps performed.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant