Skip to content

Commit

Permalink
[Sttp] SeparateErrorChannel is true by default
Browse files Browse the repository at this point in the history
  • Loading branch information
ghostbuster91 committed Jun 16, 2020
1 parent 4a5ff27 commit e2df636
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/generators/scala-sttp.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sidebar_label: scala-sttp
|json4sVersion|Only if jsonLibrary was set to json4s. Allows to override default json4s version.|3.6.8
|circeVersion|Only if jsonLibrary was set to circe. Allows to override default circe version.|0.13.0
|jsonLibrary|Option. Json library to use|<dl><dt>**json4s**</dt>https://github.com/json4s/json4s<dt>**circe**</dt><dd>https://github.com/circe/circe</dd></dl>|json4s|
|separateErrorChannel| Option. Whether to return response as `F[Either[ResponseError[ErrorType], ReturnType]]]` or to flatten response's error raising them through enclosing monad (`F[ReturnType]`).|false
|separateErrorChannel| Option. Whether to return response as `F[Either[ResponseError[ErrorType], ReturnType]]]` or to flatten response's error raising them through enclosing monad (`F[ReturnType]`).|true
|disallowAdditionalPropertiesIfNotPresent|Specify the behavior when the 'additionalProperties' keyword is not present in the OAS document. If false: the 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications. If true: when the 'additionalProperties' keyword is not present in a schema, the value of 'additionalProperties' is set to false, i.e. no additional properties are allowed. Note: this mode is not compliant with the JSON schema specification. This is the original openapi-generator behavior.This setting is currently ignored for OAS 2.0 documents: 1) When the 'additionalProperties' keyword is not present in a 2.0 schema, additional properties are NOT allowed. 2) Boolean values of the 'additionalProperties' keyword are ignored. It's as if additional properties are NOT allowed.Note: the root cause are issues #1369 and #1371, which must be resolved in the swagger-parser project.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>when the 'additionalProperties' keyword is not present in a schema, the value of 'additionalProperties' is automatically set to false, i.e. no additional properties are allowed. Note: this mode is not compliant with the JSON schema specification. This is the original openapi-generator behavior.</dd></dl>|true|
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|legacyDiscriminatorBehavior|This flag is used by OpenAPITools codegen to influence the processing of the discriminator attribute in OpenAPI documents. This flag has no impact if the OAS document does not use the discriminator attribute. The default value of this flag is set in each language-specific code generator (e.g. Python, Java, go...)using the method toModelName. Note to developers supporting a language generator in OpenAPITools; to fully support the discriminator attribute as defined in the OAS specification 3.x, language generators should set this flag to true by default; however this requires updating the mustache templates to generate a language-specific discriminator lookup function that iterates over {{#mappedModels}} and does not iterate over {{children}}, {{#anyOf}}, or {{#oneOf}}.|<dl><dt>**true**</dt><dd>The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.</dd><dt>**false**</dt><dd>The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.</dd></dl>|true|
Expand Down

0 comments on commit e2df636

Please sign in to comment.