OpenAPI.Generate.Flags

This module defines the available command line flags and their default values.

Documentation

data Flags

The options passed to the generator via CLI

Constructors

Flags

Fields

• optOutputDir :: String

  The directory where the generated output is stored.

• optGenerateStackProject :: Bool

  Generate a stack project alongside the raw Haskell files

• optDryRun :: Bool

  Do not generate the output files but only print the generated code

• optForce :: Bool

  Overwrite output directory without question

• optPackageName :: String

  Name of the stack project

• optModuleName :: String

  Name of the module

• optUseFloatWithArbitraryPrecision :: Bool

  Use Data.Scientific instead of Double to support arbitary number precision

• optUseDateTypesAsString :: Bool

  Convert strings formatted as date / date-time to date types

• optConvertToCamelCase :: Bool

  Convert names to CamelCase instead of using names which are as close as possible to the names provided in the specification

• optPropertyTypeSuffix :: String

  Add a suffix to property types to prevent naming conflicts

• optResponseTypeSuffix :: String

  The suffix which is added to the response data types

• optResponseBodyTypeSuffix :: String

  The suffix which is added to the response body data types

• optRequestBodyTypeSuffix :: String

  The suffix which is added to the request body data types

• optUseNumberedVariantConstructors :: Bool

  Use numbered data constructors (e. g. Variant1, Variant 2, etc.) for one-of types

Instances

Eq Flags

Defined in OpenAPI.Generate.Flags

Methods

(==) :: Flags -> Flags -> Bool

(/=) :: Flags -> Flags -> Bool

Show Flags

Defined in OpenAPI.Generate.Flags

Methods

showsPrec :: Int -> Flags -> ShowS

show :: Flags -> String

showList :: [Flags] -> ShowS

Options Flags

Defined in OpenAPI.Generate.Flags

Methods

defineOptions :: DefineOptions Flags

defaultFlags :: Flags

Default flags which can be used for tests and as a reference which values actually are used