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 property SHOULD be used to add that information.
Value parameters
- attribute
-
Declares whether the property definition translates to an attribute instead of an element. Default value is false.
- name
-
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 arrayed (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.
- namespace
-
The URI of the namespace definition. This MUST be in the form of an absolute URI.
- prefix
-
The prefix to be used for the name.
- wrapped
-
MAY be used only for an array definition. Signifies whether the array is wrapped (for example,
) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being arrayed (outside the items).
Attributes
- Companion
- object
- Source
- OpenAPI.scala
- Graph
-
- Supertypes