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.
Value parameters
- delete
-
A definition of a DELETE operation on this path.
- description
-
A description, intended to apply to all operations in this path.
- get
-
A definition of a GET operation on this path.
- head
-
A definition of a HEAD operation on this path.
- options
-
A definition of a OPTIONS operation on this path.
- parameters
-
A Set 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 Set can use the Reference Object to link to parameters that are defined at the OpenAPI Object’s components/parameters.
- patch
-
A definition of a PATCH operation on this path.
- post
-
A definition of a POST operation on this path.
- put
-
A definition of a PUT operation on this path.
- ref
-
Allows for an external definition of this path item. The referenced structure MUST be in the format 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.
- servers
-
An alternative server List to service all operations in this path.
- summary
-
An optional, string summary, intended to apply to all operations in this path.
- trace
-
A definition of a TRACE operation on this path.
Attributes
- Companion
- object
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any