open_api_spex v3.10.0

OpenApiSpex.Plug.PutApiSpec (open_api_spex v3.10.0) View Source

Module plug that calls a given module to obtain the Api Spec and store it as private in the Conn.

This allows downstream plugs to use the API spec for casting, validating and rendering.

Options

Example 

plug OpenApiSpex.Plug.PutApiSpec, module: MyAppWeb.ApiSpec

Link to this section Summary

Functions

get_and_cache_controller_action(conn, operation_id, arg)
get_spec_and_operation_lookup(conn)
spec_module(conn)

Link to this section Functions

Link to this function

get_and_cache_controller_action(conn, operation_id, arg)

View Source

Specs

get_and_cache_controller_action(Conn.t(), String.t(), {module(), atom()}) ::
  Operation.t()
Link to this function

get_spec_and_operation_lookup(conn)

View Source

Specs

get_spec_and_operation_lookup(Conn.t()) ::
  {spec :: OpenApiSpex.OpenApi.t(),
   operation_lookup :: %{required(any()) => Operation.t()}}
Link to this function

spec_module(conn)

View Source

Specs

spec_module(Conn.t()) :: module()