Skip to content

Fix LoginView and RegisterView response schema generation #283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
philipkimmey wants to merge 3 commits into from
Closed

Fix LoginView and RegisterView response schema generation #283

philipkimmey wants to merge 3 commits into from

Conversation

@philipkimmey
Copy link

@philipkimmey philipkimmey commented Jul 18, 2021 •
edited
Loading

Hello! Due to use of serializers.SerializerMethodField() the generated OpenAPI schema wasn't previously accurate.

The schema will vary based on some project settings values, but with the default values the /login/ endpoint previously looked like:

  /login/:
    post:
      operationId: createLogin
      description: 'Check the credentials and return the REST Token

        if the credentials are valid and authenticated.

        Calls Django Auth login method to register User ID

        in Django session framework


        Accept the following POST parameters: username, password

        Return the REST Framework Token Object''s key.'
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Login'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Login'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Login'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Login'
          description: ''
      tags:
      - login

(Which of course isn't the correct response payload)

And now looks like:

  /login/:
    post:
      operationId: createLogin
      description: 'Check the credentials and return the REST Token

        if the credentials are valid and authenticated.

        Calls Django Auth login method to register User ID

        in Django session framework


        Accept the following POST parameters: username, password

        Return the REST Framework Token Object''s key.'
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Login'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Login'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Login'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Token'
          description: ''
      tags:
      - login

@philipkimmey philipkimmey changed the title Fix LoginView response schema generation Fix LoginView and RegisterView response schema generation Jul 18, 2021
philipkimmey
philipkimmey commented Jul 18, 2021
View reviewed changes
dj_rest_auth/serializers.py
super().__init__(*args, **kwargs)


class DynamicFieldSerializerMetaclass(serializers.SerializerMetaclass):
Copy link
Author

@philipkimmey philipkimmey Jul 18, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: Add tests

philipkimmey
philipkimmey commented Jul 18, 2021
View reviewed changes
dj_rest_auth/serializers.py


class JWTSerializer(serializers.Serializer):
class DynamicSerializerField(Field):
Copy link
Author

@philipkimmey philipkimmey Jul 18, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: Add tests

philipkimmey
philipkimmey commented Jul 18, 2021
View reviewed changes
dj_rest_auth/serializers.py

user_data = JWTUserDetailsSerializer(obj['user'], context=self.context).data
return user_data
user = DynamicSerializerField(
Copy link
Author

@philipkimmey philipkimmey Jul 18, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: Add tests

@iMerica iMerica closed this Sep 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@philipkimmey @iMerica