json_schema v0.5.0

View Source JsonSchema.Types.TypeReference (json_schema v0.5.0)

Represents a reference to a custom type definition in a JSON schema.

JSON Schema:

"self": {
  "$ref": "#/definitions/foo"
}

"other": {
  "$ref": "http://www.example.com/definitions.json#bar"
}

where "#/definitions/foo" resolves to

"definitions": {
  "foo": {
    "type": "string"
  }
}

and "http://www.example.com/definitions.json#bar" resolves to

"definitions": {
  "bar": {
    "id": "#bar",
    "type": "number"
  }
}

Resulting in the Elixir representation:

%TypeReference{name: "self",
               path: URI.parse("#/definitions/foo"]}

%TypeReference{name: "other",
               path: URI.parse("http://www.example.com/definitions.json#bar")}

Link to this section Summary

Types

t()

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %JsonSchema.Types.TypeReference{
  name: String.t() | :anonymous,
  path: JsonSchema.Types.typeIdentifier()
}