Rolodex v0.8.0 Rolodex.RenderGroupConfig

Configuration for a render group, a serialization target for your docs. You can specify one or more render groups via Rolodex.Config to render docs output(s) for your API.

Options

  • filters (default: :none) - A list of maps or functions used to filter out routes from your documentation. Filters are invoked in Rolodex.Route.matches_filter?/2. If the match returns true, the route will be filtered out of the docs result for this render group.
  • processor (default: Rolodex.Processors.OpenAPI) - Module implementing the Rolodex.Processor behaviour
  • writer (default: Rolodex.Writers.FileWriter) - Module implementing the Rolodex.Writer behaviour to be used to write out the docs
  • writer_opts (default: [file_name: "api.json"]) - Options keyword list passed into the writer behaviour.

Link to this section Summary

Link to this section Types

Link to this type

t()
t() :: %Rolodex.RenderGroupConfig{
  filters: [map() | (Rolodex.Route.t() -> boolean())] | :none,
  processor: module(),
  writer: module(),
  writer_opts: keyword()
}

Link to this section Functions

Link to this function

new(params \\ [])
new(list() | map()) :: t()