json_schema v0.5.0

View Source JsonSchema.Parser.Util (json_schema v0.5.0)

A module containing utility functions for JSON schema parsers.

Link to this section Summary

Types

nodeParser()

Functions

add_fragment_child(uri, child)

Adds a child to the fragment of a URI.

create_type_dict(type_def, path, id)

Creates a new type dictionary based on the given type definition and an optional ID.

create_types_list(type_dict, path)

Returns a list of type paths when given a type dictionary.

get_type(value)

Returns the name of the type of the given value.

parse_child_types(child_nodes, parent_id, path)

Parse a list of JSON schema objects that have a child relation to another schema object with the specified parent_id.

parse_type(schema_node, parent_id, path, name, name_is_regex \\ false)

Parses a node type.

Link to this section Types

Link to this type

nodeParser()

View Source 
@type nodeParser() ::
  (JsonSchema.Types.schemaNode(), URI.t(), URI.t(), URI.t(), String.t() ->
     JsonSchema.Parser.ParserResult.t())

Link to this section Functions

Link to this function

add_fragment_child(uri, child)

View Source 
@spec add_fragment_child(URI.t(), String.t() | :anonymous) :: URI.t()

Adds a child to the fragment of a URI.

examples

 Examples 

iex> add_fragment_child(URI.parse("#/definitions/foo"), "bar")
URI.parse("#/definitions/foo/bar")
Link to this function

create_type_dict(type_def, path, id)

View Source 
@spec create_type_dict(
  JsonSchema.Types.typeDefinition(),
  URI.t(),
  URI.t() | nil
) :: JsonSchema.Types.typeDictionary()

Creates a new type dictionary based on the given type definition and an optional ID.

Link to this function

create_types_list(type_dict, path)

View Source 
@spec create_types_list(JsonSchema.Types.typeDictionary(), URI.t()) :: [URI.t()]

Returns a list of type paths when given a type dictionary.

Link to this function

get_type(value)

View Source 
@spec get_type(any()) :: String.t()

Returns the name of the type of the given value.

examples

 Examples

iex> get_type([1,2,3]) "list"

iex> get_type(%{"type" => "string"}) "object"

iex> get_type("name") "string"

iex> get_type(42) "integer"

Link to this function

parse_child_types(child_nodes, parent_id, path)

View Source 
@spec parse_child_types([JsonSchema.Types.schemaNode()], URI.t(), URI.t()) ::
  JsonSchema.Parser.ParserResult.t()

Parse a list of JSON schema objects that have a child relation to another schema object with the specified parent_id.

Link to this function

parse_type(schema_node, parent_id, path, name, name_is_regex \\ false)

View Source 
@spec parse_type(
  JsonSchema.Types.schemaNode(),
  URI.t() | nil,
  URI.t(),
  String.t() | :anonymous,
  boolean()
) :: JsonSchema.Parser.ParserResult.t()

Parses a node type.