JsonSchema.Types.OneOfType (json_schema v0.6.0)

Copy Markdown View Source

Represents a custom oneOf type definition in a JSON schema.

JSON Schema:

"shape": {
  "description": "A union type of shapes",
  "oneOf": [
    {
      "$ref": "#/definitions/circle"
    },
    {
      "$ref": "#/definitions/rectangle"
    }
  ]
}

Resulting in the Elixir representation:

%OneOfType{name: "shape",
           description: "A union type of shapes",
           path: URI.parse("#/shape"),
           types: [URI.parse("#/shape/oneOf/0"),
                   URI.parse("#/shape/oneOf/1")]}

Summary

Types

t()

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