Is it possible to use fields docstrings as descriptions?

[guillaume-alvarez]

Hi!

I'm trying to use flask-openapi3 to generate the OpenAPI description for my API and its objects.

It looks like the fields docstring isn't used to generate the field description in OpenAPI, is that right?

For instance with

class AlertSearchRequest(BaseModel):
    """Request to find alerts."""

    start_date: datetime
    """Minimal date."""

    end_date: datetime
    """Maximal date."""

I get the AlertSearchRequest description from its docstring (as expected) but the fields descriptions are empty, their docstrings are ignored.

Is it intended? a known issue or limitation? Am I missing some setting to correct this?

[guillaume-alvarez]

I found the solution: pydantic/pydantic#10106

This was implemented in Pydantic 2.7 with the [use_attribute_docstrings] (https://docs.pydantic.dev/latest/api/config/#pydantic.config.ConfigDict.use_attribute_docstrings) configuration value.

This wasn't made opt-in for various reasons:

• Backwards compatibility
• Potential bad performance (we inspect the AST to extract those docstrings)
• Potential limitations in very specific scenarios.