ExUtcp.OpenApiConverter.Parser (ex_utcp v0.3.2)

Copy Markdown View Source

OpenAPI specification parser for both 2.0 and 3.0 versions.

Summary

Functions

Parses an OpenAPI specification into a normalized structure.

Validates an OpenAPI specification.

Functions

parse(spec)

@spec parse(map()) ::
  {:ok, ExUtcp.OpenApiConverter.Types.ParsedSpec.t()} | {:error, String.t()}

Parses an OpenAPI specification into a normalized structure.

Parameters

  • spec: OpenAPI specification as a map

Returns

{:ok, parsed_spec} on success, {:error, reason} on failure.

validate(spec)

Validates an OpenAPI specification.

Parameters

  • spec: OpenAPI specification as a map

Returns

{:ok, validation_result} on success, {:error, reason} on failure.