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

Xml2.1.1

Overview
Properties
Methods

class Xml

A metadata object that allows for more fine-tuned XML model definitions.

Known subtypes:
Known usages:: PropertySchema
All versions:: 2.1.3, 2.1.2, 2.1.1, 2.1.0, 2.0.0, 1.0.0

Properties

link

name: String?Source

Replaces the name of the element/attribute used for the described schema property.

When defined within items, it affects the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it affects the wrapping element and only if wrapped is true. If wrapped is false, it is ignored.
link

namespace: Uri?Source

The URI of the namespace definition. Value MUST be in the form of an absolute URI.
link

prefix: String?Source

The prefix used for the name.
link

attribute: Boolean?Source

Declares whether the property definition translates to an attribute instead of an element.

Default value is false.
link

wrapped: Boolean?Source

Signifies whether the array is wrapped (for example, <books><book/><book/></books>) or unwrapped (<book/><book/>).

May be used only for an array definition. Default value is false.

The definition takes effect only when defined alongside type being array (outside the items).

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

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

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

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

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

function

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

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

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

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

Converts this object to a Map.