api-morph / PathItemObject

Interface: PathItemObject

Defined in: src/types/openapi.ts:333

Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.

See

https://spec.openapis.org/oas/v3.1.1#path-item-object

Indexable

[key: `x-${string}`]: any

This object MAY be extended with Specification Extensions.

Properties

$ref?

optional $ref: string

Defined in: src/types/openapi.ts:340

Allows for a referenced definition of this path item. The value MUST be in the form of a URI, and the referenced structure MUST be in the form of a Path Item Object. In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving Relative References.

---

delete?

optional delete: OperationObject

Defined in: src/types/openapi.ts:371

A definition of a DELETE operation on this path.

---

description?

optional description: string

Defined in: src/types/openapi.ts:351

An optional string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.

---

get?

optional get: OperationObject

Defined in: src/types/openapi.ts:356

A definition of a GET operation on this path.

---

head?

optional head: OperationObject

Defined in: src/types/openapi.ts:381

A definition of a HEAD operation on this path.

---

options?

optional options: OperationObject

Defined in: src/types/openapi.ts:376

A definition of a OPTIONS operation on this path.

---

parameters?

optional parameters: (ReferenceObject | ParameterObject)[]

Defined in: src/types/openapi.ts:405

A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined in the OpenAPI Object's components.parameters.

---

patch?

optional patch: OperationObject

Defined in: src/types/openapi.ts:386

A definition of a PATCH operation on this path.

---

post?

optional post: OperationObject

Defined in: src/types/openapi.ts:366

A definition of a POST operation on this path.

---

put?

optional put: OperationObject

Defined in: src/types/openapi.ts:361

A definition of a PUT operation on this path.

---

servers?

optional servers: ServerObject[]

Defined in: src/types/openapi.ts:397

An alternative servers array to service all operations in this path. If a servers array is specified at the OpenAPI Object level, it will be overridden by this value.

---

summary?

optional summary: string

Defined in: src/types/openapi.ts:345

An optional string summary, intended to apply to all operations in this path.

---

trace?

optional trace: OperationObject

Defined in: src/types/openapi.ts:391

A definition of a TRACE operation on this path.