JsonSchema.Types (json_schema v0.6.0)

Copy Markdown View Source

Specifies the main Elixir types used for describing the intermediate representations of JSON schema types.

Summary

Types

json_value()
propertyDictionary()
schemaDictionary()
schemaNode()
typeDefinition()
typeDictionary()
typeIdentifier()

Types

json_value()

@type json_value() ::
  nil | boolean() | map() | list() | integer() | number() | String.t()

propertyDictionary()

@type propertyDictionary() :: %{optional(String.t()) => typeIdentifier()}

schemaDictionary()

@type schemaDictionary() :: %{
  optional(String.t()) => JsonSchema.Types.SchemaDefinition.t()
}

schemaNode()

@type schemaNode() :: %{optional(String.t()) => json_value()}

typeDefinition()

@type typeDefinition() ::
  JsonSchema.Types.AllOfType.t()
  | JsonSchema.Types.AnyOfType.t()
  | JsonSchema.Types.ArrayType.t()
  | JsonSchema.Types.ConstType.t()
  | JsonSchema.Types.EnumType.t()
  | JsonSchema.Types.ObjectType.t()
  | JsonSchema.Types.OneOfType.t()
  | JsonSchema.Types.PrimitiveType.t()
  | JsonSchema.Types.TupleType.t()
  | JsonSchema.Types.TypeReference.t()
  | JsonSchema.Types.UnionType.t()

typeDictionary()

@type typeDictionary() :: %{optional(String.t()) => typeDefinition()}

typeIdentifier()

@type typeIdentifier() :: URI.t() | String.t()