openapi-generator/docs/generators/bash.md

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

FEATURE SET

Client Modification Feature

Name	Supported	Defined By
BasePath	✗	ToolingExtension
Authorizations	✗	ToolingExtension
UserAgent	✗	ToolingExtension

Data Type Feature

Name	Supported	Defined By
Custom	✗	OAS2,OAS3
Int32	✓	OAS2,OAS3
Int64	✓	OAS2,OAS3
Float	✓	OAS2,OAS3
Double	✓	OAS2,OAS3
Decimal	✓	ToolingExtension
String	✓	OAS2,OAS3
Byte	✓	OAS2,OAS3
Binary	✓	OAS2,OAS3
Boolean	✓	OAS2,OAS3
Date	✓	OAS2,OAS3
DateTime	✓	OAS2,OAS3
Password	✓	OAS2,OAS3
File	✓	OAS2
Array	✓	OAS2,OAS3
Maps	✓	ToolingExtension
CollectionFormat	✓	OAS2
CollectionFormatMulti	✓	OAS2
Enum	✓	OAS2,OAS3
ArrayOfEnum	✓	ToolingExtension
ArrayOfModel	✓	ToolingExtension
ArrayOfCollectionOfPrimitives	✓	ToolingExtension
ArrayOfCollectionOfModel	✓	ToolingExtension
ArrayOfCollectionOfEnum	✓	ToolingExtension
MapOfEnum	✓	ToolingExtension
MapOfModel	✓	ToolingExtension
MapOfCollectionOfPrimitives	✓	ToolingExtension
MapOfCollectionOfModel	✓	ToolingExtension
MapOfCollectionOfEnum	✓	ToolingExtension

Documentation Feature

Name	Supported	Defined By
Readme	✓	ToolingExtension
Model	✗	ToolingExtension
Api	✗	ToolingExtension

Global Feature

Name	Supported	Defined By
Host	✓	OAS2,OAS3
BasePath	✓	OAS2,OAS3
Info	✓	OAS2,OAS3
Schemes	✗	OAS2,OAS3
PartialSchemes	✓	OAS2,OAS3
Consumes	✓	OAS2
Produces	✓	OAS2
ExternalDocumentation	✓	OAS2,OAS3
Examples	✓	OAS2,OAS3
XMLStructureDefinitions	✗	OAS2,OAS3
MultiServer	✗	OAS3
ParameterizedServer	✗	OAS3
ParameterStyling	✗	OAS3
Callbacks	✓	OAS3
LinkObjects	✗	OAS3

Parameter Feature

Name	Supported	Defined By
Path	✓	OAS2,OAS3
Query	✓	OAS2,OAS3
Header	✓	OAS2,OAS3
Body	✓	OAS2
FormUnencoded	✓	OAS2
FormMultipart	✓	OAS2
Cookie	✓	OAS3

Schema Support Feature

Name	Supported	Defined By
Simple	✓	OAS2,OAS3
Composite	✓	OAS2,OAS3
Polymorphism	✗	OAS2,OAS3
Union	✗	OAS3

Security Feature

Name	Supported	Defined By
BasicAuth	✓	OAS2,OAS3
ApiKey	✓	OAS2,OAS3
OpenIDConnect	✗	OAS3
BearerToken	✓	OAS3
OAuth2_Implicit	✓	OAS2,OAS3
OAuth2_Password	✗	OAS2,OAS3
OAuth2_ClientCredentials	✗	OAS2,OAS3
OAuth2_AuthorizationCode	✗	OAS2,OAS3

Wire Format Feature

Name	Supported	Defined By
JSON	✓	OAS2,OAS3
XML	✓	OAS2,OAS3
PROTOBUF	✗	ToolingExtension
Custom	✓	OAS2,OAS3