path_examples() — fastapi Function Reference

Architecture documentation for the path_examples() function in test_openapi_examples.py from the fastapi codebase.

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ path_examples() — fastapi Function Reference

Dependency Diagram

graph TD
  f1daf886_7671_02e5_bf3c_abe49f2c828a["path_examples()"]
  8ac1d492_09f7_2975_cc25_f70aecbbb54b["test_openapi_examples.py"]
  f1daf886_7671_02e5_bf3c_abe49f2c828a -->|defined in| 8ac1d492_09f7_2975_cc25_f70aecbbb54b
  style f1daf886_7671_02e5_bf3c_abe49f2c828a fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

tests/test_openapi_examples.py lines 37–55

def path_examples(
    item_id: str = Path(
        examples=[
            "json_schema_item_1",
            "json_schema_item_2",
        ],
        openapi_examples={
            "Path One": {
                "summary": "Path One Summary",
                "description": "Path One Description",
                "value": "item_1",
            },
            "Path Two": {
                "value": "item_2",
            },
        },
    ),
):
    return item_id