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

org.openapis.v3.Components2.1.2

Overview
Properties
Methods
Type Aliases

module org.openapis.v3.Components

Holds a set of reusable objects for different aspects of the OAS.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/org.openapis.v3@2.1.2#/Components.pkl
Source code:: Components.pkl
Known subtypes:
Known usages:
All versions:

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

schemas: Mapping<ComponentKey, (Schema|Reference)>?Source

An object to hold reusable Schema Objects.
link

responses: Mapping<ComponentKey, (Response|Reference)>?Source

An object to hold reusable Response Objects.
link

parameters: Mapping<ComponentKey, (Parameter|Reference)>?Source

An object to hold reusable Parameter Objects.
link

examples: Mapping<ComponentKey, (Example|Reference)>?Source

An object to hold reusable Example Objects.
link

requestBodies: Mapping<ComponentKey, (RequestBody|Reference)>?Source

An object to hold reusable RequestBody Objects.
link

headers: Mapping<ComponentKey, (Header|Reference)>?Source

An object to hold reusable Header Objects.
link

securitySchemes: Mapping<ComponentKey, (SecurityScheme|Reference)>?Source

An object to hold reusable Security Scheme Objects.
link

links: Mapping<ComponentKey, (Link|Reference)>?Source

An object to hold reusable Link Objects.
link

callbacks: Mapping<ComponentKey, (Mapping<Expression, PathItem>|Reference)>?Source

An object to hold reusable Callback Objects.

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)
```
link

function

componentRef(type: ComponentType, name: String): Reference Source

Component reference helper function. This reference will point to the named component in the local document's "components" fields.

Type Aliases

link

typealias

ComponentKey = String(matches(Regex(#"[a-zA-Z0-9.\-_]+"#)))Source

Component mapping key type used to reference all component values.
link

typealias

ComponentType = "schemas"|"responses"|"parameters"|"examples"|"requestBodies"|"headers"|"links"Source

Component type name for use with component reference helpers.