Packages > pkg.pkl-lang.org/pkl-pantry/org.openapis.v3

org.openapis.v3.PathItem2.1.1

Overview
Properties
Methods

module org.openapis.v3.PathItem

Describes the operations available on a single path.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/org.openapis.v3@2.1.1#/PathItem.pkl
Source code:: PathItem.pkl
Known subtypes:
Known usages:: Components, Document, Operation
All versions:: 2.1.3, 2.1.2, 2.1.1, 2.1.0

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

$ref: Uri?Source

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.
link

summary: String?Source

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

description: String?Source

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

CommonMark syntax MAY be used for rich text representation.
link

get: Operation?Source

A definition of a GET operation on this path.
link

put: Operation?Source

A definition of a PUT operation on this path.
link

post: Operation?Source

A definition of a POST operation on this path.
link

`delete`: Operation?Source

A definition of a DELETE operation on this path.
link

options: Operation?Source

A definition of an OPTIONS operation on this path.
link

head: Operation?Source

A definition of a HEAD operation on this path.
link

patch: Operation?Source

A definition of a PATCH operation on this path.
link

`trace`: Operation?Source

A definition of a TRACE operation on this path.
link

servers: Listing<Server>?Source

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

parameters: Listing<(Parameter|Reference)>?Source

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.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```