valitydev/openapi-generator
14
0
Fork 0
mirror of https://github.com/valitydev/openapi-generator.git synced 2024-11-06 18:45:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
e27700cfee
openapi-generator/docs/generators/dart-dio.md
Jim Schubert 644f720db8
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) 
* [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
2020-01-19 20:19:11 -05:00

3.4 KiB
Raw Blame History

title sidebar_label
Config Options for dart-dio 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
core
Dart core library (DateTime)
timemachine
Time Machine is date and time library for Flutter, Web, and Server with support for timezones, calendars, cultures, formatting and parsing.
 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

  • String
  • bool
  • double
  • int
  • num

RESERVED WORDS

  • abstract
  • as
  • assert
  • async
  • await
  • break
  • case
  • catch
  • class
  • const
  • continue
  • covariant
  • default
  • deferred
  • do
  • dynamic
  • else
  • enum
  • export
  • extends
  • extension
  • external
  • factory
  • false
  • final
  • finally
  • for
  • function
  • get
  • hide
  • if
  • implements
  • import
  • in
  • inout
  • interface
  • is
  • late
  • library
  • mixin
  • native
  • new
  • null
  • of
  • on
  • operator
  • out
  • part
  • patch
  • required
  • rethrow
  • return
  • set
  • show
  • source
  • static
  • super
  • switch
  • sync
  • this
  • throw
  • true
  • try
  • typedef
  • var
  • void
  • while
  • with
  • yield