Documentation

Fields

• settingOpenApiSpecification :: !Text

  The OpenAPI 3 specification file which code should be generated for.

• settingOutputDir :: !Text

  The directory where the generated output is stored.

• settingPackageName :: !Text

  Name of the stack project

• settingModuleName :: !ModuleName

  Name of the module

• settingLogLevel :: !LogSeverity

  The minimum log level to output

• settingForce :: !Bool

  Overwrite output directory without question

• settingIncremental :: !Bool

  Only write new/changed files

• settingDryRun :: !Bool

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

• settingDoNotGenerateStackProject :: !Bool

  Do not generate a stack project alongside the raw Haskell files

• settingGenerateNixFiles :: !Bool

  Generate Nix files (default.nix and shell.nix)

• settingOmitAdditionalOperationFunctions :: !Bool

  Omit the additional operation functions, which are: with explicit configuration and raw variants (returning the plain ByteString) for both with and without explicit configuration

• settingGenerateOptionalEmptyRequestBody :: !Bool

  Force the generator to create types for empty request bodies which are optional (e. g. no properties and required equals false)

• settingUseNumberedVariantConstructors :: !Bool

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

• settingUseFloatWithArbitraryPrecision :: !Bool

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

• settingUseIntWithArbitraryPrecision :: !Bool

  Use Integer instead of Int to support arbitrary number precision

• settingUseDateTypesAsString :: !Bool

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

• settingConvertToCamelCase :: !Bool

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

• settingPropertyTypeSuffix :: !Text

  Add a suffix to property types to prevent naming conflicts

• settingResponseTypeSuffix :: !Text

  The suffix which is added to the response data types

• settingResponseBodyTypeSuffix :: !Text

  The suffix which is added to the response body data types

• settingRequestBodyTypeSuffix :: !Text

  The suffix which is added to the request body data types

• settingArrayItemTypeSuffix :: !Text

  The suffix which is added to the item type of an array. This is only applied to item types of top level array types which an alias is generated for.

• settingNonNullableTypeSuffix :: !Text

  The suffix which is added to the non-nullable part of a nullable type. This is only applied to top level nullable schemas as they are the only ones which need to be referencable by name.

• settingParametersTypeSuffix :: !Text

  The suffix which is added to the parameters type of operations

• settingParameterQueryPrefix :: !Text

  The prefix which is added to query parameters

• settingParameterPathPrefix :: !Text

  The prefix which is added to path parameters

• settingParameterCookiePrefix :: !Text

  The prefix which is added to cookie parameters

• settingParameterHeaderPrefix :: !Text

  The prefix which is added to header parameters

• settingOperationsToGenerate :: ![Text]

  The operations to generate (if empty all operations are generated)

• settingOpaqueSchemas :: ![Text]

  A list of schema names (exactly as they are named in the components.schemas section of the corresponding OpenAPI 3 specification) which are not further investigated while generating code from the specification. Only a type alias to Value is created for these schemas.

• settingWhiteListedSchemas :: ![Text]

  A list of schema names (exactly as they are named in the components.schemas section of the corresponding OpenAPI 3 specification) which need to be generated. For all other schemas only a type alias to Value is created.

• settingOutputAllSchemas :: !Bool

  Output all schemas.

• settingFixedValueStrategy :: !FixedValueStrategy

  In OpenAPI 3, fixed values can be defined as an enum with only one allowed value. If such a constant value is encountered as a required property of an object, the generator excludes this property by default ("exclude" strategy) and adds the value in the ToJSON instance and expects the value to be there in the FromJSON instance. This setting allows to change this behavior by including all fixed value fields instead ("include" strategy), i.e. just not trying to do anything smart.

• settingShortenSingleFieldObjects :: !Bool

  When encountering an object with a single field, shorten the field of that object to be the schema name. Respects property type suffix.