OpenAPI support for flex fields

I am using drf-spectacular for schema generation; using the @extend_schema decorator to add docs to my views.

Say I have a serializer named PersonSerializer that inherits from FlexFieldsModelSerializer. If I pass it the fields argument, I expect it to show only those fields in the schema. Example code:

@extend_schema(
    responses={201: PersonSerializer(fields=["id", "username"])},
)
@api_view(["POST"])
def my_view(request):

But the schema picks up all the default fields from the PersonSerializer class.

I do not know if this is something that needs to be solved in this project or drf-spectacular but any help is greatly appreciated.

[soroush-tabesh]

@mzanki So glad I could help!

Sure, but I was hoping for feedback from the owner before opening a PR on the repo. I guess I should open one.

[soroush-tabesh]

@rsinger86 I’m wondering why didn’t you use get_fields instead of to_representation in FlexFieldsSerializerMixin? by taking advantage of overriding fields, drf-spectacular could also generate a proper schema. Actually, I forked your code and changed it so and is working pretty fine in my project.