docs: add OpenAPI-first wiki (overview, components, use cases for templates/client/codegen, design, security, error handling, testing) and refresh lib docs index

openapi_first/templates/model_app/routes.py

@@ -26,7 +26,7 @@ from data import (
 )
 
 
-def list_items():
+def list_items() -> list[Item]:
     """
     List all items.
 
@@ -41,7 +41,7 @@ def list_items():
     return _list_items()
 
 
-def get_item(item_id: int):
+def get_item(item_id: int) -> Item:
     """
     Retrieve a single item by ID.
 
@@ -69,7 +69,7 @@ def get_item(item_id: int):
         raise HTTPException(status_code=404, detail="Item not found")
 
 
-def create_item(payload: ItemCreate, response: Response):
+def create_item(payload: ItemCreate, response: Response) -> Item:
     """
     Create a new item.
 
@@ -80,7 +80,7 @@ def create_item(payload: ItemCreate, response: Response):
     ----------
     payload : ItemCreate
         Request body describing the item to create.
-    response : fastapi.Response
+    response : Response
         Response object used to set the HTTP status code.
 
     Returns
@@ -93,7 +93,7 @@ def create_item(payload: ItemCreate, response: Response):
     return item
 
 
-def update_item(item_id: int, payload: ItemCreate):
+def update_item(item_id: int, payload: ItemCreate) -> Item:
     """
     Update an existing item.
 
@@ -123,7 +123,7 @@ def update_item(item_id: int, payload: ItemCreate):
         raise HTTPException(status_code=404, detail="Item not found")
 
 
-def delete_item(item_id: int, response: Response):
+def delete_item(item_id: int, response: Response) -> None:
     """
     Delete an existing item.
 
@@ -134,7 +134,7 @@ def delete_item(item_id: int, response: Response):
     ----------
     item_id : int
         Identifier of the item to delete.
-    response : fastapi.Response
+    response : Response
         Response object used to set the HTTP status code.
 
     Returns