api-morph / XMLObject
Interface: XMLObject
Defined in: src/types/openapi.ts:1098
A metadata object that allows for more fine-tuned XML model definitions.
See
https://spec.openapis.org/oas/v3.1.1#xml-object
Indexable
[key: `x-${string}`]: any
This object MAY be extended with Specification Extensions.
Properties
attribute?
optionalattribute:boolean
Defined in: src/types/openapi.ts:1121
Declares whether the property definition translates to an attribute instead of an element. Default value is false.
name?
optionalname:string
Defined in: src/types/openapi.ts:1105
Replaces the name of the element/attribute used for the described schema property. When defined within 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 if and only if wrapped is true. If wrapped is false, it will be ignored.
namespace?
optionalnamespace:string
Defined in: src/types/openapi.ts:1110
The URI of the namespace definition. Value MUST be in the form of a non-relative URI.
prefix?
optionalprefix:string
Defined in: src/types/openapi.ts:1115
The prefix to be used for the name.
wrapped?
optionalwrapped:boolean
Defined in: src/types/openapi.ts:1128
MAY be used only for an array definition. Signifies whether the array is wrapped (for example, <books><book/><book/></books>) or unwrapped (<book/><book/>). Default value is false. The definition takes effect only when defined alongside type being "array" (outside the items).