Operation

This class represents a single API operation on a path, defining the metadata and execution details for a specific HTTP method. It provides fields for documenting parameters, request bodies, responses, and security requirements, while supporting extensions like callbacks and external documentation. This model ensures compliance with structured API specifications by organizing all components necessary to describe a functional endpoint.

Attributes

Attribute	Type	Description
tags	`list[str]	None` = null
summary	`str	None` = null
description	`str	None` = null
externalDocs	`ExternalDocumentation	None` = null
operationId	`str	None` = null
parameters	`list[Parameter	Reference]
requestBody	`RequestBody	Reference
responses	`dict[str, Response	Any]
callbacks	`dict[str, dict[str, "PathItem"]	Reference]
deprecated	`bool	None` = null
security	`list[dict[str, list[str]]]	None` = null
servers	`list[Server]	None` = null

---

Constructor

Signature

def Operation(
    tags: list[str]| None = None,
    summary: str | None = None,
    description: str | None = None,
    externalDocs: ExternalDocumentation | None = None,
    operationId: str | None = None,
    parameters: list[Parameter | Reference]| None = None,
    requestBody: RequestBody | Reference | None = None,
    responses: dict[str, Response | Any]| None = None,
    callbacks: dict[str, dict[str, [PathItem](pathitem.md?sid=fastapi_openapi_models_pathitem)]| Reference]| None = None,
    deprecated: bool | None = None,
    security: list[dict[str, list[str]]]| None = None,
    servers: list[[Server](server.md?sid=fastapi_openapi_models_server)]| None = None
) - > null

Parameters

Name	Type	Description
tags	`list[str]	None` = None
summary	`str	None` = None
description	`str	None` = None
externalDocs	`ExternalDocumentation	None` = None
operationId	`str	None` = None
parameters	`list[Parameter	Reference]
requestBody	`RequestBody	Reference
responses	`dict[str, Response	Any]
callbacks	`dict[str, dict[str, PathItem]	Reference]
deprecated	`bool	None` = None
security	`list[dict[str, list[str]]]	None` = None
servers	`list[Server]	None` = None

---