Adding Example for FastApi OpenAPI documentation

[julien-roy-replicant]

Problem

Currently for my pydantic models, I use the example field to document FastAPI:

= Field(..., example="This is my example for SwaggerUI")

Suggested solution

Would it be possible through comment in the schema.prisma to add these examples?

Alternatives

Open to any solution.

Additional context

I want to completely remove my custom pydantic object definitions and rely on your generated models and partials (which I find amazing!)

[RobertCraigie]

Yeah this would be doable using triple-slash comments on your schema, e.g.

model User {
  /// @example("my example value")
  name String
}

Does that sound good to you?

[julien-roy-replicant]

Yes perfect!

Could that be generic enough to also include other pydantic arguments like min_length, regex, etc ?

[RobertCraigie]

Not with the proposed syntax but maybe it should be something like this instead?

model User {
  /// @pydantic.example("my example value") @pydantic.min_length(4)
  name String
}

Where the $ in the @pydantic.$() format is not validated and just passed straight through to pydantic.

[julien-roy-replicant]

Yes, I really like this proposition :)