loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-12-06 08:06:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

[powershell] Updated the Api doc with httpsiging script snippet. (#7499)

Browse Source 
* Added the httpsigning code snippet for api doc

* Updated the sample

* update samples

Co-authored-by: William Cheng <wing328hk@gmail.com>
This commit is contained in:
Ghufran Zahidi
2020-09-25 14:24:14 +05:30
committed by GitHub
parent 9ba943318a
commit d6bfecf2ef
15 changed files with 89 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -33,11 +33,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"
$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
# Create user
try {
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))
@@ -51,7 +52,7 @@ Name | Type | Description | Notes
**User** | [**User**](User.md)| Created user object |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
void (empty response body)
### Authorization
@@ -82,11 +83,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"
$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
# Creates list of users with given input array
try {
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))
@@ -100,7 +102,7 @@ Name | Type | Description | Notes
**User** | [**User[]**](User.md)| List of user object |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
void (empty response body)
### Authorization
@@ -131,11 +133,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"
$User = @() # User[] | List of user object
# Creates list of users with given input array
try {
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))
@@ -149,7 +152,7 @@ Name | Type | Description | Notes
**User** | [**User[]**](User.md)| List of user object |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
void (empty response body)
### Authorization
@@ -182,11 +185,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 | The name that needs to be deleted
# Delete user
try {
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))
@@ -200,7 +204,7 @@ Name | Type | Description | Notes
**Username** | **String**| The name that needs to be deleted |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
void (empty response body)
### Authorization
@@ -229,7 +233,7 @@ $Username = "Username_example" # String | The name that needs to be fetched. Use
# Get user by user name
try {
User $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))
@@ -243,7 +247,7 @@ Name | Type | Description | Notes
**Username** | **String**| The name that needs to be fetched. Use user1 for testing. |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
[**User**](User.md)
### Authorization
@@ -274,7 +278,7 @@ $Password = "Password_example" # String | The password for login in clear text
# Logs user into the system
try {
String $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))
@@ -289,7 +293,7 @@ Name | Type | Description | Notes
**Password** | **String**| The password for login in clear text |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
**String**
### Authorization
@@ -320,9 +324,10 @@ $Configuration["ApiKey"]["AUTH_KEY"] = "YOUR_API_KEY"
#$Configuration["ApiKeyPrefix"]["AUTH_KEY"] = "Bearer"
# Logs out current logged in user session
try {
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))
@@ -333,7 +338,7 @@ try {
This endpoint does not need any parameter.
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
void (empty response body)
### Authorization
@@ -367,12 +372,13 @@ $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
# Updated user
try {
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))
@@ -387,7 +393,7 @@ Name | Type | Description | Notes
**User** | [**User**](User.md)| Updated user object |
### Return type
# cmdlet returns PSCustomObject, the return object contains the properties of below type
void (empty response body)
### Authorization