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

[REQ][PowerShell] Improve generated PowerShell examples (#9836)

Browse Source 
* Implement new PowerShell example structure

Signed-off-by: Simeon Gerginov <sgerginov@vmware.com>

* Modify documentation template to work with the new PowerShell example format

Signed-off-by: Simeon Gerginov <sgerginov@vmware.com>

* Update PowerShell Generator documentation with the new properties

Signed-off-by: Simeon Gerginov <sgerginov@vmware.com>

* Update PowerShell samples with the new PowerShell example format

Signed-off-by: Simeon Gerginov <sgerginov@vmware.com>

* Fix issues with array of models as parameters

Signed-off-by: Simeon Gerginov <simeongerginov1@gmail.com>

* Change string value generation to include the prefix 'My'

Signed-off-by: Simeon Gerginov <simeongerginov1@gmail.com>

* Remove multiple new lines and trim leading and trailing spaces in PowerShell example

Signed-off-by: Simeon Gerginov <simeongerginov1@gmail.com>
This commit is contained in:
SimeonGerginov
2021-07-03 17:27:06 +03:00
committed by GitHub
parent 32a3eb1655
commit 3663831b4d
6 changed files with 360 additions and 177 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -32,11 +32,11 @@ $Configuration.ApiKey.AUTH_KEY = "YOUR_API_KEY"
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Configuration.ApiKeyPrefix.AUTH_KEY = "Bearer"
$User = (Initialize-User -Id 123 -Username "Username_example" -FirstName "FirstName_example" -LastName "LastName_example" -Email "Email_example" -Password "Password_example" -Phone "Phone_example" -UserStatus 123) # User | Created user object
$User = Initialize-User -Id 0 -Username "MyUsername" -FirstName "MyFirstName" -LastName "MyLastName" -Email "MyEmail" -Password "MyPassword" -Phone "MyPhone" -UserStatus 0 # User | Created user object
# Create user
try {
$Result = New-PSUser -User $User
$Result = New-PSUser -User $User
} catch {
Write-Host ("Exception occured when calling New-PSUser: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
@@ -47,7 +47,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**User** | [**User**](User.md)| Created user object |
**User** | [**User**](User.md)| Created user object |
### Return type
@@ -80,11 +80,11 @@ $Configuration.ApiKey.AUTH_KEY = "YOUR_API_KEY"
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Configuration.ApiKeyPrefix.AUTH_KEY = "Bearer"
$User = @((Initialize-User -Id 123 -Username "Username_example" -FirstName "FirstName_example" -LastName "LastName_example" -Email "Email_example" -Password "Password_example" -Phone "Phone_example" -UserStatus 123)) # User[] | List of user object
$User = Initialize-User -Id 0 -Username "MyUsername" -FirstName "MyFirstName" -LastName "MyLastName" -Email "MyEmail" -Password "MyPassword" -Phone "MyPhone" -UserStatus 0 # User[] | List of user object
# Creates list of users with given input array
try {
$Result = New-PSUsersWithArrayInput -User $User
$Result = New-PSUsersWithArrayInput -User $User
} catch {
Write-Host ("Exception occured when calling New-PSUsersWithArrayInput: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
@@ -95,7 +95,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**User** | [**User[]**](User.md)| List of user object |
**User** | [**User[]**](User.md)| List of user object |
### Return type
@@ -128,11 +128,11 @@ $Configuration.ApiKey.AUTH_KEY = "YOUR_API_KEY"
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Configuration.ApiKeyPrefix.AUTH_KEY = "Bearer"
$User = @() # User[] | List of user object
$User = Initialize-User -Id 0 -Username "MyUsername" -FirstName "MyFirstName" -LastName "MyLastName" -Email "MyEmail" -Password "MyPassword" -Phone "MyPhone" -UserStatus 0 # User[] | List of user object
# Creates list of users with given input array
try {
$Result = New-PSUsersWithListInput -User $User
$Result = New-PSUsersWithListInput -User $User
} catch {
Write-Host ("Exception occured when calling New-PSUsersWithListInput: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
@@ -143,7 +143,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**User** | [**User[]**](User.md)| List of user object |
**User** | [**User[]**](User.md)| List of user object |
### Return type
@@ -178,11 +178,11 @@ $Configuration.ApiKey.AUTH_KEY = "YOUR_API_KEY"
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Configuration.ApiKeyPrefix.AUTH_KEY = "Bearer"
$Username = "Username_example" # String | The name that needs to be deleted
$Username = "MyUsername" # String | The name that needs to be deleted
# Delete user
try {
$Result = Remove-PSUser -Username $Username
$Result = Remove-PSUser -Username $Username
} catch {
Write-Host ("Exception occured when calling Remove-PSUser: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
@@ -193,7 +193,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**Username** | **String**| The name that needs to be deleted |
**Username** | **String**| The name that needs to be deleted |
### Return type
@@ -219,11 +219,11 @@ Get user by user name
### Example
```powershell
$Username = "Username_example" # String | The name that needs to be fetched. Use user1 for testing.
$Username = "MyUsername" # String | The name that needs to be fetched. Use user1 for testing.
# Get user by user name
try {
$Result = Get-PSUserByName -Username $Username
$Result = Get-PSUserByName -Username $Username
} catch {
Write-Host ("Exception occured when calling Get-PSUserByName: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
@@ -234,7 +234,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**Username** | **String**| The name that needs to be fetched. Use user1 for testing. |
**Username** | **String**| The name that needs to be fetched. Use user1 for testing. |
### Return type
@@ -261,12 +261,12 @@ Logs user into the system
### Example
```powershell
$Username = "Username_example" # String | The user name for login
$Password = "Password_example" # String | The password for login in clear text
$Username = "MyUsername" # String | The user name for login
$Password = "MyPassword" # String | The password for login in clear text
# Logs user into the system
try {
$Result = Invoke-PSLoginUser -Username $Username -Password $Password
$Result = Invoke-PSLoginUser -Username $Username -Password $Password
} catch {
Write-Host ("Exception occured when calling Invoke-PSLoginUser: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
@@ -277,8 +277,8 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**Username** | **String**| The user name for login |
**Password** | **String**| The password for login in clear text |
**Username** | **String**| The user name for login |
**Password** | **String**| The password for login in clear text |
### Return type
@@ -313,7 +313,7 @@ $Configuration.ApiKey.AUTH_KEY = "YOUR_API_KEY"
# Logs out current logged in user session
try {
$Result = Invoke-PSLogoutUser
$Result = Invoke-PSLogoutUser
} catch {
Write-Host ("Exception occured when calling Invoke-PSLogoutUser: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
@@ -357,12 +357,12 @@ $Configuration.ApiKey.AUTH_KEY = "YOUR_API_KEY"
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Configuration.ApiKeyPrefix.AUTH_KEY = "Bearer"
$Username = "Username_example" # String | name that need to be deleted
$User = # User | Updated user object
$Username = "MyUsername" # String | name that need to be deleted
$User = Initialize-User -Id 0 -Username "MyUsername" -FirstName "MyFirstName" -LastName "MyLastName" -Email "MyEmail" -Password "MyPassword" -Phone "MyPhone" -UserStatus 0 # User | Updated user object
# Updated user
try {
$Result = Update-PSUser -Username $Username -User $User
$Result = Update-PSUser -Username $Username -User $User
} catch {
Write-Host ("Exception occured when calling Update-PSUser: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
@@ -373,8 +373,8 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**Username** | **String**| name that need to be deleted |
**User** | [**User**](User.md)| Updated user object |
**Username** | **String**| name that need to be deleted |
**User** | [**User**](User.md)| Updated user object |
### Return type