View Source ndto_parser_json_schema behaviour (ndto v0.3.1)

An ndto interface for parsing JSON Schemas.

Summary

Types

ctx/0
opts/0
spec/0
t/0
A parser is a module that implements the ndto_parser_json_schema behaviour.

Callbacks

parse/2

Functions

clean_optionals(RawValue)
get(Keys, Spec)
parse(SpecPath, Opts)
Parses a JSONSchema specification into a list of ndto:schema() values.
parse_spec(SpecPath)
resolve_ref(Ref, CTX)

Types

Link to this type

ctx/0

View Source 
-type ctx() :: #{base_path := binary(), base_name := binary(), resolved := [binary()], spec := spec()}.
Link to this type

opts/0

View Source 
-type opts() :: #{name => atom()}.
Link to this type

spec/0

View Source 
-type spec() :: njson:t().
Link to this opaque

t/0

View Source 
-opaque t()
A parser is a module that implements the ndto_parser_json_schema behaviour.

Callbacks

Link to this callback

parse/2

View Source 
-callback parse(Spec, CTX) -> Result
         when
             Spec :: spec(),
             CTX :: ctx(),
             Result :: {Schema, ExtraSchemas, NewCTX},
             Schema :: ndto:schema(),
             ExtraSchemas :: [{ndto:name(), ndto:schema()}],
             NewCTX :: ctx().

Functions

Link to this function

clean_optionals(RawValue)

View Source 
-spec clean_optionals(RawValue) -> Value when RawValue :: term(), Value :: term().
Link to this function

get(Keys, Spec)

View Source 
-spec get(Keys, Spec) -> Result when Keys :: [binary()], Spec :: map(), Result :: term().
Link to this function

parse(SpecPath, Opts)

View Source 
-spec parse(SpecPath, Opts) -> Result
         when
             SpecPath :: file:filename_all(),
             Opts :: opts(),
             Result :: {ok, Schemas} | {error, Reason},
             Schemas :: [{ndto:name(), ndto:schema()}],
             Reason :: term().
Parses a JSONSchema specification into a list of ndto:schema() values.
Link to this function

parse_spec(SpecPath)

View Source 
-spec parse_spec(SpecPath) -> Result
              when
                  SpecPath :: binary(),
                  Result :: {ok, Spec} | {error, Reason},
                  Spec :: ndto_parser:spec(),
                  Reason :: term().
Link to this function

resolve_ref(Ref, CTX)

View Source 
-spec resolve_ref(Ref, CTX) -> Result
               when
                   Ref :: binary(),
                   CTX :: ctx(),
                   Result :: {NewResolved, NewSchema, NewCTX},
                   NewResolved :: binary(),
                   NewSchema :: ndto:schema(),
                   NewCTX :: ctx().