PathItem
This class represents a Path Item object in an OpenAPI specification, defining the available operations for a specific endpoint path. It supports various HTTP methods such as GET, POST, and PUT, while allowing for shared metadata like summaries, descriptions, and parameters across those operations. The class also facilitates external references and server-specific configurations for the defined path.
Attributes
| Attribute | Type | Description |
|---|---|---|
| ref | string = null | An external reference to a path item definition, used to populate this object's fields. |
| summary | string = null | An optional, short summary intended to apply to all operations in this path. |
| description | string = null | An optional, verbose explanation of the path item which can use CommonMark syntax. |
| get | [Operation](operation.md?sid=fastapi_openapi_models_operation) = null | The definition of a GET operation on this path. |
| put | [Operation](operation.md?sid=fastapi_openapi_models_operation) = null | The definition of a PUT operation on this path. |
| post | [Operation](operation.md?sid=fastapi_openapi_models_operation) = null | The definition of a POST operation on this path. |
| delete | [Operation](operation.md?sid=fastapi_openapi_models_operation) = null | The definition of a DELETE operation on this path. |
| options | [Operation](operation.md?sid=fastapi_openapi_models_operation) = null | The definition of an OPTIONS operation on this path. |
| head | [Operation](operation.md?sid=fastapi_openapi_models_operation) = null | The definition of a HEAD operation on this path. |
| patch | [Operation](operation.md?sid=fastapi_openapi_models_operation) = null | The definition of a PATCH operation on this path. |
| trace | [Operation](operation.md?sid=fastapi_openapi_models_operation) = null | The definition of a TRACE operation on this path. |
| servers | list[[Server](server.md?sid=fastapi_openapi_models_server)] = null | An alternative server array to service all operations in this path. |
| parameters | `list[Parameter | Reference]` = null |