ref: #9278

History

Since FastAPI 0.95 we cannot have multiple endpoint routes with optional Path parameter (because we cannot mix the Query/Path for a variable: 375513f#r105161665), while it seems this breaking change is assumed, I personally still need this feature.

To solve this, I have to remove the usage of Query/Path class and use simple Annotated form, but this means that I loose the nice OpenAPI kwargs provided by FieldInfo.

Proposed change

With this PR I'm proposing that we use the first metadata annotation as Field's description

from typing import Annotated
from fastapi import FastAPI

app = FastAPI()

@app.get("/test")
async def variable(foo: Annotated[str,  "get a description"] = "bar"):
   return {"foo": foo}

in ☝️ "get a description" will be forwarded to the OpenAPI schema as field's description 👇

I originally designed a more complex solution over #9289, but I think what I'm proposing with this PR is much more simple (thus acceptable ? 😅).