JsonSchema.Types.UnionType (json_schema v0.6.0)

Copy Markdown View Source

Represents a custom union type definition in a JSON schema.

JSON Schema:

"favoriteNumber": {
  "description": "Your favorite number",
  "type": ["number", "integer", "null"]
}

Resulting in the Elixir representation:

%UnionType{name: "favoriteNumber",
           description: "Your favorite number",
           path: URI.parse("#/favoriteNumber"),
           types: [:number, :integer, :null]}

Summary

Types

default_value()
t()
value_type()

Types

default_value()

@type default_value() :: nil | boolean() | integer() | float() | binary()

t()

@type t() :: %JsonSchema.Types.UnionType{
  default: default_value(),
  description: String.t() | nil,
  name: String.t() | :anonymous,
  path: URI.t(),
  types: [value_type()]
}

value_type()

@type value_type() :: :null | :boolean | :integer | :number | :string