[BUG] Optional query enums do not have dropdowns/options in swagger/openAPI UI about django-ninja HOT 3 OPEN

While I'm not sure this is a bug in django-ninja per se (since the generated schema seems correct and that's what matters in the first place), I have found an ugly workaround to bring the dropdowns back thanks to Pydantic's json_schema_extra. Leaving it here for anyone facing the same issue:

class MySchema(Schema):
    my_enum: MyEnum
    # my_opt_enum: MyEnum | None = None
    my_opt_enum: MyEnum | None = Field(None, json_schema_extra={"enum": [e.value for e in MyEnum]}) 
                                                                  👆

This forcefully adds the "enum" spec right into the OpenAPI schema for my_opt_enum:

{"in": "query", "name": "my_opt_enum", "schema": {"anyOf": [{"$ref": "#/components/schemas/MyEnum"}, {"type": "null"}], "enum": ["foo", "bar", "baz"]}, "required": false}

And brings back the dropdown:

This workaround scales poorly and is ugly, so I would be glad to learn other solutions to this problem.

from django-ninja.

Is there a way to extend and overwrite schema generator classes to add extra json schema data?

from django-ninja.

When generating api clients, a $ref is preferable in every single case, because the extracted types will rely on the schema components, and the enum should be referred to as the same type whether it is in the querystring, or somewhere else, otherwise the type extractions will create a new type just for this querystring param...

The swagger UI should not be the reference point for this...

The bug here is that sometimes, the schema does not use a $ref for enums, not the other way around...

This is correctly done in FastAPI.

from django-ninja.