Fix LoginView and RegisterView response schema generation #283

philipkimmey · 2021-07-18T04:23:10Z

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 · 2021-07-18T06:07:10Z

dj_rest_auth/serializers.py

+        super().__init__(*args, **kwargs)
+
+
+class DynamicFieldSerializerMetaclass(serializers.SerializerMetaclass):


TODO: Add tests

philipkimmey · 2021-07-18T06:07:27Z

dj_rest_auth/serializers.py

@@ -189,30 +191,46 @@ class Meta:
        read_only_fields = ('email',)


-class JWTSerializer(serializers.Serializer):
+class DynamicSerializerField(Field):


TODO: Add tests

philipkimmey · 2021-07-18T06:07:37Z

dj_rest_auth/serializers.py

-
-        user_data = JWTUserDetailsSerializer(obj['user'], context=self.context).data
-        return user_data
+    user = DynamicSerializerField(


TODO: Add tests

Fix LoginView response schema generation

65167e6

philipkimmey force-pushed the login-schema-fixes branch from c9fe22b to 900eb07 Compare July 18, 2021 06:05

philipkimmey changed the title ~~Fix LoginView response schema generation~~ Fix LoginView and RegisterView response schema generation Jul 18, 2021

philipkimmey commented Jul 18, 2021

View reviewed changes

Fix response schema generation for registration

7284db1

philipkimmey force-pushed the login-schema-fixes branch from 900eb07 to 7284db1 Compare July 18, 2021 06:09

WIP

71ce5b2

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix LoginView and RegisterView response schema generation #283

Fix LoginView and RegisterView response schema generation #283

philipkimmey commented Jul 18, 2021 •

edited

Loading

philipkimmey Jul 18, 2021

philipkimmey Jul 18, 2021

philipkimmey Jul 18, 2021

		super().__init__(args, *kwargs)


		class DynamicFieldSerializerMetaclass(serializers.SerializerMetaclass):

Fix LoginView and RegisterView response schema generation #283

Are you sure you want to change the base?

Fix LoginView and RegisterView response schema generation #283

Conversation

philipkimmey commented Jul 18, 2021 • edited Loading

philipkimmey Jul 18, 2021

Choose a reason for hiding this comment

philipkimmey Jul 18, 2021

Choose a reason for hiding this comment

philipkimmey Jul 18, 2021

Choose a reason for hiding this comment

philipkimmey commented Jul 18, 2021 •

edited

Loading