ReDoc ImageField not displayed

[BojanKogoj]

I have the following serializer, which will show avatar field in Swagger, but not ReDoc

class AvatarUpdateSerializer(serializers.ModelSerializer):
    avatar = serializers.ImageField()

    class Meta:
        model = User
        fields = ('avatar',)

Screenshots

• Swagger
  
• Redoc
  

Is this an issue with this library or ReDoc?

[axnsan12]

Without the generated swagger YAML or JSON, I couldn't tell. However given that swagger-ui works I would suppose it's a bug in ReDoc.

[BojanKogoj]

In definitions I could find

  AvatarUpdate:
    type: object
    properties:
      avatar:
        title: Avatar
        type: string
        readOnly: true
        format: uri

That means it's ReDoc issue I suppose.

[axnsan12]

Actually, no. It seems to be a problem with the swagger generation (this library) - the field is marked as readOnly, ReDoc is correct in not showing it in the request body parameter.

To get drf-yasg to properly generate request parameters of type file, you must set your parser class on the view to MultiPartParser: https://github.com/axnsan12/drf-yasg/blob/master/testproj/articles/views.py#L103

[BojanKogoj]

I tried that, with no success. Could it be because of generics? I could be using this completely wrong

class UpdateAvatarView(generics.UpdateAPIView):
    """ Upload users avatar  """
    serializer_class = AvatarUpdateSerializer
    http_method_names = ['patch']
    permission_classes = (
        permissions.IsAuthenticated,
        client_permissions.IsClient)

    def get_object(self, *args, **kwargs):
        return self.request.user

    @swagger_auto_schema(responses={200: UserSerializer()})
    @detail_route(methods=['patch'], parser_classes=(MultiPartParser,))
    def patch(self, request, *args, **kwargs):
        return self.update(request, *args, **kwargs)

[axnsan12]

Yes, you are 😄 . @detail_route only applies to ViewSets, and specifically ViewSets when used with routers.

You should just set parser_classes on the view class itself (like the other _classes you have set).

[BojanKogoj]

This worked:

@parser_classes((MultiPartParser,))
class UpdateAvatarView(generics.UpdateAPIView):

I don't actually use any _classes decorators otherwise, the only view decorator I have in this project is @swagger_auto_schema.

Thanks for your help

[axnsan12]

Decorating the class is not necessary

class UpdateAvatarView(generics.UpdateAPIView):
    serializer_class = AvatarUpdateSerializer
    http_method_names = ['patch']
    permission_classes = (
        permissions.IsAuthenticated,
        client_permissions.IsClient)
    parser_classes = (MultiPartParser,)    # <--------- add this

[BojanKogoj]

Yeah, that's an even better solution. Thanks