xema

v0.6.2

xema v0.6.2 Xema.Schema View Source

This module contains the struct for the keywords of a schema.

Usually this struct will be just used by xema.

Examples 

iex> xema = Xema.new :any
iex> xema.schema == %Xema.Schema{type: :any}
true

Link to this section Summary

Types

t()

The struct contains the keywords for a schema

type()

The type for the schema

Functions

keywords()

Returns all keywords in a list

new(keywords)

Returns a %Schema{} for the given keywords in the keyword list

to_map(schema)

Returns the %Schema{} as a map. Items which a nil value are not in the map

types()

Returns all available types in a list

Link to this section Types

Link to this type

t() View Source 
t() :: %Xema.Schema{
  items: list() | Xema.t() | Xema.Schema.t() | nil,
  data: map(),
  max_length: pos_integer() | nil,
  one_of: [Xema.Schema.t()] | nil,
  any_of: [Xema.Schema.t()] | nil,
  then: Xema.t() | Xema.Schema.t() | nil,
  exclusive_minimum: boolean() | number() | nil,
  max_items: pos_integer() | nil,
  format: atom() | nil,
  keys: atom() | nil,
  additional_properties: map() | boolean() | nil,
  min_properties: pos_integer() | nil,
  additional_items: Xema.t() | Xema.Schema.t() | boolean() | nil,
  unique_items: boolean() | nil,
  min_items: pos_integer() | nil,
  all_of: [Xema.Schema.t()] | nil,
  max_properties: pos_integer() | nil,
  const: any(),
  description: String.t() | nil,
  exclusive_maximum: boolean() | number() | nil,
  minimum: number() | nil,
  required: MapSet.t() | nil,
  module: atom() | nil,
  title: String.t() | nil,
  id: String.t() | nil,
  else: Xema.t() | Xema.Schema.t() | nil,
  multiple_of: number() | nil,
  contains: Xema.t() | Xema.Schema.t() | nil,
  content_encoding: String.t() | nil,
  comment: String.t() | nil,
  default: any(),
  dependencies: list() | map() | nil,
  definitions: map(),
  ref: Xema.Ref.t() | nil,
  properties: map() | nil,
  maximum: number() | nil,
  pattern: Regex.t() | nil,
  property_names: Xema.t() | Xema.Schema.t() | nil,
  enum: list() | nil,
  type: type() | [type()],
  examples: [any()],
  pattern_properties: map() | nil,
  not: Xema.Schema.t() | nil,
  schema: String.t() | nil,
  if: Xema.t() | Xema.Schema.t() | nil,
  content_media_type: String.t() | nil,
  min_length: pos_integer() | nil
}

The struct contains the keywords for a schema.

  • additional_items disallow additional items, if set to false. The keyword can also contain a schema to specify the type of additional items.
  • additional_properties disallow additional properties, if set to true.
  • 'all_of' a list of schemas they must all be valid.
  • 'any_of' a list of schemas with any valid schema.
  • comment for the schema.
  • const specifies a constant.
  • content_encoding annotation for the encoding.
  • content_media_type annotation for the media type.
  • contains validates a list whether any item is valid for the given schema.
  • data none schema data.
  • default this keyword can be used to supply a default JSON value.
  • definitions contains schemas for reuse.
  • dependencies allows the schema of the map to change based on the presence of certain special properties
  • description of the schema.
  • else see if, then, else.
  • enum specifies an enumeration
  • examples the value of this keyword must be an array. There are no restrictions placed on the values within the array.
  • exclusive_maximum is a boolean. When true, it indicates that the range excludes the maximum value.
  • exclusive_minimum is a boolean. When true, it indicates that the range excludes the minimum value.
  • format semantic validation.
  • id a unique identifier.
  • if, then, else: These keywords work together to implement conditional application of a subschema based on the outcome of another subschema.
  • items specifies the type(s) of the items.
  • keys could be :atoms or :strings.
  • max_items the maximum length of list.
  • max_length the maximum length of string.
  • max_properties the maximum count of properties for the map.
  • maximum the maximum value.
  • min_items the minimal length of list.
  • min_length the minimal length of string.
  • min_properties the minimal count of properties for the map.
  • minimum the minimum value.
  • module the module of a struct.
  • multiple_of is a number greater 0. The value has to be a multiple of this number.
  • not negates the given schema
  • one_of the given data must be valid against exactly one of the given subschemas.
  • pattern_properties specifies schemas for properties by patterns
  • pattern restrict a string to a particular regular expression.
  • properties specifies schemas for properties.
  • property_names a schema to check property names.
  • ref a reference to a schema.
  • required contains a set of required properties.
  • schema declares the used schema.
  • title of the schema.
  • then see if, then, else
  • type specifies the data type for a schema.
  • unique_items disallow duplicate items, if set to true.
Link to this type

type() View Source 
type() ::
  :any
  | :atom
  | :boolean
  | false
  | :float
  | :integer
  | :keyword
  | :list
  | :map
  | nil
  | :number
  | :string
  | :struct
  | true
  | :tuple

The type for the schema.

Link to this section Functions

Link to this function

keywords() View Source 
keywords() :: [atom()]

Returns all keywords in a list.

The key :data is not a regular keyword and is not in the list.

Link to this function

new(keywords) View Source 
new(keyword()) :: Xema.Schema.t()

Returns a %Schema{} for the given keywords in the keyword list.

Link to this function

to_map(schema) View Source 
to_map(Xema.Schema.t()) :: map()

Returns the %Schema{} as a map. Items which a nil value are not in the map.

Link to this function

types() View Source 
types() :: [type()]

Returns all available types in a list.