Enhancement: Only generate example once when Parameter(examples=[...]) is specified for path arg and its schema
Description
Explained below.
MCVE
import json
from litestar import Litestar, post
from litestar.openapi.spec import Example
from litestar.params import Parameter
@post("/{path_arg:str}")
def endpoint(
path_arg: str = Parameter(examples=[Example(value="EXAMPLE_VALUE")]),
) -> None:
pass
app = Litestar(route_handlers=[endpoint])
print(json.dumps(app.openapi_schema.to_schema(), indent=4))The generated schema contains:
{
"name": "path_arg",
"in": "path",
"schema": {
"type": "string",
"examples": { <------- HERE
"path_arg-example-1": {
"value": "EXAMPLE_VALUE"
}
}
},
"required": true,
"deprecated": false,
"allowEmptyValue": false,
"allowReserved": false,
"examples": { <------- HERE
"path_arg-example-1": {
"value": "EXAMPLE_VALUE"
}
}
}I would expect one occurrence is sufficient. The example was given for/as OpenAPI path parameter (via Parameter) so the latter is correct, and the JSON schema example (former one) can be dropped.
Steps to reproduce
1. `python app.py`
2. See the generated schemaScreenshots
No response
Logs
No response
Litestar Version
2.5.1
Platform
- Linux
- Mac
- Windows
- Other (Please specify in the description above)
litestar-org / litestar
Production-ready, Light, Flexible and Extensible ASGI API framework | Effortlessly Build Performant APIs
5.5k
How does funding with Polar work?
1
Pay now to fund the work behind this issue.
2
Get updates on progress being made.
3
Maintainer is rewarded once the issue is completed.
FAQ
Backer
You're funding impactful open source efforts
Contributor
You want to contribute to this effort
Maintainer
You want to get funding like this too