Oaskit.Spec.Paths (oaskit v0.3.0)

View Source

Representation of the Paths Object in OpenAPI Specification.

Summary

Functions

Accepts a Phoenix router module and returns paths that point to a controller with operations defined for its actions.

Same as from_router/2 but directly accepts the return value of router_module.__routes__().

Functions

from_router(router, opts \\ [])

Accepts a Phoenix router module and returns paths that point to a controller with operations defined for its actions.

Options

  • :filter - A predicate function to limit routes defined in your OpenAPI specification. This predicate is not called for every route, only on routes that define an operation.

from_routes(routes, opts \\ [])

Same as from_router/2 but directly accepts the return value of router_module.__routes__().

json_schema()