Oaskit.SpecValidator (oaskit v0.9.0)

View Source

A helper module used to cast and validate OpenAPI specifications into structs.

This module is NOT responsible for validating requests, responses and payloads according to an OpenAPI specification (although it is involved in the process). That is the role of Oaskit.Plugs.ValidateRequest and Oaskit.Validation.RequestValidator.

This module validates the specification itself according to the Oaskit.Spec.OpenAPI JSON Schema.

Summary

Functions

Validates the given OpenAPI specification and returns an Oaskit.Spec.OpenAPI struct in a result tuple.

Validates the given OpenAPI specification and returns an Oaskit.Spec.OpenAPI struct.

Functions

validate(spec)

Validates the given OpenAPI specification and returns an Oaskit.Spec.OpenAPI struct in a result tuple.

validate!(spec)

Validates the given OpenAPI specification and returns an Oaskit.Spec.OpenAPI struct.

Raises on error.