[FEATURE] Let us boost our OpenAPI capabilities!!

Is your feature request related to a problem? Please describe. I want to control the “Example value” of my “Request body”. RIght now, we only get something like this:

{
  "string_field": "string"
}

I should be able to control this behaviour, like

{
  "string_field": "Default value for string_field"
}

Describe alternatives you’ve considered I thought that declaring default values might change the values in the swagger, but even that does not work. It would even be a bad behaviour, as we would tightly couple Swagger documentation with API behaviour.

Additional context Add any other context or screenshots about the feature request here.

[gautamsinghania95]

Hi,

The documentation does not contain the “example” field. Can you get this info added, as it helps a lot with OpenAPI configuration.

Thanks for the help!! Closing this ticket 😄

Best, Gautam

[prostomarkeloff]

Hello! At the moment you already can set the example value of field. For example:

async def create_user(
    uid: int = Query(..., description="Id of user for add to database", example=123),
    is_superuser: bool = Query(..., description="User status", example=True),
):
    new_user: User = await UserQuery.create_user(uid, is_superuser)
    return UserSchema.from_orm(new_user)

More about it: https://fastapi.tiangolo.com/tutorial/query-params-str-validations/