json_schema

v0.1.0

json_schema v0.1.0 JsonSchema View Source

JSON Schema

A JSON schema parser written in Elixir.

Link to this section Summary

Functions

parse_schema_document(schema_path, schema_document)

Parses a single JSON Schema documents into a SchemaResult

parse_schema_documents(schema_path_document_pairs)

Parses one or more JSON Schema documents into a SchemaResult

parse_schema_files(schema_paths)

Parses one or more JSON schema files into a SchemaResult containing a dictionary of parsed schemas represented as Elixir structs and two lists of any warnings or errors encountered while parsing the JSON schema documents

resolve_type(identifier, parent, schema_def, schema_dict)

Resolves a JSON schema Types.typeIdentifier, when given a SchemaDefinition and a Types.schemaDictionary

Link to this section Functions

Link to this function parse_schema_document(schema_path, schema_document) View Source 
parse_schema_document(Path.t(), String.t()) ::
  JsonSchema.Parser.SchemaResult.t()

Parses a single JSON Schema documents into a SchemaResult.

Link to this function parse_schema_documents(schema_path_document_pairs) View Source 
parse_schema_documents([{Path.t(), String.t()}]) ::
  JsonSchema.Parser.SchemaResult.t()

Parses one or more JSON Schema documents into a SchemaResult.

Link to this function parse_schema_files(schema_paths) View Source 
parse_schema_files([Path.t()]) :: JsonSchema.Parser.SchemaResult.t()

Parses one or more JSON schema files into a SchemaResult containing a dictionary of parsed schemas represented as Elixir structs and two lists of any warnings or errors encountered while parsing the JSON schema documents.

Link to this function resolve_type(identifier, parent, schema_def, schema_dict) View Source 
resolve_type(
  JsonSchema.Types.typeIdentifier(),
  JsonSchema.Types.typeIdentifier(),
  SchemaDefinition.t(),
  JsonSchema.Types.schemaDictionary()
) ::
  {:ok, {JsonSchema.Types.typeDefinition(), SchemaDefinition.t()}}
  | {:error, ParserError.t()}

Resolves a JSON schema Types.typeIdentifier, when given a SchemaDefinition and a Types.schemaDictionary.