View Source erf_parser_oas_3_0 (erf v0.1.2)

An OpenAPI Specification 3.0 erf_parser.

Summary

Types

ctx/0
spec/0

Functions

parse(SpecPath)
Parses an OpenAPI Specification 3.0 file into an API AST.

Types

Link to this type

ctx/0

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

spec/0

View Source 
-type spec() :: njson:t().

Functions

Link to this function

parse(SpecPath)

View Source 
-spec parse(SpecPath) -> Result
               when
                   SpecPath :: binary(),
                   Result :: {ok, API} | {error, Reason},
                   API :: erf:api(),
                   Reason :: term().
Parses an OpenAPI Specification 3.0 file into an API AST.