Unable to make the ImageField as required in Swagger POST API

[MounikaKommineni]

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 to make the imagefield as required in swagger post request ?

[johnthagen]

I noticed this too in generated Angular TypeScript. The image variables were always marked with ?, meaning they were optional.

[shafiyal]

I am also facing the same issue even though i specified required=True in serializer class

[baranugur]

I'm using the same serializer setup and mine seems to be working fine. Maybe this is an issue of differences in versions. Here are the versions of Django, Django Extra Fields, Django REST Framework and Django REST Swagger that I have used, so you can compare: Django==2.1.7, django-extra-fields==1.0.0, djangorestframework==3.9.2, django-rest-swagger==2.2.0.

[johnthagen]

I wonder if it's because of the readOnly property? Would a readOnly property make it optional because it's not required when writing to the API? Is this because of how the file is normally returned as a URL rather than the data directly? (I'm just spit balling at this point).

[baranugur]

ReadOnly fields cannot be required at the same time, therefore it's not possible to have a field where both required and read_only are set to True in the latest version of Django REST Framework.

[johnthagen]

What's weird is in my case, I never set read_only to True. The serializer is a WritableNestedSerializer, but I don't see how that would affect the field.

[baranugur]

I've used the serializer below:

class ImageSerializer(WritableNestedModelSerializer):
    image = Base64ImageField(required=True)

    class Meta:
        model = Image
        fields = ('id', 'name', 'image')

It still seems to be working fine.

[johnthagen]

@baranugur Could you also post your Image Model?

I wonder why your image field doesn't say string($uri). That is how mine always is (and the OP's).

Also, I'm using drf-yasg == 1.13.0 instead of django-rest-swagger due to django-rest-swagger having low maintenance as of late. Perhaps others in the thread could comment on which they are using.

[baranugur]

The model that I've created is identical to OP's.

I think drf-yasg==1.13.0 is causing the problem here. I've just tried it with Base64ImageField and then I've used the built-in serializers.ImageField; this is what I've gotten in both cases:

[johnthagen]

Cross posted to axnsan12/drf-yasg#332

[johnthagen]

Confirmed this is drf-yasg specific (intended) behavior:

axnsan12/drf-yasg#332 (comment)

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.

[yigitguler]

Marking as completed.