Path

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.

Alias This

operations

Members

Functions

toJson
Json toJson()

Static functions

fromJson
Path fromJson(Json src)

Variables

_ref
string _ref;

Allows for an external definition of this path item. The referenced structure MUST be in the format of a Path Item Object. If there are conflicts between the referenced definition and this Path Item's definition, the behavior is undefined.

description
string description;

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

operations
Operation[OperationsType] operations;

Defined operations

parameters
Parameter[] 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 Reference Object to link to parameters that are defined at the OpenApi Object's components/parameters.

servers
Server[] 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.

Meta