Xml

class Xml(d: dict[str, Any] = None, name: str = None, namespace: str = None, prefix: str = None, attribute: bool = None, wrapped: bool = None)

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

When using arrays, XML element names are not inferred (for singular/plural forms) and the name field SHOULD be used to add that information. See examples for expected behavior.

property name: str | None

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.

property namespace: str | None

The URI of the namespace definition. Value MUST be in the form of a non-relative URI.

property prefix: str | None

The prefix to be used for the name.

property attribute: bool | None

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

property wrapped: bool | None

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