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

2.7 KiB

title sidebar_label
Config Options for bash bash
Option Description Values Default
allowUnicodeIdentifiers boolean, toggles whether unicode identifiers are allowed in names or not, default is false false
apiKeyAuthEnvironmentVariable Name of environment variable where API key can be defined (e.g. PETSTORE_APIKEY='kjhasdGASDa5asdASD') false
basicAuthEnvironmentVariable Name of environment variable where username and password can be defined (e.g. PETSTORE_CREDS='username:password') null
curlOptions Default cURL options null
ensureUniqueParams Whether to ensure parameter names are unique in an operation (rename parameters that are not). true
generateBashCompletion Whether to generate the Bash completion script false
generateZshCompletion Whether to generate the Zsh completion script false
hostEnvironmentVariable Name of environment variable where host can be defined (e.g. PETSTORE_HOST='http://api.openapitools.org:8080') null
prependFormOrBodyParameters Add form or body parameters to the beginning of the parameter list. false
processMarkdown Convert all Markdown Markup into terminal formatting false
scriptName The name of the script that will be generated (e.g. petstore-cli) 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

IMPORT MAPPING

Type/Alias Imports
Array java.util.List
ArrayList java.util.ArrayList
BigDecimal java.math.BigDecimal
Date java.util.Date
DateTime org.joda.time.*
File java.io.File
HashMap java.util.HashMap
List java.util.*
LocalDate org.joda.time.*
LocalDateTime org.joda.time.*
LocalTime org.joda.time.*
Map java.util.Map
Set java.util.*
Timestamp java.sql.Timestamp
URI java.net.URI
UUID java.util.UUID

INSTANTIATION TYPES

Type/Alias Instantiated By

LANGUAGE PRIMITIVES

  • array
  • binary
  • boolean
  • float
  • integer
  • map
  • string

RESERVED WORDS

  • case
  • do
  • done
  • elif
  • else
  • esac
  • fi
  • for
  • function
  • if
  • in
  • select
  • then
  • time
  • until
  • while