Operation Class — fastapi Architecture

Architecture documentation for the Operation class in models.py from the fastapi codebase.

Class python FastAPI

Entity Profile

FastAPI→ Operation Class — fastapi Architecture

Dependency Diagram

graph TD
  a6798a14_1602_9f92_d607_42e12474b6b4["Operation"]
  6f158f64_db73_3529_caa7_fbf9276f5bed["BaseModelWithConfig"]
  a6798a14_1602_9f92_d607_42e12474b6b4 -->|extends| 6f158f64_db73_3529_caa7_fbf9276f5bed
  7f688779_6b22_3c15_6514_97dec91c3c30["models.py"]
  a6798a14_1602_9f92_d607_42e12474b6b4 -->|defined in| 7f688779_6b22_3c15_6514_97dec91c3c30

Relationship Graph

Source Code

fastapi/openapi/models.py lines 289–302

class Operation(BaseModelWithConfig):
    tags: Optional[list[str]] = None
    summary: Optional[str] = None
    description: Optional[str] = None
    externalDocs: Optional[ExternalDocumentation] = None
    operationId: Optional[str] = None
    parameters: Optional[list[Union[Parameter, Reference]]] = None
    requestBody: Optional[Union[RequestBody, Reference]] = None
    # Using Any for Specification Extensions
    responses: Optional[dict[str, Union[Response, Any]]] = None
    callbacks: Optional[dict[str, Union[dict[str, "PathItem"], Reference]]] = None
    deprecated: Optional[bool] = None
    security: Optional[list[dict[str, list[str]]]] = None
    servers: Optional[list[Server]] = None