forked from loafle/openapi-generator-original

Add powershell echo test, rename api key names (#17043 )

* add powershell echo test, rename api key names

* update

2023-11-13 00:09:46 +08:00

17 KiB

Raw Permalink Blame History

PSPetstore.PSPetstore\Api.PSPetApi

All URIs are relative to http://petstore.swagger.io:80/v2

Method	HTTP request	Description
Add-PSPet	POST /pet	Add a new pet to the store
Remove-Pet	DELETE /pet/{petId}	Deletes a pet
Find-PSPetsByStatus	GET /pet/findByStatus	Finds Pets by status
Find-PSPetsByTags	GET /pet/findByTags	Finds Pets by tags
Get-PSPetById	GET /pet/{petId}	Find pet by ID
Update-PSPet	PUT /pet	Update an existing pet
Update-PSPetWithForm	POST /pet/{petId}	Updates a pet in the store with form data
Invoke-PSUploadFile	POST /pet/{petId}/uploadImage	uploads an image
Invoke-PSUploadFileWithRequiredFile	POST /fake/{petId}/uploadImageWithRequiredFile	uploads an image (required)

Add-PSPet

void Add-PSPet
[-Pet]

Add a new pet to the store

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure OAuth2 access token for authorization: petstore_auth
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

# Configure HttpSignature for authorization :http_signature_test
$httpSigningParams = @{
    KeyId = "xxxxxx1776876789ac747/xxxxxxx564612d31a62c01/xxxxxxxa1d7564612d31a66ee8"
    KeyFilePath = "C:\SecretKey.txt"
    HttpSigningHeader = @("(request-target)","Host","Date","Digest")
    HashAlgorithm = "sha256"
}
Set-ConfigurationHttpSigning $httpSigningParams

$Category = Initialize-Category -Id 0 -Name "MyName"
$Tag = Initialize-Tag -Id 0 -Name "MyName"
$Pet = Initialize-Pet -Id 0 -Category $Category -Name "doggie" -PhotoUrls "MyPhotoUrls" -Tags $Tag -Status "available" # Pet | Pet object that needs to be added to the store

# Add a new pet to the store
try {
    $Result = Add-PSPet -Pet $Pet
} catch {
    Write-Host ("Exception occurred when calling Add-PSPet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
Pet	Pet	Pet object that needs to be added to the store

Return type

void (empty response body)

Authorization

petstore_auth, http_signature_test

HTTP request headers

Content-Type: application/json, application/xml
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Remove-Pet

void Remove-Pet
[-PetId]
[-ApiKey]

Deletes a pet

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure OAuth2 access token for authorization: petstore_auth
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

$PetId = 789 # Int64 | Pet id to delete
$ApiKey = "MyApiKey" # String |  (optional)

# Deletes a pet
try {
    $Result = Remove-Pet -PetId $PetId -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Remove-Pet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
PetId	Int64	Pet id to delete
ApiKey	String		[optional]

Return type

void (empty response body)

Authorization

petstore_auth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Find-PSPetsByStatus

Pet[] Find-PSPetsByStatus
[-Status] <String[]>

Finds Pets by status

Multiple status values can be provided with comma separated strings

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure OAuth2 access token for authorization: petstore_auth
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

# Configure HttpSignature for authorization :http_signature_test
$httpSigningParams = @{
    KeyId = "xxxxxx1776876789ac747/xxxxxxx564612d31a62c01/xxxxxxxa1d7564612d31a66ee8"
    KeyFilePath = "C:\SecretKey.txt"
    HttpSigningHeader = @("(request-target)","Host","Date","Digest")
    HashAlgorithm = "sha256"
}
Set-ConfigurationHttpSigning $httpSigningParams

$Status = "available" # String[] | Status values that need to be considered for filter

# Finds Pets by status
try {
    $Result = Find-PSPetsByStatus -Status $Status
} catch {
    Write-Host ("Exception occurred when calling Find-PSPetsByStatus: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
Status	String[]	Status values that need to be considered for filter

Return type

Pet[] (PSCustomObject)

Authorization

petstore_auth, http_signature_test

HTTP request headers

Content-Type: Not defined
Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Find-PSPetsByTags

Pet[] Find-PSPetsByTags
[-Tags] <String[]>

Finds Pets by tags

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure OAuth2 access token for authorization: petstore_auth
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

# Configure HttpSignature for authorization :http_signature_test
$httpSigningParams = @{
    KeyId = "xxxxxx1776876789ac747/xxxxxxx564612d31a62c01/xxxxxxxa1d7564612d31a66ee8"
    KeyFilePath = "C:\SecretKey.txt"
    HttpSigningHeader = @("(request-target)","Host","Date","Digest")
    HashAlgorithm = "sha256"
}
Set-ConfigurationHttpSigning $httpSigningParams

$Tags = "MyTags" # String[] | Tags to filter by

# Finds Pets by tags
try {
    $Result = Find-PSPetsByTags -Tags $Tags
} catch {
    Write-Host ("Exception occurred when calling Find-PSPetsByTags: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
Tags	String[]	Tags to filter by

Return type

Pet[] (PSCustomObject)

Authorization

petstore_auth, http_signature_test

HTTP request headers

Content-Type: Not defined
Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-PSPetById

Pet Get-PSPetById
[-PetId]

Find pet by ID

Returns a single pet

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure API key authorization: api_key
$Configuration.ApiKey.api_key_name = "YOUR_API_KEY"
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Configuration.ApiKeyPrefix.api_key_name = "Bearer"

$PetId = 789 # Int64 | ID of pet to return

# Find pet by ID
try {
    $Result = Get-PSPetById -PetId $PetId
} catch {
    Write-Host ("Exception occurred when calling Get-PSPetById: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
PetId	Int64	ID of pet to return

Return type

Pet (PSCustomObject)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Update-PSPet

void Update-PSPet
[-Pet]

Update an existing pet

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure OAuth2 access token for authorization: petstore_auth
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

# Configure HttpSignature for authorization :http_signature_test
$httpSigningParams = @{
    KeyId = "xxxxxx1776876789ac747/xxxxxxx564612d31a62c01/xxxxxxxa1d7564612d31a66ee8"
    KeyFilePath = "C:\SecretKey.txt"
    HttpSigningHeader = @("(request-target)","Host","Date","Digest")
    HashAlgorithm = "sha256"
}
Set-ConfigurationHttpSigning $httpSigningParams

$Category = Initialize-Category -Id 0 -Name "MyName"
$Tag = Initialize-Tag -Id 0 -Name "MyName"
$Pet = Initialize-Pet -Id 0 -Category $Category -Name "doggie" -PhotoUrls "MyPhotoUrls" -Tags $Tag -Status "available" # Pet | Pet object that needs to be added to the store

# Update an existing pet
try {
    $Result = Update-PSPet -Pet $Pet
} catch {
    Write-Host ("Exception occurred when calling Update-PSPet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
Pet	Pet	Pet object that needs to be added to the store

Return type

void (empty response body)

Authorization

petstore_auth, http_signature_test

HTTP request headers

Content-Type: application/json, application/xml
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Update-PSPetWithForm

void Update-PSPetWithForm
        [-PetId]
        [-Name]
        [-Status]

Updates a pet in the store with form data

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure OAuth2 access token for authorization: petstore_auth
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

$PetId = 789 # Int64 | ID of pet that needs to be updated
$Name = "MyName" # String | Updated name of the pet (optional)
$Status = "MyStatus" # String | Updated status of the pet (optional)

# Updates a pet in the store with form data
try {
    $Result = Update-PSPetWithForm -PetId $PetId -Name $Name -Status $Status
} catch {
    Write-Host ("Exception occurred when calling Update-PSPetWithForm: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
PetId	Int64	ID of pet that needs to be updated
Name	String	Updated name of the pet	[optional]
Status	String	Updated status of the pet	[optional]

Return type

void (empty response body)

Authorization

petstore_auth

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-PSUploadFile

ApiResponse Invoke-PSUploadFile
        [-PetId]
        [-AdditionalMetadata]
        [-File] <System.IO.FileInfo>

uploads an image

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure OAuth2 access token for authorization: petstore_auth
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

$PetId = 789 # Int64 | ID of pet to update
$AdditionalMetadata = "MyAdditionalMetadata" # String | Additional data to pass to server (optional)
$File =  # System.IO.FileInfo | file to upload (optional)

# uploads an image
try {
    $Result = Invoke-PSUploadFile -PetId $PetId -AdditionalMetadata $AdditionalMetadata -File $File
} catch {
    Write-Host ("Exception occurred when calling Invoke-PSUploadFile: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
PetId	Int64	ID of pet to update
AdditionalMetadata	String	Additional data to pass to server	[optional]
File	System.IO.FileInfoSystem.IO.FileInfo	file to upload	[optional]

Return type

ApiResponse (PSCustomObject)

Authorization

petstore_auth

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-PSUploadFileWithRequiredFile

ApiResponse Invoke-PSUploadFileWithRequiredFile
        [-PetId]
        [-RequiredFile] <System.IO.FileInfo>
        [-AdditionalMetadata]

uploads an image (required)

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure OAuth2 access token for authorization: petstore_auth
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

$PetId = 789 # Int64 | ID of pet to update
$RequiredFile =  # System.IO.FileInfo | file to upload
$AdditionalMetadata = "MyAdditionalMetadata" # String | Additional data to pass to server (optional)

# uploads an image (required)
try {
    $Result = Invoke-PSUploadFileWithRequiredFile -PetId $PetId -RequiredFile $RequiredFile -AdditionalMetadata $AdditionalMetadata
} catch {
    Write-Host ("Exception occurred when calling Invoke-PSUploadFileWithRequiredFile: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
PetId	Int64	ID of pet to update
RequiredFile	System.IO.FileInfoSystem.IO.FileInfo	file to upload
AdditionalMetadata	String	Additional data to pass to server	[optional]

Return type

ApiResponse (PSCustomObject)

Authorization

petstore_auth

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

17 KiB Raw Permalink Blame History

PSPetstore.PSPetstore\Api.PSPetApi

Add-PSPet

Example

Parameters

Return type

Authorization

HTTP request headers

Remove-Pet

Example

Parameters

Return type

Authorization

HTTP request headers

Find-PSPetsByStatus

Example

Parameters

Return type

Authorization

HTTP request headers

Find-PSPetsByTags

Example

Parameters

Return type

Authorization

HTTP request headers

Get-PSPetById

Example

Parameters

Return type

Authorization

HTTP request headers

Update-PSPet

Example

Parameters

Return type

Authorization

HTTP request headers

Update-PSPetWithForm

Example

Parameters

Return type

Authorization

HTTP request headers

Invoke-PSUploadFile

Example

Parameters

Return type

Authorization

HTTP request headers

Invoke-PSUploadFileWithRequiredFile

Example

Parameters

Return type

Authorization

HTTP request headers

17 KiB

Raw Permalink Blame History