query_examples() — fastapi Function Reference

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

Function python FastAPI Responses

Entity Profile

FastAPI→ Responses→ query_examples() — fastapi Function Reference

Dependency Diagram

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

Relationship Graph

Source Code

tests/test_openapi_examples.py lines 59–78

def query_examples(
    data: Union[str, None] = Query(
        default=None,
        examples=[
            "json_schema_query1",
            "json_schema_query2",
        ],
        openapi_examples={
            "Query One": {
                "summary": "Query One Summary",
                "description": "Query One Description",
                "value": "query1",
            },
            "Query Two": {
                "value": "query2",
            },
        },
    ),
):
    return data