Oaskit.Spec.Paths (oaskit v0.6.0)
View SourceRepresentation 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
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.:unprefix- A string to remove from the beginning of the paths keys. Useful if your server path already contains a prefix like"/api/v1". In the OpenAPI Specification, paths are always relative to the server path, even when starting with"/".
Same as from_router/2 but directly accepts the return value of
router_module.__routes__().