json_schema

v0.1.0

json_schema v0.1.0 JsonSchema.Types.ObjectType View Source

Represents a custom ‘object’ type definition in a JSON schema.

JSON Schema:

"circle": {
  "type": "object",
  "properties": {
    "color": {
      "$ref": "#/color"
    },
    "title": {
      "type": "string"
    },
    "radius": {
      "type": "number"
    }
  },
  "required": [ "color", "radius" ]
}

Resulting Elixir intermediate representation:

%ObjectType{name: "circle",
            path: ["#", "circle"],
            required: ["color", "radius"],
            properties: %{
                "color" => ["#", "circle", "properties", "color"],
                "title" => ["#", "circle", "properties", "title"],
                "radius" => ["#", "circle", "properties", "radius"]}}

Link to this section Summary

Types

t()

Functions

new(name, path, properties, required)

Link to this section Types

Link to this type t() View Source 
t() :: %JsonSchema.Types.ObjectType{
  name: String.t(),
  path: JsonSchema.TypePath.t(),
  properties: JsonSchema.Types.propertyDictionary(),
  required: [String.t()]
}

Link to this section Functions