OasPathItem

Describes the operations available on a single path. A Path Item MAY be empty, due to [ACL constraints](https://swagger.io/specification/#security-filtering). The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.

Members

Variables

delete_
OasOperation delete_;

A definition of a DELETE operation on this path.

description
string description;

An optional, string description, intended to apply to all operations in this path. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.

get
OasOperation get;

A definition of a GET operation on this path.

head
OasOperation head;

A definition of a HEAD operation on this path.

options
OasOperation options;

A definition of a OPTIONS operation on this path.

parameters
OasParameter[] parameters;

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 OasReference object to link to parameters that are defined at the OasDocument object's components/parameters.

patch
OasOperation patch;

A definition of a PATCH operation on this path.

post
OasOperation post;

A definition of a POST operation on this path.

put
OasOperation put;

A definition of a PUT operation on this path.

ref_
string ref_;

Allows for an external definition of this path item. The referenced structure MUST be in the format of a OasPathItem object. In case a OasPathItem field appears both in the defined object and the referenced object, the behavior is undefined.

servers
OasServer[] servers;

An alternative server array to service all operations in this path.

summary
string summary;

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

trace
OasOperation trace;

A definition of a TRACE operation on this path.

See Also

Meta