Xml

@Serializable(with = Xml.Companion.Serializer::class)

data class Xml(val name: String? = null, val namespace: String? = null, val prefix: String? = null, val attribute: Boolean? = null, val wrapped: Boolean? = null, val extensions: ExtensionProperties? = null) : Extensible(source)

Constructors

Xml

constructor(name: String? = null, namespace: String? = null, prefix: String? = null, attribute: Boolean? = null, wrapped: Boolean? = null, extensions: ExtensionProperties? = null)

Types

Companion

object Companion

Properties

attribute

val attribute: Boolean?

Declares whether the property definition translates to an attribute instead of an element. Default value is @False@.

extensions

open override val extensions: ExtensionProperties?

Any additional external documentation for this OpenAPI document. The key is the name of the extension (beginning with x-), and the value is the data.

name

val name: String?

Replaces the name of the element/attribute used for the described schema property. When defined within the @'OpenApiItems'@ (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.

namespace

val namespace: String?

The URL of the namespace definition. Value SHOULD be in the form of a URL.

prefix

val prefix: String?

The prefix to be used for the name.

wrapped

val wrapped: Boolean?

MAY be used only for an array definition. Signifies whether the array is wrapped (for example, @\\\\@) or unwrapped (@\\@). Default value is