XML

zio.http.endpoint.openapi.OpenAPI.XML

final case class XML(name: String, namespace: URI, prefix: String, attribute: Boolean, wrapped: Boolean)

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.
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 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: The URI of the namespace definition.
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 (). The definition takes effect only when defined alongside type being array (outside the items).

Graph
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

In this article

Generated with