diff --git a/modules/openapi-generator/src/main/resources/powershell/README.mustache b/modules/openapi-generator/src/main/resources/powershell/README.mustache index cf2074fd3aa..e8092a38a6b 100644 --- a/modules/openapi-generator/src/main/resources/powershell/README.mustache +++ b/modules/openapi-generator/src/main/resources/powershell/README.mustache @@ -16,14 +16,14 @@ This PowerShell module is automatically generated by the [OpenAPI Generator](htt For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}}) {{/infoUrl}} - + ## Frameworks supported - PowerShell {{{powershellVersion}}} or later - + ## Dependencies - + ## Installation {{#powershellGalleryUrl}} @@ -46,7 +46,7 @@ To uninstall the module, simply run: Remove-Module -FullyQualifiedName @{ModuleName = "{{{packageName}}}"; ModuleVersion = "{{{packageVersion}}}"} ``` - + ## Tests To install and run `Pester`, please execute the following commands in the terminal: @@ -78,18 +78,13 @@ Class | Method | HTTP request | Description No model defined in this package {{/modelPackage}} + ## Documentation for Authorization -{{^authMethods}} -All endpoints do not require authorization. -{{/authMethods}} +{{^authMethods}}Endpoints do not require authorization.{{/authMethods}} +{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}} {{#authMethods}} -{{#last}} -Authentication schemes defined for the API: -{{/last}} -{{/authMethods}} -{{#authMethods}} - + ### {{name}} {{#isApiKey}}- **Type**: API key diff --git a/modules/openapi-generator/src/main/resources/powershell/api_doc.mustache b/modules/openapi-generator/src/main/resources/powershell/api_doc.mustache index 0ebb80e2ce8..3c117aa5e08 100644 --- a/modules/openapi-generator/src/main/resources/powershell/api_doc.mustache +++ b/modules/openapi-generator/src/main/resources/powershell/api_doc.mustache @@ -10,7 +10,7 @@ Method | HTTP request | Description {{#operations}} {{#operation}} - + # **{{{vendorExtensions.x-powershell-method-name}}}** > {{{returnType}}}{{^returnType}}void{{/returnType}} {{{vendorExtensions.x-powershell-method-name}}}
{{#allParams}} diff --git a/samples/client/petstore/powershell/README.md b/samples/client/petstore/powershell/README.md index 90d3d906ba9..c86373f9af2 100644 --- a/samples/client/petstore/powershell/README.md +++ b/samples/client/petstore/powershell/README.md @@ -8,14 +8,14 @@ This PowerShell module is automatically generated by the [OpenAPI Generator](htt - SDK version: 0.1.2 - Build package: org.openapitools.codegen.languages.PowerShellClientCodegen - + ## Frameworks supported - PowerShell 5.0 or later - + ## Dependencies - + ## Installation To install from PowerShell Gallery (https://www.powershellgallery.com/packages/PSPetstore) @@ -36,7 +36,7 @@ To uninstall the module, simply run: Remove-Module -FullyQualifiedName @{ModuleName = "PSPetstore"; ModuleVersion = "0.1.2"} ``` - + ## Tests To install and run `Pester`, please execute the following commands in the terminal: @@ -174,9 +174,12 @@ Class | Method | HTTP request | Description - [PSPetstore/Model.Zebra](docs/Zebra.md) + ## Documentation for Authorization +Authentication schemes defined for the API: + ### petstore_auth @@ -187,7 +190,7 @@ Class | Method | HTTP request | Description - write:pets: modify pets in your account - read:pets: read your pets - + ### api_key - **Type**: API key @@ -195,7 +198,7 @@ Class | Method | HTTP request | Description - **API key parameter name**: api_key - **Location**: HTTP header - + ### api_key_query - **Type**: API key @@ -203,19 +206,19 @@ Class | Method | HTTP request | Description - **API key parameter name**: api_key_query - **Location**: URL query string - + ### http_basic_test - **Type**: HTTP basic authentication - + ### bearer_test - **Type**: HTTP basic authentication - + ### http_signature_test diff --git a/samples/client/petstore/powershell/docs/PSAnotherFakeApi.md b/samples/client/petstore/powershell/docs/PSAnotherFakeApi.md index ebdbaf3af0f..d08f2dfbd4c 100644 --- a/samples/client/petstore/powershell/docs/PSAnotherFakeApi.md +++ b/samples/client/petstore/powershell/docs/PSAnotherFakeApi.md @@ -7,7 +7,7 @@ Method | HTTP request | Description [**Invoke-PS123TestSpecialTags**](PSAnotherFakeApi.md#Invoke-PS123TestSpecialTags) | **PATCH** /another-fake/dummy | To test special tags - + # **Invoke-PS123TestSpecialTags** > Client Invoke-PS123TestSpecialTags
>         [-Client]
diff --git a/samples/client/petstore/powershell/docs/PSDefaultApi.md b/samples/client/petstore/powershell/docs/PSDefaultApi.md index bdcbdbc4443..4355b1aa78a 100644 --- a/samples/client/petstore/powershell/docs/PSDefaultApi.md +++ b/samples/client/petstore/powershell/docs/PSDefaultApi.md @@ -7,7 +7,7 @@ Method | HTTP request | Description [**Invoke-PSFooGet**](PSDefaultApi.md#Invoke-PSFooGet) | **GET** /foo | - + # **Invoke-PSFooGet** > FooGetDefaultResponse Invoke-PSFooGet
diff --git a/samples/client/petstore/powershell/docs/PSFakeApi.md b/samples/client/petstore/powershell/docs/PSFakeApi.md index 8f22dd6ca05..6770e880133 100644 --- a/samples/client/petstore/powershell/docs/PSFakeApi.md +++ b/samples/client/petstore/powershell/docs/PSFakeApi.md @@ -21,7 +21,7 @@ Method | HTTP request | Description [**Test-PSQueryParameterCollectionFormat**](PSFakeApi.md#Test-PSQueryParameterCollectionFormat) | **PUT** /fake/test-query-parameters | - + # **Invoke-PSFakeHealthGet** > HealthCheckResult Invoke-PSFakeHealthGet
@@ -57,7 +57,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Invoke-PSFakeOuterBooleanSerialize** > Boolean Invoke-PSFakeOuterBooleanSerialize
>         [-Body]
@@ -99,7 +99,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Invoke-PSFakeOuterCompositeSerialize** > OuterComposite Invoke-PSFakeOuterCompositeSerialize
>         [-OuterComposite]
@@ -141,7 +141,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Invoke-PSFakeOuterNumberSerialize** > Decimal Invoke-PSFakeOuterNumberSerialize
>         [-Body]
@@ -183,7 +183,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Invoke-PSFakeOuterStringSerialize** > String Invoke-PSFakeOuterStringSerialize
>         [-Body]
@@ -225,7 +225,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Get-PSArrayOfEnums** > OuterEnum[] Get-PSArrayOfEnums
@@ -261,7 +261,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Test-PSBodyWithFileSchema** > void Test-PSBodyWithFileSchema
>         [-FileSchemaTestClass]
@@ -304,7 +304,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Test-PSBodyWithQueryParams** > void Test-PSBodyWithQueryParams
>         [-Query]
@@ -347,7 +347,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Test-PSClientModel** > Client Test-PSClientModel
>         [-Client]
@@ -390,7 +390,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Test-PSEndpointParameters** > void Test-PSEndpointParameters
>         [-Number]
@@ -478,7 +478,7 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Test-PSEnumParameters** > void Test-PSEnumParameters
>         [-EnumHeaderStringArray]
@@ -542,7 +542,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Test-PSGroupParameters** > void Test-PSGroupParameters
>         [-RequiredStringGroup]
@@ -606,7 +606,7 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Test-PSInlineAdditionalProperties** > void Test-PSInlineAdditionalProperties
>         [-RequestBody]
@@ -649,7 +649,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Test-PSJsonFormData** > void Test-PSJsonFormData
>         [-Param]
@@ -695,7 +695,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Test-PSQueryParameterCollectionFormat** > void Test-PSQueryParameterCollectionFormat
>         [-Pipe]
diff --git a/samples/client/petstore/powershell/docs/PSFakeClassnameTags123Api.md b/samples/client/petstore/powershell/docs/PSFakeClassnameTags123Api.md index 5b775f25298..751f17b074b 100644 --- a/samples/client/petstore/powershell/docs/PSFakeClassnameTags123Api.md +++ b/samples/client/petstore/powershell/docs/PSFakeClassnameTags123Api.md @@ -7,7 +7,7 @@ Method | HTTP request | Description [**Test-PSClassname**](PSFakeClassnameTags123Api.md#Test-PSClassname) | **PATCH** /fake_classname_test | To test class name in snake case - + # **Test-PSClassname** > Client Test-PSClassname
>         [-Client]
diff --git a/samples/client/petstore/powershell/docs/PSPetApi.md b/samples/client/petstore/powershell/docs/PSPetApi.md index 848b9313f3d..4ff1c455a4a 100644 --- a/samples/client/petstore/powershell/docs/PSPetApi.md +++ b/samples/client/petstore/powershell/docs/PSPetApi.md @@ -15,7 +15,7 @@ Method | HTTP request | Description [**Invoke-PSUploadFileWithRequiredFile**](PSPetApi.md#Invoke-PSUploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - + # **Add-PSPet** > void Add-PSPet
>         [-Pet]
@@ -77,7 +77,7 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Remove-Pet** > void Remove-Pet
>         [-PetId]
@@ -128,7 +128,7 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Find-PSPetsByStatus** > Pet[] Find-PSPetsByStatus
>         [-Status]
@@ -188,7 +188,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Find-PSPetsByTags** > Pet[] Find-PSPetsByTags
>         [-Tags]
@@ -248,7 +248,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Get-PSPetById** > Pet Get-PSPetById
>         [-PetId]
@@ -298,7 +298,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Update-PSPet** > void Update-PSPet
>         [-Pet]
@@ -360,7 +360,7 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Update-PSPetWithForm** > void Update-PSPetWithForm
>         [-PetId]
@@ -414,7 +414,7 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Invoke-PSUploadFile** > ApiResponse Invoke-PSUploadFile
>         [-PetId]
@@ -468,7 +468,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Invoke-PSUploadFileWithRequiredFile** > ApiResponse Invoke-PSUploadFileWithRequiredFile
>         [-PetId]
diff --git a/samples/client/petstore/powershell/docs/PSStoreApi.md b/samples/client/petstore/powershell/docs/PSStoreApi.md index 17c85035463..3702bf824de 100644 --- a/samples/client/petstore/powershell/docs/PSStoreApi.md +++ b/samples/client/petstore/powershell/docs/PSStoreApi.md @@ -10,7 +10,7 @@ Method | HTTP request | Description [**Invoke-PSPlaceOrder**](PSStoreApi.md#Invoke-PSPlaceOrder) | **POST** /store/order | Place an order for a pet - + # **Remove-PSOrder** > void Remove-PSOrder
>         [-OrderId]
@@ -53,7 +53,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Get-PSInventory** > System.Collections.Hashtable Get-PSInventory
@@ -98,7 +98,7 @@ This endpoint does not need any parameter. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Get-PSOrderById** > Order Get-PSOrderById
>         [-OrderId]
@@ -141,7 +141,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Invoke-PSPlaceOrder** > Order Invoke-PSPlaceOrder
>         [-Order]
diff --git a/samples/client/petstore/powershell/docs/PSUserApi.md b/samples/client/petstore/powershell/docs/PSUserApi.md index 567ad509851..8af0f02fe3c 100644 --- a/samples/client/petstore/powershell/docs/PSUserApi.md +++ b/samples/client/petstore/powershell/docs/PSUserApi.md @@ -14,7 +14,7 @@ Method | HTTP request | Description [**Update-PSUser**](PSUserApi.md#Update-PSUser) | **PUT** /user/{username} | Updated user - + # **New-PSUser** > void New-PSUser
>         [-User]
@@ -57,7 +57,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **New-PSUsersWithArrayInput** > void New-PSUsersWithArrayInput
>         [-User]
@@ -100,7 +100,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **New-PSUsersWithListInput** > void New-PSUsersWithListInput
>         [-User]
@@ -143,7 +143,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Remove-PSUser** > void Remove-PSUser
>         [-Username]
@@ -186,7 +186,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Get-PSUserByName** > User Get-PSUserByName
>         [-Username]
@@ -229,7 +229,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Invoke-PSLoginUser** > String Invoke-PSLoginUser
>         [-Username]
@@ -275,7 +275,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Invoke-PSLogoutUser** > void Invoke-PSLogoutUser
@@ -313,7 +313,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - + # **Update-PSUser** > void Update-PSUser
>         [-Username]