Improve settings documentation #1567
Merged
Conversation
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
Previously, it was unclear that the swappable model settings should always be set without a namespace, as the sub-section titles didn't include the required `OAUTH2_PROVIDER_` prefix. The warning at the top may not be noticed by people looking for a specific settings, and it was still unclear given the sub-section titles. Additionally, this documents the `OAUTH2_PROVIDER_ID_TOKEN_MODEL` and `OAUTH2_PROVIDER_GRANT_MODEL` settings, which were previously undocumented. Also, this corrects a mistake where `ACCESS_TOKEN_GENERATOR` was mentioned as the setting which enables the use of `SettingsScopes`; the actual setting is `SCOPES_BACKEND_CLASS`.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1567 +/- ##
==========================================
- Coverage 97.38% 97.19% -0.19%
==========================================
Files 34 34
Lines 2214 2214
==========================================
- Hits 2156 2152 -4
- Misses 58 62 +4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of the Change
Previously, it was unclear that the swappable model settings should always be set without a namespace, as the sub-section titles didn't include the required
OAUTH2_PROVIDER_prefix. The warning at the top may not be noticed by people looking for a specific settings, and it was still unclear given the sub-section titles.Additionally, this documents the
OAUTH2_PROVIDER_ID_TOKEN_MODELandOAUTH2_PROVIDER_GRANT_MODELsettings, which were previously undocumented.Also, this corrects a mistake where
ACCESS_TOKEN_GENERATORwas mentioned as the setting which enables the use ofSettingsScopes; the actual setting isSCOPES_BACKEND_CLASS.