Skip to content

Documentation is out of sync #235

Open
@rrrealman

Description

@rrrealman

Hi guys! First of all, thank you a lot for your work, it saved me a big deal of time!

I was developing an app and adhered the docs pedantically. I've found several inconsistencies in the docs, please, feel free to
correct my opinion if I'm not right.

First, you placed this section named "Testing the Setup" in your docs and it distinguishes this library from other OAuth libraries. But, as I understand, you have out of date options in curl requests. I got {"detail":"Unsupported media type \"application/x-www-form-urlencoded\" in request."}, so I decided to use valid json with Content-Type:application/json header. I think, every test request here https://github.com/RealmTeam/django-rest-framework-social-oauth2#testing-the-setup should be reformatted with such approach.

Second, and this is very hard. I think, we need to drop <backend_name> from Authenticating Requests https://github.com/RealmTeam/django-rest-framework-social-oauth2#authenticating-requests. As I see, a flow works without it and fails with it in header.

Versions of apps used:
django-oauth-toolkit==1.3.2
django-rest-framework-social-oauth2==1.1.0
djangorestframework==3.11.0
Django==3.0.8

curl --version output:
curl 7.58.0 (x86_64-pc-linux-gnu) libcurl/7.58.0 OpenSSL/1.1.1 zlib/1.2.11 libidn2/2.0.4 libpsl/0.19.1 (+libidn2/2.0.4) nghttp2/1.30.0 librtmp/2.3 Release-Date: 2018-01-24 Protocols: dict file ftp ftps gopher http https imap imaps ldap ldaps pop3 pop3s rtmp rtsp smb smbs smtp smtps telnet tftp Features: AsynchDNS IDN IPv6 Largefile GSS-API Kerberos SPNEGO NTLM NTLM_WB SSL libz TLS-SRP HTTP2 UnixSockets HTTPS-proxy PSL

Kind regards,
Sviatoslav

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions