Rolodex v0.2.0 Rolodex.Config
Configuration for Rolodex.
You can define this config in your config/<env>.exs
files, keyed by
:rolodex
, and it will be passed into new/1
in Mix.Tasks.GenDocs.run/1
.
Options
description
(required) - Description for your documentation outputrouter
(required) -Phoenix.Router
module to inspecttitle
(required) - Title for your documentation outputversion
(required) - Your documentation's versionfilter
(default::none
) - TODOlocale
(default:"en"
) - Locale key to use when processing descriptionspipelines
(default:%{}
) - Map of pipeline configs. Used to set default parameter values for all routes in a pipeline. SeeRolodex.PipelineConfig
.processor
(default:Rolodex.Processors.Swagger
) - Module implementing theRolodex.Processor
behaviourwriter
(default:%{file_path: "", writer: Rolodex.Writers.FileWriter
) - Destination for writing and a module implementing theRolodex.Writer
behaviour
Example
config :rolodex,
title: "MyApp",
description: "An example",
version: "1.0.0",
router: MyRouter,
processor: Rolodex.Processors.Swagger,
writer: %{
file_path: "/",
module: Rolodex.Writers.FileWriter
},
pipelines: %{
api: %{
headers: %{"X-Request-Id" => :uuid}
}
}
Link to this section Summary
Link to this section Types
Link to this type
pipeline_configs()
pipeline_configs()
pipeline_configs() :: %{optional(:atom) => Rolodex.PipelineConfig.t()}
pipeline_configs() :: %{optional(:atom) => Rolodex.PipelineConfig.t()}
Link to this section Functions
Link to this function
new(kwl \\ [])
new(kwl \\ [])
new(list()) :: Rolodex.Config.t()
new(list()) :: Rolodex.Config.t()