cookie_examples() — fastapi Function Reference

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

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ cookie_examples() — fastapi Function Reference

Dependency Diagram

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

Relationship Graph

Source Code

tests/test_openapi_examples.py lines 105–121

def cookie_examples(
    data: Union[str, None] = Cookie(
        default=None,
        examples=["json_schema_cookie1", "json_schema_cookie2"],
        openapi_examples={
            "Cookie One": {
                "summary": "Cookie One Summary",
                "description": "Cookie One Description",
                "value": "cookie1",
            },
            "Cookie Two": {
                "value": "cookie2",
            },
        },
    ),
):
    return data