openapi-generator/docs/generators/powershell.md

title	sidebar_label
Config Options for powershell	powershell

These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

Option	Description	Values	Default
apiNamePrefix	Prefix that will be appended to all PS objects. Default: empty string. e.g. Pet => PSPet.		null
commonVerbs	PS common verb mappings. e.g. Delete=Remove:Patch=Update to map Delete with Remove and Patch with Update accordingly.		null
disallowAdditionalPropertiesIfNotPresent	Specify the behavior when the 'additionalProperties' keyword is not present in the OAS document. If false: the 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications. If true: when the 'additionalProperties' keyword is not present in a schema, the value of 'additionalProperties' is set to false, i.e. no additional properties are allowed. Note: this mode is not compliant with the JSON schema specification. This is the original openapi-generator behavior.This setting is currently ignored for OAS 2.0 documents: 1) When the 'additionalProperties' keyword is not present in a 2.0 schema, additional properties are NOT allowed. 2) Boolean values of the 'additionalProperties' keyword are ignored. It's as if additional properties are NOT allowed.Note: the root cause are issues #1369 and #1371, which must be resolved in the swagger-parser project.	false The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications. true when the 'additionalProperties' keyword is not present in a schema, the value of 'additionalProperties' is automatically set to false, i.e. no additional properties are allowed. Note: this mode is not compliant with the JSON schema specification. This is the original openapi-generator behavior.	true
discardReadOnly	Set discardReadonly to true to generate the Initialize cmdlet without readonly parameters		null
packageGuid	GUID for PowerShell module (e.g. a27b908d-2a20-467f-bc32-af6f3a654ac5). A random GUID will be generated by default.		null
packageName	Client package name (e.g. PSTwitter).		PSOpenAPITools
packageVersion	Package version (e.g. 0.1.2).		0.1.2
powershellGalleryUrl	URL to the module in PowerShell Gallery (e.g. https://www.powershellgallery.com/packages/PSTwitter/).		null
useOneOfDiscriminatorLookup	Use the discriminator's mapping in oneOf to speed up the model lookup. IMPORTANT: Validation (e.g. one and onlye one match in oneOf's schemas) will be skipped.		null

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
LinkedHashSet	java.util.LinkedHashSet
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

• Boolean
• Byte
• Byte[]
• Char
• Decimal
• Double
• Guid
• Int16
• Int32
• Int64
• ProgressRecord
• SByte
• SecureString
• Single
• String
• System.DateTime
• System.IO.FileInfo
• TimeSpan
• UInt16
• UInt32
• UInt64
• Uri
• Version
• XmlDocument

RESERVED WORDS

• args
• begin
• break
• catch
• consolefilename
• continue
• data
• do
• dynamicparam
• else
• elseif
• end
• error
• event
• eventargs
• eventsubscriber
• executioncontext
• exit
• false
• filter
• finally
• for
• foreach
• from
• function
• home
• host
• if
• in
• input
• lastexitcode
• local
• matches
• myinvocation
• nestedpromptlevel
• null
• param
• pid
• private
• process
• profile
• pscmdlet
• pscommandpath
• psculture
• psdebugcontext
• pshome
• psitem
• psscriptroot
• pssenderinfo
• psuiculture
• psversiontable
• return
• sender
• shellid
• stacktrace
• switch
• this
• throw
• trap
• true
• try
• until
• where
• while

FEATURE SET

Client Modification Feature

Name	Supported	Defined By
BasePath	✗	ToolingExtension
Authorizations	✗	ToolingExtension
UserAgent	✗	ToolingExtension
MockServer	✗	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