Skip to main content

Documentation for the powershell Generator

METADATA

PropertyValueNotes
generator namepowershellpass this to the generate command after -g
generator stabilityBETA
generator typeCLIENT
generator languagePowerShell
generator default templating enginemustache
helpTxtGenerates a PowerShell API client (beta)

CONFIG OPTIONS

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

OptionDescriptionValuesDefault
apiNamePrefixPrefix that will be appended to all PS objects. Default: empty string. e.g. Pet => PSPet.null
commonVerbsPS common verb mappings. e.g. Delete=Remove:Patch=Update to map Delete with Remove and Patch with Update accordingly.null
disallowAdditionalPropertiesIfNotPresentIf false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
false
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
true
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
true
discardReadOnlySet discardReadonly to true to generate the Initialize cmdlet without readonly parametersnull
iconUriA URL to an icon representing the generated PowerShell modulenull
licenseUriA URL to the license for the generated PowerShell modulenull
modelsCmdletVerbVerb to be used when generating the Models cmdlets in the examples.Initialize
packageGuidGUID for PowerShell module (e.g. a27b908d-2a20-467f-bc32-af6f3a654ac5). A random GUID will be generated by default.null
packageNameClient package name (e.g. PSTwitter).PSOpenAPITools
packageVersionPackage version (e.g. 0.1.2).0.1.2
powershellGalleryUrlURL to the module in PowerShell Gallery (e.g. https://www.powershellgallery.com/packages/PSTwitter/).null
projectUriA URL to the main website for this projectnull
releaseNotesRelease notes of the generated PowerShell modulenull
skipVerbParsingSet skipVerbParsing to not try get powershell verbs of operation namesnull
tagsTags applied to the generated PowerShell module. These help with module discovery in online galleriesnull
useClassNameInModelsExamplesUse classname instead of name when generating the Models cmdlets in the examples.true
useOneOfDiscriminatorLookupUse the discriminator's mapping in oneOf to speed up the model lookup. IMPORTANT: Validation (e.g. one and only one match in oneOf's schemas) will be skipped.null

IMPORT MAPPING

Type/AliasImports

INSTANTIATION TYPES

Type/AliasInstantiated 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

NameSupportedDefined By
BasePathToolingExtension
AuthorizationsToolingExtension
UserAgentToolingExtension
MockServerToolingExtension

Data Type Feature

NameSupportedDefined By
CustomOAS2,OAS3
Int32OAS2,OAS3
Int64OAS2,OAS3
FloatOAS2,OAS3
DoubleOAS2,OAS3
DecimalToolingExtension
StringOAS2,OAS3
ByteOAS2,OAS3
BinaryOAS2,OAS3
BooleanOAS2,OAS3
DateOAS2,OAS3
DateTimeOAS2,OAS3
PasswordOAS2,OAS3
FileOAS2
Uuid
ArrayOAS2,OAS3
NullOAS3
AnyTypeOAS2,OAS3
ObjectOAS2,OAS3
MapsToolingExtension
CollectionFormatOAS2
CollectionFormatMultiOAS2
EnumOAS2,OAS3
ArrayOfEnumToolingExtension
ArrayOfModelToolingExtension
ArrayOfCollectionOfPrimitivesToolingExtension
ArrayOfCollectionOfModelToolingExtension
ArrayOfCollectionOfEnumToolingExtension
MapOfEnumToolingExtension
MapOfModelToolingExtension
MapOfCollectionOfPrimitivesToolingExtension
MapOfCollectionOfModelToolingExtension
MapOfCollectionOfEnumToolingExtension

Documentation Feature

NameSupportedDefined By
ReadmeToolingExtension
ModelToolingExtension
ApiToolingExtension

Global Feature

NameSupportedDefined By
HostOAS2,OAS3
BasePathOAS2,OAS3
InfoOAS2,OAS3
SchemesOAS2,OAS3
PartialSchemesOAS2,OAS3
ConsumesOAS2
ProducesOAS2
ExternalDocumentationOAS2,OAS3
ExamplesOAS2,OAS3
XMLStructureDefinitionsOAS2,OAS3
MultiServerOAS3
ParameterizedServerOAS3
ParameterStylingOAS3
CallbacksOAS3
LinkObjectsOAS3

Parameter Feature

NameSupportedDefined By
PathOAS2,OAS3
QueryOAS2,OAS3
HeaderOAS2,OAS3
BodyOAS2
FormUnencodedOAS2
FormMultipartOAS2
CookieOAS3

Schema Support Feature

NameSupportedDefined By
SimpleOAS2,OAS3
CompositeOAS2,OAS3
PolymorphismOAS2,OAS3
UnionOAS3
allOfOAS2,OAS3
anyOfOAS3
oneOfOAS3
notOAS3

Security Feature

NameSupportedDefined By
BasicAuthOAS2,OAS3
ApiKeyOAS2,OAS3
OpenIDConnectOAS3
BearerTokenOAS3
OAuth2_ImplicitOAS2,OAS3
OAuth2_PasswordOAS2,OAS3
OAuth2_ClientCredentialsOAS2,OAS3
OAuth2_AuthorizationCodeOAS2,OAS3
SignatureAuthOAS3
AWSV4SignatureToolingExtension

Wire Format Feature

NameSupportedDefined By
JSONOAS2,OAS3
XMLOAS2,OAS3
PROTOBUFToolingExtension
CustomOAS2,OAS3