Fastapi: [QUESTION] How to provide custom example value for single return

[retnikt]

First check

• [x] I used the GitHub search to find a similar issue and didn't find it.
• [x] I searched the FastAPI documentation, with the integrated search.
• [x] I already searched in Google "How to X in FastAPI" and didn't find any information.

Description

How can I provide a custom example value for the return value of routes? When the return is a Pydantic model, you can set the example keyword argument on a pydantic Field or add it to schema_extra in the Model config. However, when the return value is a simple type such as str or List[Optional[int]]` there seems to be no way to provide an example. Am I missing something, or is this a missing feature?

[phy25]

https://github.com/tiangolo/fastapi/issues/1007#issuecomment-589029073

[retnikt]

@phy25 I am asking about responses not request parameters.

[chris-allnutt]

you can manually extend/alter the returned schema, but I'd think there would be a way to do this
https://fastapi.tiangolo.com/advanced/extending-openapi/

[Slyfoxy]

Hi, @retnikt !

You can add examples for in field responses. See this page

[retnikt]

Thanks @Slyfoxy

[tiangolo]

Thanks for the help here everyone! :clap: :bow:

Thanks for reporting back and closing the issue @retnikt :+1: