update dart jaguar doc

This commit is contained in:
William Cheng 2019-03-27 16:32:35 +08:00
parent 7ab73ff587
commit 0f99cd0d37

View File

@ -1,43 +1,22 @@
CONFIG OPTIONS for dart-jaguar
---
id: generator-opts-client-dart-jaguar
title: Config Options for dart-jaguar
sidebar_label: dart-jaguar
---
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
browserClient
Is the client browser based
pubName
Name in generated pubspec
pubVersion
Version in generated pubspec
pubDescription
Description in generated pubspec
useEnumExtension
Allow the 'x-enum-values' extension for enums
sourceFolder
source folder for generated code
supportDart2
support dart2 (Default: true)
nullableFields
Is the null fields should be in the JSON payload
serialization
Choose serialization format JSON or PROTO is supported
Back to the [generators list](README.md)
| Option | Description | Values | Default |
| ------ | ----------- | ------ | ------- |
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|browserClient|Is the client browser based| |null|
|pubName|Name in generated pubspec| |null|
|pubVersion|Version in generated pubspec| |null|
|pubDescription|Description in generated pubspec| |null|
|useEnumExtension|Allow the 'x-enum-values' extension for enums| |null|
|sourceFolder|source folder for generated code| |null|
|supportDart2|support dart2| |true|
|nullableFields|Is the null fields should be in the JSON payload| |null|
|serialization|Choose serialization format JSON or PROTO is supported| |null|