chore: remove documentation for removed backends#445
Conversation
Apparently the documentation maintenance was behind removal in the social-core, this fixes it.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 40802a8487
ℹ️ 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".
| SOCIAL_AUTH_PIXELPIN_OAUTH2_SECRET = '' | ||
|
|
||
| - Add ``'social_core.backends.pixelpin.PixelPinOAuth2'`` into your | ||
| - Add ``'social_core.backends.pixelpin.PixelPinOpenIDConnect'`` into your |
There was a problem hiding this comment.
When this guide switches to PixelPinOpenIDConnect, the backend name changes to pixelpin-openidconnect, so social-auth derives the callback path and credential settings from that name. The preceding instructions still tell users to register /complete/pixelpin-oauth2/ and set SOCIAL_AUTH_PIXELPIN_OAUTH2_KEY/SECRET, which this backend will not read; anyone following the updated guide will end up with missing credentials or a mismatched redirect URI.
Useful? React with 👍 / 👎.
| to use the OpenStreetMap OAuth2 backend with OpenHistoricalMap:: | ||
|
|
||
| SOCIAL_AUTH_OPENSTREETMAP_AUTHORIZATION_URL = 'https://www.openhistoricalmap.org/oauth/authorize' | ||
| SOCIAL_AUTH_OPENSTREETMAP_ACCESS_TOKEN_URL = 'https://www.openhistoricalmap.org/oauth/access_token' | ||
| SOCIAL_AUTH_OPENSTREETMAP_OAUTH2_AUTHORIZATION_URL = 'https://www.openhistoricalmap.org/oauth2/authorize' | ||
| SOCIAL_AUTH_OPENSTREETMAP_OAUTH2_ACCESS_TOKEN_URL = 'https://www.openhistoricalmap.org/oauth2/token' |
There was a problem hiding this comment.
For OpenStreetMap custom deployments like OpenHistoricalMap, overriding only these authorization and token URLs is not enough: OpenStreetMapOAuth2.user_data() still fetches profile data from the hard-coded https://api.openstreetmap.org/api/0.6/user/details.json. A user following this example would obtain an OpenHistoricalMap token and then send it to the OpenStreetMap API during login, so the documented setup fails unless the user-data/API URL is also made configurable or the example is removed.
Useful? React with 👍 / 👎.
|
|
||
| To get an OAuth2 refresh token along with the access token, you must pass an extra argument: ``access_type=offline``. | ||
| To do this with Google+ sign-in:: | ||
| To do this with Google OAuth2:: |
There was a problem hiding this comment.
This replacement is part of removing the Google+ Sign-In section as if that backend disappeared, but social_core.backends.google.GooglePlusAuth is still shipped with provider name google-plus. Users of that backend now lose the only docs for SOCIAL_AUTH_GOOGLE_PLUS_* settings and the /complete/google-plus client-side flow while the code remains available; restore or explicitly deprecate the section instead of dropping it as removed.
Useful? React with 👍 / 👎.
1 participant
Apparently the documentation maintenance was behind removal in the social-core, this fixes it.