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

This commit is contained in:
2026-09-15 22:29:05 +05:30
parent adeb02e162
commit b559323dfe
26 changed files with 1590 additions and 86 deletions

View File

@@ -33,7 +33,7 @@ _items: Dict[int, dict] = {
_next_id = 3
def list_items():
def list_items() -> list[dict]:
"""
Return all items in the data store.
@@ -48,7 +48,7 @@ def list_items():
return list(_items.values())
def get_item(item_id: int):
def get_item(item_id: int) -> dict:
"""
Retrieve a single item by ID.
@@ -68,7 +68,7 @@ def get_item(item_id: int):
return _items[item_id]
def create_item(payload: dict):
def create_item(payload: dict) -> dict:
"""
Create a new item in the data store.
@@ -92,7 +92,7 @@ def create_item(payload: dict):
return item
def update_item(item_id: int, payload: dict):
def update_item(item_id: int, payload: dict) -> dict:
"""
Replace an existing item in the data store.