forked from loafle/openapi-generator-original
644f720db8
* [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
125 lines
3.4 KiB
Markdown
125 lines
3.4 KiB
Markdown
---
|
|
title: Config Options for dart-dio
|
|
sidebar_label: dart-dio
|
|
---
|
|
|
|
| Option | Description | Values | Default |
|
|
| ------ | ----------- | ------ | ------- |
|
|
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
|
|browserClient|Is the client browser based (for Dart 1.x only)| |null|
|
|
|dateLibrary|Option. Date library to use|<dl><dt>**core**</dt><dd>Dart core library (DateTime)</dd><dt>**timemachine**</dt><dd>Time Machine is date and time library for Flutter, Web, and Server with support for timezones, calendars, cultures, formatting and parsing.</dd><dl>|core|
|
|
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
|
|nullableFields|Is the null fields should be in the JSON payload| |null|
|
|
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
|
|pubAuthor|Author name in generated pubspec| |null|
|
|
|pubAuthorEmail|Email address of the author in generated pubspec| |null|
|
|
|pubDescription|Description in generated pubspec| |null|
|
|
|pubHomepage|Homepage in generated pubspec| |null|
|
|
|pubName|Name in generated pubspec| |null|
|
|
|pubVersion|Version in generated pubspec| |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|
|
|
|sourceFolder|Source folder for generated code| |null|
|
|
|supportDart2|Support Dart 2.x (Dart 1.x support has been deprecated)| |true|
|
|
|useEnumExtension|Allow the 'x-enum-values' extension for enums| |null|
|
|
|
|
## IMPORT MAPPING
|
|
|
|
| Type/Alias | Imports |
|
|
| ---------- | ------- |
|
|
|BuiltList|package:built_collection/built_collection.dart|
|
|
|BuiltMap|package:built_collection/built_collection.dart|
|
|
|JsonObject|package:built_value/json_object.dart|
|
|
|Uint8List|dart:typed_data|
|
|
|
|
|
|
## INSTANTIATION TYPES
|
|
|
|
| Type/Alias | Instantiated By |
|
|
| ---------- | --------------- |
|
|
|array|List|
|
|
|map|Map|
|
|
|
|
|
|
## LANGUAGE PRIMITIVES
|
|
|
|
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>String</li>
|
|
<li>bool</li>
|
|
<li>double</li>
|
|
<li>int</li>
|
|
<li>num</li>
|
|
</ul>
|
|
|
|
## RESERVED WORDS
|
|
|
|
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abstract</li>
|
|
<li>as</li>
|
|
<li>assert</li>
|
|
<li>async</li>
|
|
<li>await</li>
|
|
<li>break</li>
|
|
<li>case</li>
|
|
<li>catch</li>
|
|
<li>class</li>
|
|
<li>const</li>
|
|
<li>continue</li>
|
|
<li>covariant</li>
|
|
<li>default</li>
|
|
<li>deferred</li>
|
|
<li>do</li>
|
|
<li>dynamic</li>
|
|
<li>else</li>
|
|
<li>enum</li>
|
|
<li>export</li>
|
|
<li>extends</li>
|
|
<li>extension</li>
|
|
<li>external</li>
|
|
<li>factory</li>
|
|
<li>false</li>
|
|
<li>final</li>
|
|
<li>finally</li>
|
|
<li>for</li>
|
|
<li>function</li>
|
|
<li>get</li>
|
|
<li>hide</li>
|
|
<li>if</li>
|
|
<li>implements</li>
|
|
<li>import</li>
|
|
<li>in</li>
|
|
<li>inout</li>
|
|
<li>interface</li>
|
|
<li>is</li>
|
|
<li>late</li>
|
|
<li>library</li>
|
|
<li>mixin</li>
|
|
<li>native</li>
|
|
<li>new</li>
|
|
<li>null</li>
|
|
<li>of</li>
|
|
<li>on</li>
|
|
<li>operator</li>
|
|
<li>out</li>
|
|
<li>part</li>
|
|
<li>patch</li>
|
|
<li>required</li>
|
|
<li>rethrow</li>
|
|
<li>return</li>
|
|
<li>set</li>
|
|
<li>show</li>
|
|
<li>source</li>
|
|
<li>static</li>
|
|
<li>super</li>
|
|
<li>switch</li>
|
|
<li>sync</li>
|
|
<li>this</li>
|
|
<li>throw</li>
|
|
<li>true</li>
|
|
<li>try</li>
|
|
<li>typedef</li>
|
|
<li>var</li>
|
|
<li>void</li>
|
|
<li>while</li>
|
|
<li>with</li>
|
|
<li>yield</li>
|
|
</ul>
|