openapi-generator/docs/generators/haskell-http-client.md
Jim Schubert 644f720db8
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046)
* [config-help] Sort all outputs

* Remove old/stale generator docs (these have been renamed previously)

* Sort config doc outputs, making it easier to find relevant info

* Fixes cliOptions duplicates

Erlang client/proper improperly set the version option as packageName
(causing duplicate for packageName).

The java and swift option removals are because the options are added in
parent classes, resulting in duplication of the options.

* Add --github-nested-index for generating docs/generators/README.md

* 📝 Regenerate generator docs
2020-01-19 20:19:11 -05:00

3.8 KiB

title sidebar_label
Config Options for haskell-http-client haskell-http-client
Option Description Values Default
allowFromJsonNulls allow JSON Null during model decoding from JSON true
allowNonUniqueOperationIds allow different API modules to contain the same operationId. Each API must be imported qualified false
allowToJsonNulls allow emitting JSON Null during model encoding to JSON false
allowUnicodeIdentifiers boolean, toggles whether unicode identifiers are allowed in names or not, default is false false
baseModule Set the base module namespace null
cabalPackage Set the cabal package name, which consists of one or more alphanumeric words separated by hyphens null
cabalVersion Set the cabal version number, consisting of a sequence of one or more integers separated by dots null
configType Set the name of the type used for configuration null
customTestInstanceModule test module used to provide typeclass instances for types not known by the generator null
dateFormat format string used to parse/render a date %Y-%m-%d
dateTimeFormat format string used to parse/render a datetime null
dateTimeParseFormat overrides the format string used to parse a datetime null
ensureUniqueParams Whether to ensure parameter names are unique in an operation (rename parameters that are not). true
generateEnums Generate specific datatypes for OpenAPI enums true
generateFormUrlEncodedInstances Generate FromForm/ToForm instances for models that are used by operations that produce or consume application/x-www-form-urlencoded true
generateLenses Generate Lens optics for Models true
generateModelConstructors Generate smart constructors (only supply required fields) for models true
hideGenerationTimestamp Hides the generation timestamp when files are generated. true
inlineMimeTypes Inline (hardcode) the content-type and accept parameters on operations, when there is only 1 option true
modelDeriving Additional classes to include in the deriving() clause of Models null
prependFormOrBodyParameters Add form or body parameters to the beginning of the parameter list. false
requestType Set the name of the type used to generate requests null
sortModelPropertiesByRequiredFlag Sort model properties to place required parameters before optional parameters. true
sortParamsByRequiredFlag Sort method arguments to place required parameters before optional parameters. true
strictFields Add strictness annotations to all model fields true
useKatip Sets the default value for the UseKatip cabal flag. If true, the katip package provides logging instead of monad-logger true

IMPORT MAPPING

Type/Alias Imports

INSTANTIATION TYPES

Type/Alias Instantiated By

LANGUAGE PRIMITIVES

  • Bool
  • Char
  • Double
  • FilePath
  • Float
  • Int
  • Integer
  • List
  • String
  • Text

RESERVED WORDS

  • accept
  • as
  • case
  • class
  • contenttype
  • data
  • default
  • deriving
  • do
  • else
  • family
  • forall
  • foreign
  • hiding
  • if
  • import
  • in
  • infix
  • infixl
  • infixr
  • instance
  • let
  • mdo
  • module
  • newtype
  • of
  • proc
  • pure
  • qualified
  • rec
  • return
  • then
  • type
  • where