Bier.OpenAPI (bier v0.2.0)

Copy Markdown View Source

Builds the Swagger 2.0 (OpenAPI 2.0) root document from an introspection snapshot. Wire-format match to PostgREST Bier.postgrest_version/0 is the contract; see the openapi area doc — spec/spec/openapi.yaml, i.e. the spec/ submodule's own spec/openapi.yaml — and spec/cases/16*.yaml. An opt-in OpenAPI 3.0.3 translation of this document is available via the openapi_version: "3.0" config option (Bier.OpenAPI.V3).

Summary

Functions

build(input)

Builds the Swagger 2.0 document map from an introspection snapshot.

Functions

build(input)

Builds the Swagger 2.0 document map from an introspection snapshot.

Input keys: :relations, :functions, :schema_comment, :security_active?, :docs_version, :server_scheme, :server_host, :server_port, and optionally :proxy_uri (openapi-server-proxy-uri).