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

org.openapis.v3.Header2.1.0

Overview
Properties
Methods

module org.openapis.v3.Header extends org.openapis.v3.BaseParameter

The Header Object follows the structure of the Parameter Object with the following changes:

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/org.openapis.v3@2.1.0#/Header.pkl
Source code:: Header.pkl
Known subtypes:
Known usages:: Components, Encoding, Response
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

description: String? (org.openapis.v3.BaseParameter)

A brief description of the parameter.

This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
link

deprecated: Boolean? (org.openapis.v3.BaseParameter)

Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.

Default value is false.
link

allowEmptyValue: Boolean? (org.openapis.v3.BaseParameter)

Sets the ability to pass empty-valued parameters.

This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.
link

explode: Boolean? (org.openapis.v3.BaseParameter)

When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.

For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.
link

example: Any?(!(this != null && examples != null)) (org.openapis.v3.BaseParameter)

Example of the parameter's potential value. The example SHOULD match the specified schema and encoding properties if present.

The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema that contains an example, the example value SHALL override the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.
link

examples: Mapping<String, Any>? (org.openapis.v3.BaseParameter)

Examples of the parameter's potential value.

Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema that contains an example, the examples value SHALL override the example provided by the schema.
link

required: Boolean?Source

Determines whether this parameter is mandatory.
link

style: "simple"?Source

Describes how the parameter value will be serialized depending on the type of the parameter value.

In this case, it's a header, so it should always be "simple".
link

schema: (Schema|Reference)?Source

The schema defining the type used for the parameter.

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