Rolodex v0.10.1 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

router (required) - A Rolodex.Router definition
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

Types

t()

Functions

new(params \\ [])

Link to this section Types

t()

t() :: %Rolodex.RenderGroupConfig{
  processor: module(),
  router: module(),
  writer: module(),
  writer_opts: keyword()
}

Link to this section Functions

new(params \\ [])

new(list() | map()) :: t()

Rolodex

v0.10.1

Rolodex v0.10.1 Rolodex.RenderGroupConfig

Options

Link to this section Summary

Types

Functions

Link to this section Types

t()

t() :: %Rolodex.RenderGroupConfig{ processor: module(), router: module(), writer: module(), writer_opts: keyword() }

Link to this section Functions

new(params \\ [])

new(list() | map()) :: t()

Rolodex

v0.10.1

Rolodex v0.10.1 Rolodex.RenderGroupConfig

Options

Link to this section Summary

Types

Functions

Link to this section Types

t() t() :: %Rolodex.RenderGroupConfig{ processor: module(), router: module(), writer: module(), writer_opts: keyword() }

Link to this section Functions

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

t()

t() :: %Rolodex.RenderGroupConfig{ processor: module(), router: module(), writer: module(), writer_opts: keyword() }

new(params \\ [])

new(list() | map()) :: t()