loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

[powershell] cleanup documentation (#15355)

Browse Source 
* [powershell] fix documentation of API authorization in README files

fix hierarchy level + add internal links + align wording across generators

* [powershell] fix anchor links in documentation
This commit is contained in:
Tiffany Marrel 2023-05-09 08:21:09 +02:00 committed by GitHub
parent 2b19d5f94d
commit be651e7776
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 60 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
modules/openapi-generator/src/main/resources/powershell/README.mustache vendored
View File

@ -16,14 +16,14 @@ This PowerShell module is automatically generated by the [OpenAPI Generator](htt
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}}) For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
{{/infoUrl}} {{/infoUrl}}
<a name="frameworks-supported"></a> <a id="frameworks-supported"></a>
## Frameworks supported ## Frameworks supported
- PowerShell {{{powershellVersion}}} or later - PowerShell {{{powershellVersion}}} or later
<a name="dependencies"></a> <a id="dependencies"></a>
## Dependencies ## Dependencies
<a name="installation"></a> <a id="installation"></a>
## Installation ## Installation
{{#powershellGalleryUrl}} {{#powershellGalleryUrl}}
@ -46,7 +46,7 @@ To uninstall the module, simply run:
Remove-Module -FullyQualifiedName @{ModuleName = "{{{packageName}}}"; ModuleVersion = "{{{packageVersion}}}"} Remove-Module -FullyQualifiedName @{ModuleName = "{{{packageName}}}"; ModuleVersion = "{{{packageVersion}}}"}
``` ```
<a name="tests"></a> <a id="tests"></a>
## Tests ## Tests
To install and run `Pester`, please execute the following commands in the terminal: 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 No model defined in this package
{{/modelPackage}} {{/modelPackage}}
<a id="documentation-for-authorization"></a>
## Documentation for Authorization ## Documentation for Authorization
{{^authMethods}} {{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
All endpoints do not require authorization. {{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
{{/authMethods}}
{{#authMethods}} {{#authMethods}}
{{#last}} <a id="{{name}}"></a>
Authentication schemes defined for the API:
{{/last}}
{{/authMethods}}
{{#authMethods}}
### {{name}} ### {{name}}
{{#isApiKey}}- **Type**: API key {{#isApiKey}}- **Type**: API key

2
modules/openapi-generator/src/main/resources/powershell/api_doc.mustache vendored
View File

@ -10,7 +10,7 @@ Method | HTTP request | Description
{{#operations}} {{#operations}}
{{#operation}} {{#operation}}
<a name="{{{vendorExtensions.x-powershell-method-name-lowercase}}}"></a> <a id="{{{vendorExtensions.x-powershell-method-name-lowercase}}}"></a>
# **{{{vendorExtensions.x-powershell-method-name}}}** # **{{{vendorExtensions.x-powershell-method-name}}}**
> {{{returnType}}}{{^returnType}}void{{/returnType}} {{{vendorExtensions.x-powershell-method-name}}}<br> > {{{returnType}}}{{^returnType}}void{{/returnType}} {{{vendorExtensions.x-powershell-method-name}}}<br>
{{#allParams}} {{#allParams}}

21
samples/client/petstore/powershell/README.md
View File

@ -8,14 +8,14 @@ This PowerShell module is automatically generated by the [OpenAPI Generator](htt
- SDK version: 0.1.2 - SDK version: 0.1.2
- Build package: org.openapitools.codegen.languages.PowerShellClientCodegen - Build package: org.openapitools.codegen.languages.PowerShellClientCodegen
<a name="frameworks-supported"></a> <a id="frameworks-supported"></a>
## Frameworks supported ## Frameworks supported
- PowerShell 5.0 or later - PowerShell 5.0 or later
<a name="dependencies"></a> <a id="dependencies"></a>
## Dependencies ## Dependencies
<a name="installation"></a> <a id="installation"></a>
## Installation ## Installation
To install from PowerShell Gallery (https://www.powershellgallery.com/packages/PSPetstore) 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"} Remove-Module -FullyQualifiedName @{ModuleName = "PSPetstore"; ModuleVersion = "0.1.2"}
``` ```
<a name="tests"></a> <a id="tests"></a>
## Tests ## Tests
To install and run `Pester`, please execute the following commands in the terminal: 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) - [PSPetstore/Model.Zebra](docs/Zebra.md)
<a id="documentation-for-authorization"></a>
## Documentation for Authorization ## Documentation for Authorization
Authentication schemes defined for the API:
<a id="petstore_auth"></a>
### petstore_auth ### petstore_auth
@ -187,7 +190,7 @@ Class | Method | HTTP request | Description
- write:pets: modify pets in your account - write:pets: modify pets in your account
- read:pets: read your pets - read:pets: read your pets
<a id="api_key"></a>
### api_key ### api_key
- **Type**: API key - **Type**: API key
@ -195,7 +198,7 @@ Class | Method | HTTP request | Description
- **API key parameter name**: api_key - **API key parameter name**: api_key
- **Location**: HTTP header - **Location**: HTTP header
<a id="api_key_query"></a>
### api_key_query ### api_key_query
- **Type**: API key - **Type**: API key
@ -203,19 +206,19 @@ Class | Method | HTTP request | Description
- **API key parameter name**: api_key_query - **API key parameter name**: api_key_query
- **Location**: URL query string - **Location**: URL query string
<a id="http_basic_test"></a>
### http_basic_test ### http_basic_test
- **Type**: HTTP basic authentication - **Type**: HTTP basic authentication
<a id="bearer_test"></a>
### bearer_test ### bearer_test
- **Type**: HTTP basic authentication - **Type**: HTTP basic authentication
<a id="http_signature_test"></a>
### http_signature_test ### http_signature_test

2
samples/client/petstore/powershell/docs/PSAnotherFakeApi.md
View File

@ -7,7 +7,7 @@ Method | HTTP request | Description
[**Invoke-PS123TestSpecialTags**](PSAnotherFakeApi.md#Invoke-PS123TestSpecialTags) | **PATCH** /another-fake/dummy | To test special tags [**Invoke-PS123TestSpecialTags**](PSAnotherFakeApi.md#Invoke-PS123TestSpecialTags) | **PATCH** /another-fake/dummy | To test special tags
<a name="Invoke-PS123TestSpecialTags"></a> <a id="Invoke-PS123TestSpecialTags"></a>
# **Invoke-PS123TestSpecialTags** # **Invoke-PS123TestSpecialTags**
> Client Invoke-PS123TestSpecialTags<br> > Client Invoke-PS123TestSpecialTags<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Client] <PSCustomObject><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Client] <PSCustomObject><br>

2
samples/client/petstore/powershell/docs/PSDefaultApi.md
View File

@ -7,7 +7,7 @@ Method | HTTP request | Description
[**Invoke-PSFooGet**](PSDefaultApi.md#Invoke-PSFooGet) | **GET** /foo | [**Invoke-PSFooGet**](PSDefaultApi.md#Invoke-PSFooGet) | **GET** /foo |
<a name="Invoke-PSFooGet"></a> <a id="Invoke-PSFooGet"></a>
# **Invoke-PSFooGet** # **Invoke-PSFooGet**
> FooGetDefaultResponse Invoke-PSFooGet<br> > FooGetDefaultResponse Invoke-PSFooGet<br>

30
samples/client/petstore/powershell/docs/PSFakeApi.md
View File

@ -21,7 +21,7 @@ Method | HTTP request | Description
[**Test-PSQueryParameterCollectionFormat**](PSFakeApi.md#Test-PSQueryParameterCollectionFormat) | **PUT** /fake/test-query-parameters | [**Test-PSQueryParameterCollectionFormat**](PSFakeApi.md#Test-PSQueryParameterCollectionFormat) | **PUT** /fake/test-query-parameters |
<a name="Invoke-PSFakeHealthGet"></a> <a id="Invoke-PSFakeHealthGet"></a>
# **Invoke-PSFakeHealthGet** # **Invoke-PSFakeHealthGet**
> HealthCheckResult Invoke-PSFakeHealthGet<br> > HealthCheckResult Invoke-PSFakeHealthGet<br>
@ -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) [[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)
<a name="Invoke-PSFakeOuterBooleanSerialize"></a> <a id="Invoke-PSFakeOuterBooleanSerialize"></a>
# **Invoke-PSFakeOuterBooleanSerialize** # **Invoke-PSFakeOuterBooleanSerialize**
> Boolean Invoke-PSFakeOuterBooleanSerialize<br> > Boolean Invoke-PSFakeOuterBooleanSerialize<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Body] <System.Nullable[Boolean]><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Body] <System.Nullable[Boolean]><br>
@ -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) [[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)
<a name="Invoke-PSFakeOuterCompositeSerialize"></a> <a id="Invoke-PSFakeOuterCompositeSerialize"></a>
# **Invoke-PSFakeOuterCompositeSerialize** # **Invoke-PSFakeOuterCompositeSerialize**
> OuterComposite Invoke-PSFakeOuterCompositeSerialize<br> > OuterComposite Invoke-PSFakeOuterCompositeSerialize<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-OuterComposite] <PSCustomObject><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-OuterComposite] <PSCustomObject><br>
@ -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) [[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)
<a name="Invoke-PSFakeOuterNumberSerialize"></a> <a id="Invoke-PSFakeOuterNumberSerialize"></a>
# **Invoke-PSFakeOuterNumberSerialize** # **Invoke-PSFakeOuterNumberSerialize**
> Decimal Invoke-PSFakeOuterNumberSerialize<br> > Decimal Invoke-PSFakeOuterNumberSerialize<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Body] <System.Nullable[Decimal]><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Body] <System.Nullable[Decimal]><br>
@ -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) [[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)
<a name="Invoke-PSFakeOuterStringSerialize"></a> <a id="Invoke-PSFakeOuterStringSerialize"></a>
# **Invoke-PSFakeOuterStringSerialize** # **Invoke-PSFakeOuterStringSerialize**
> String Invoke-PSFakeOuterStringSerialize<br> > String Invoke-PSFakeOuterStringSerialize<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Body] <String><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Body] <String><br>
@ -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) [[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)
<a name="Get-PSArrayOfEnums"></a> <a id="Get-PSArrayOfEnums"></a>
# **Get-PSArrayOfEnums** # **Get-PSArrayOfEnums**
> OuterEnum[] Get-PSArrayOfEnums<br> > OuterEnum[] Get-PSArrayOfEnums<br>
@ -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) [[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)
<a name="Test-PSBodyWithFileSchema"></a> <a id="Test-PSBodyWithFileSchema"></a>
# **Test-PSBodyWithFileSchema** # **Test-PSBodyWithFileSchema**
> void Test-PSBodyWithFileSchema<br> > void Test-PSBodyWithFileSchema<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-FileSchemaTestClass] <PSCustomObject><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-FileSchemaTestClass] <PSCustomObject><br>
@ -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) [[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)
<a name="Test-PSBodyWithQueryParams"></a> <a id="Test-PSBodyWithQueryParams"></a>
# **Test-PSBodyWithQueryParams** # **Test-PSBodyWithQueryParams**
> void Test-PSBodyWithQueryParams<br> > void Test-PSBodyWithQueryParams<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Query] <String><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Query] <String><br>
@ -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) [[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)
<a name="Test-PSClientModel"></a> <a id="Test-PSClientModel"></a>
# **Test-PSClientModel** # **Test-PSClientModel**
> Client Test-PSClientModel<br> > Client Test-PSClientModel<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Client] <PSCustomObject><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Client] <PSCustomObject><br>
@ -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) [[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)
<a name="Test-PSEndpointParameters"></a> <a id="Test-PSEndpointParameters"></a>
# **Test-PSEndpointParameters** # **Test-PSEndpointParameters**
> void Test-PSEndpointParameters<br> > void Test-PSEndpointParameters<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Number] <Decimal><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Number] <Decimal><br>
@ -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) [[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)
<a name="Test-PSEnumParameters"></a> <a id="Test-PSEnumParameters"></a>
# **Test-PSEnumParameters** # **Test-PSEnumParameters**
> void Test-PSEnumParameters<br> > void Test-PSEnumParameters<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-EnumHeaderStringArray] <String[]><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-EnumHeaderStringArray] <String[]><br>
@ -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) [[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)
<a name="Test-PSGroupParameters"></a> <a id="Test-PSGroupParameters"></a>
# **Test-PSGroupParameters** # **Test-PSGroupParameters**
> void Test-PSGroupParameters<br> > void Test-PSGroupParameters<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-RequiredStringGroup] <Int32><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-RequiredStringGroup] <Int32><br>
@ -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) [[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)
<a name="Test-PSInlineAdditionalProperties"></a> <a id="Test-PSInlineAdditionalProperties"></a>
# **Test-PSInlineAdditionalProperties** # **Test-PSInlineAdditionalProperties**
> void Test-PSInlineAdditionalProperties<br> > void Test-PSInlineAdditionalProperties<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-RequestBody] <System.Collections.Hashtable><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-RequestBody] <System.Collections.Hashtable><br>
@ -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) [[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)
<a name="Test-PSJsonFormData"></a> <a id="Test-PSJsonFormData"></a>
# **Test-PSJsonFormData** # **Test-PSJsonFormData**
> void Test-PSJsonFormData<br> > void Test-PSJsonFormData<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Param] <String><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Param] <String><br>
@ -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) [[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)
<a name="Test-PSQueryParameterCollectionFormat"></a> <a id="Test-PSQueryParameterCollectionFormat"></a>
# **Test-PSQueryParameterCollectionFormat** # **Test-PSQueryParameterCollectionFormat**
> void Test-PSQueryParameterCollectionFormat<br> > void Test-PSQueryParameterCollectionFormat<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Pipe] <String[]><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Pipe] <String[]><br>

2
samples/client/petstore/powershell/docs/PSFakeClassnameTags123Api.md
View File

@ -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**](PSFakeClassnameTags123Api.md#Test-PSClassname) | **PATCH** /fake_classname_test | To test class name in snake case
<a name="Test-PSClassname"></a> <a id="Test-PSClassname"></a>
# **Test-PSClassname** # **Test-PSClassname**
> Client Test-PSClassname<br> > Client Test-PSClassname<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Client] <PSCustomObject><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Client] <PSCustomObject><br>

18
samples/client/petstore/powershell/docs/PSPetApi.md
View File

@ -15,7 +15,7 @@ Method | HTTP request | Description
[**Invoke-PSUploadFileWithRequiredFile**](PSPetApi.md#Invoke-PSUploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) [**Invoke-PSUploadFileWithRequiredFile**](PSPetApi.md#Invoke-PSUploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required)
<a name="Add-PSPet"></a> <a id="Add-PSPet"></a>
# **Add-PSPet** # **Add-PSPet**
> void Add-PSPet<br> > void Add-PSPet<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Pet] <PSCustomObject><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Pet] <PSCustomObject><br>
@ -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) [[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)
<a name="remove-pet"></a> <a id="remove-pet"></a>
# **Remove-Pet** # **Remove-Pet**
> void Remove-Pet<br> > void Remove-Pet<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-PetId] <Int64><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-PetId] <Int64><br>
@ -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) [[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)
<a name="Find-PSPetsByStatus"></a> <a id="Find-PSPetsByStatus"></a>
# **Find-PSPetsByStatus** # **Find-PSPetsByStatus**
> Pet[] Find-PSPetsByStatus<br> > Pet[] Find-PSPetsByStatus<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Status] <String[]><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Status] <String[]><br>
@ -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) [[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)
<a name="Find-PSPetsByTags"></a> <a id="Find-PSPetsByTags"></a>
# **Find-PSPetsByTags** # **Find-PSPetsByTags**
> Pet[] Find-PSPetsByTags<br> > Pet[] Find-PSPetsByTags<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Tags] <String[]><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Tags] <String[]><br>
@ -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) [[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)
<a name="Get-PSPetById"></a> <a id="Get-PSPetById"></a>
# **Get-PSPetById** # **Get-PSPetById**
> Pet Get-PSPetById<br> > Pet Get-PSPetById<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-PetId] <Int64><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-PetId] <Int64><br>
@ -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) [[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)
<a name="Update-PSPet"></a> <a id="Update-PSPet"></a>
# **Update-PSPet** # **Update-PSPet**
> void Update-PSPet<br> > void Update-PSPet<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Pet] <PSCustomObject><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Pet] <PSCustomObject><br>
@ -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) [[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)
<a name="Update-PSPetWithForm"></a> <a id="Update-PSPetWithForm"></a>
# **Update-PSPetWithForm** # **Update-PSPetWithForm**
> void Update-PSPetWithForm<br> > void Update-PSPetWithForm<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-PetId] <Int64><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-PetId] <Int64><br>
@ -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) [[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)
<a name="Invoke-PSUploadFile"></a> <a id="Invoke-PSUploadFile"></a>
# **Invoke-PSUploadFile** # **Invoke-PSUploadFile**
> ApiResponse Invoke-PSUploadFile<br> > ApiResponse Invoke-PSUploadFile<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-PetId] <Int64><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-PetId] <Int64><br>
@ -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) [[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)
<a name="Invoke-PSUploadFileWithRequiredFile"></a> <a id="Invoke-PSUploadFileWithRequiredFile"></a>
# **Invoke-PSUploadFileWithRequiredFile** # **Invoke-PSUploadFileWithRequiredFile**
> ApiResponse Invoke-PSUploadFileWithRequiredFile<br> > ApiResponse Invoke-PSUploadFileWithRequiredFile<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-PetId] <Int64><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-PetId] <Int64><br>

8
samples/client/petstore/powershell/docs/PSStoreApi.md
View File

@ -10,7 +10,7 @@ Method | HTTP request | Description
[**Invoke-PSPlaceOrder**](PSStoreApi.md#Invoke-PSPlaceOrder) | **POST** /store/order | Place an order for a pet [**Invoke-PSPlaceOrder**](PSStoreApi.md#Invoke-PSPlaceOrder) | **POST** /store/order | Place an order for a pet
<a name="Remove-PSOrder"></a> <a id="Remove-PSOrder"></a>
# **Remove-PSOrder** # **Remove-PSOrder**
> void Remove-PSOrder<br> > void Remove-PSOrder<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-OrderId] <String><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-OrderId] <String><br>
@ -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) [[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)
<a name="Get-PSInventory"></a> <a id="Get-PSInventory"></a>
# **Get-PSInventory** # **Get-PSInventory**
> System.Collections.Hashtable Get-PSInventory<br> > System.Collections.Hashtable Get-PSInventory<br>
@ -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) [[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)
<a name="Get-PSOrderById"></a> <a id="Get-PSOrderById"></a>
# **Get-PSOrderById** # **Get-PSOrderById**
> Order Get-PSOrderById<br> > Order Get-PSOrderById<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-OrderId] <Int64><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-OrderId] <Int64><br>
@ -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) [[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)
<a name="Invoke-PSPlaceOrder"></a> <a id="Invoke-PSPlaceOrder"></a>
# **Invoke-PSPlaceOrder** # **Invoke-PSPlaceOrder**
> Order Invoke-PSPlaceOrder<br> > Order Invoke-PSPlaceOrder<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Order] <PSCustomObject><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Order] <PSCustomObject><br>

16
samples/client/petstore/powershell/docs/PSUserApi.md
View File

@ -14,7 +14,7 @@ Method | HTTP request | Description
[**Update-PSUser**](PSUserApi.md#Update-PSUser) | **PUT** /user/{username} | Updated user [**Update-PSUser**](PSUserApi.md#Update-PSUser) | **PUT** /user/{username} | Updated user
<a name="New-PSUser"></a> <a id="New-PSUser"></a>
# **New-PSUser** # **New-PSUser**
> void New-PSUser<br> > void New-PSUser<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-User] <PSCustomObject><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-User] <PSCustomObject><br>
@ -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) [[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)
<a name="New-PSUsersWithArrayInput"></a> <a id="New-PSUsersWithArrayInput"></a>
# **New-PSUsersWithArrayInput** # **New-PSUsersWithArrayInput**
> void New-PSUsersWithArrayInput<br> > void New-PSUsersWithArrayInput<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-User] <PSCustomObject[]><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-User] <PSCustomObject[]><br>
@ -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) [[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)
<a name="New-PSUsersWithListInput"></a> <a id="New-PSUsersWithListInput"></a>
# **New-PSUsersWithListInput** # **New-PSUsersWithListInput**
> void New-PSUsersWithListInput<br> > void New-PSUsersWithListInput<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-User] <PSCustomObject[]><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-User] <PSCustomObject[]><br>
@ -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) [[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)
<a name="Remove-PSUser"></a> <a id="Remove-PSUser"></a>
# **Remove-PSUser** # **Remove-PSUser**
> void Remove-PSUser<br> > void Remove-PSUser<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Username] <String><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Username] <String><br>
@ -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) [[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)
<a name="Get-PSUserByName"></a> <a id="Get-PSUserByName"></a>
# **Get-PSUserByName** # **Get-PSUserByName**
> User Get-PSUserByName<br> > User Get-PSUserByName<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Username] <String><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Username] <String><br>
@ -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) [[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)
<a name="Invoke-PSLoginUser"></a> <a id="Invoke-PSLoginUser"></a>
# **Invoke-PSLoginUser** # **Invoke-PSLoginUser**
> String Invoke-PSLoginUser<br> > String Invoke-PSLoginUser<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Username] <String><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Username] <String><br>
@ -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) [[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)
<a name="Invoke-PSLogoutUser"></a> <a id="Invoke-PSLogoutUser"></a>
# **Invoke-PSLogoutUser** # **Invoke-PSLogoutUser**
> void Invoke-PSLogoutUser<br> > void Invoke-PSLogoutUser<br>
@ -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) [[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)
<a name="Update-PSUser"></a> <a id="Update-PSUser"></a>
# **Update-PSUser** # **Update-PSUser**
> void Update-PSUser<br> > void Update-PSUser<br>
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Username] <String><br> > &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Username] <String><br>