You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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.
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! 🔐
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.
Comment @coderabbitai help to get the list of available commands and usage tips.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Verification
/v1/user/oauth/callbackexamples.git diff --check.