✨ Add support for not needing ... as default value in required Query(), Path(), Header(), etc. (#4906)

* ✨ Do not require default value in Query(), Path(), Header(), etc

* 📝 Update source examples for docs with default and required values

* ✅ Update tests with new default values and not required Ellipsis

* 📝 Update docs for Query params and update info about default value, required, Ellipsis

docs_src/path_params_numeric_validations/tutorial001.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Union
 
 from fastapi import FastAPI, Path, Query
 
@@ -7,8 +7,8 @@ app = FastAPI()
 
 @app.get("/items/{item_id}")
 async def read_items(
-    item_id: int = Path(..., title="The ID of the item to get"),
-    q: Optional[str] = Query(None, alias="item-query"),
+    item_id: int = Path(title="The ID of the item to get"),
+    q: Union[str, None] = Query(default=None, alias="item-query"),
 ):
     results = {"item_id": item_id}
     if q:

docs_src/path_params_numeric_validations/tutorial001_py310.py

@@ -5,8 +5,8 @@ app = FastAPI()
 
 @app.get("/items/{item_id}")
 async def read_items(
-    item_id: int = Path(..., title="The ID of the item to get"),
-    q: str | None = Query(None, alias="item-query"),
+    item_id: int = Path(title="The ID of the item to get"),
+    q: str | None = Query(default=None, alias="item-query"),
 ):
     results = {"item_id": item_id}
     if q:

docs_src/path_params_numeric_validations/tutorial002.py

@@ -4,9 +4,7 @@ app = FastAPI()
 
 
 @app.get("/items/{item_id}")
-async def read_items(
-    q: str, item_id: int = Path(..., title="The ID of the item to get")
-):
+async def read_items(q: str, item_id: int = Path(title="The ID of the item to get")):
     results = {"item_id": item_id}
     if q:
         results.update({"q": q})

docs_src/path_params_numeric_validations/tutorial003.py

@@ -4,9 +4,7 @@ app = FastAPI()
 
 
 @app.get("/items/{item_id}")
-async def read_items(
-    *, item_id: int = Path(..., title="The ID of the item to get"), q: str
-):
+async def read_items(*, item_id: int = Path(title="The ID of the item to get"), q: str):
     results = {"item_id": item_id}
     if q:
         results.update({"q": q})

docs_src/path_params_numeric_validations/tutorial004.py

@@ -5,7 +5,7 @@ app = FastAPI()
 
 @app.get("/items/{item_id}")
 async def read_items(
-    *, item_id: int = Path(..., title="The ID of the item to get", ge=1), q: str
+    *, item_id: int = Path(title="The ID of the item to get", ge=1), q: str
 ):
     results = {"item_id": item_id}
     if q:

docs_src/path_params_numeric_validations/tutorial005.py

@@ -6,7 +6,7 @@ app = FastAPI()
 @app.get("/items/{item_id}")
 async def read_items(
     *,
-    item_id: int = Path(..., title="The ID of the item to get", gt=0, le=1000),
+    item_id: int = Path(title="The ID of the item to get", gt=0, le=1000),
     q: str,
 ):
     results = {"item_id": item_id}

docs_src/path_params_numeric_validations/tutorial006.py

@@ -6,9 +6,9 @@ app = FastAPI()
 @app.get("/items/{item_id}")
 async def read_items(
     *,
-    item_id: int = Path(..., title="The ID of the item to get", ge=0, le=1000),
+    item_id: int = Path(title="The ID of the item to get", ge=0, le=1000),
     q: str,
-    size: float = Query(..., gt=0, lt=10.5)
+    size: float = Query(gt=0, lt=10.5)
 ):
     results = {"item_id": item_id}
     if q: