Unable to declare ImageField as required

[johnthagen]

Cross posted from Hipo/drf-extra-fields#66

My model:

class Image(models.Model):
      image=models.ImageField(upload_to='photos')
      name=models.CharField(max_length=40, unique=False)

My serializer:

class imagesSerializer(serializers.ModelSerializer):
      image = Base64ImageField(required=True)
      class Meta:
         model = Image
         fields = ('id','name','image')

My swagger view:

How can I make the ImageField as required in swagger POST request?

In the other thread we seem to have narrowed the problem down to drf-yasg, testing with drf-yasg==1.13.0.

[axnsan12]

A request body can only contain files when it has the multipart content type. You need to set the view parser_classes to (MultipartParser,) (no json).

[johnthagen]

@axnsan12 Base64ImageField returns the contents of the field as base64 encoded ascii inline. It's used to make the API json-only so that multipart doesn't need to handled. This simplifies (in one degree) the overall API.

It sounds like drf-yasg assumes that all files must be sent multipart instead of inline?

This SO post explains the problem and Base64ImageField is one possible solution: https://stackoverflow.com/a/4083908/1398841

[axnsan12]

It sounds like drf-yasg assumes that all files must be sent multipart instead of inline?

That is indeed the case. The field you linked breaks the contract of FileField by making it accept a string instead of an UploadedFile.

You can work around this with a custom FieldInspector that returns an appropriate Schema object of type string, which should be placed before the FileFieldInspector.

[johnthagen]

@axnsan12 I'd like to try to fix this for drf-extra-fields. I'm not very familiar with custom FieldInspector's. At a high level, what would need to be placed where? Would this be added to Base64ImageField? Are there any links to docs or guides that will help me learn what all the steps I need to take are and how to test?

Thanks!

[johnthagen]

PR with doc fix for this issue: #445