loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/samples/client/echo_api/powershell/docs/BodyApi.md
William Cheng 372894dd1d
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

11 KiB
Raw Blame History

PSOpenAPITools.PSOpenAPITools\Api.BodyApi

All URIs are relative to http://localhost:3000

Method HTTP request Description
Test-BinaryGif POST /binary/gif Test binary (gif) response body
Test-BodyApplicationOctetstreamBinary POST /body/application/octetstream/binary Test body parameter(s)
Test-BodyMultipartFormdataArrayOfBinary POST /body/application/octetstream/array_of_binary Test array of binary in multipart mime
Test-EchoBodyFreeFormObjectResponseString POST /echo/body/FreeFormObject/response_string Test free form object
Test-EchoBodyPet POST /echo/body/Pet Test body parameter(s)
Test-EchoBodyPetResponseString POST /echo/body/Pet/response_string Test empty response body
Test-EchoBodyTagResponseString POST /echo/body/Tag/response_string Test empty json (request body)
Test-EchoBodyAllOfPet POST /echo/body/allOf/Pet Test body parameter(s)

Test-BinaryGif

System.IO.FileInfo Test-BinaryGif

Test binary (gif) response body

Test binary (gif) response body

Example


# Test binary (gif) response body
try {
    $Result = Test-BinaryGif
} catch {
    Write-Host ("Exception occurred when calling Test-BinaryGif: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

This endpoint does not need any parameter.

Return type

System.IO.FileInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: image/gif

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

Test-BodyApplicationOctetstreamBinary

String Test-BodyApplicationOctetstreamBinary
        [-Body] <System.IO.FileInfo>

Test body parameter(s)

Test body parameter(s)

Example

$Body =  # System.IO.FileInfo |  (optional)

# Test body parameter(s)
try {
    $Result = Test-BodyApplicationOctetstreamBinary -Body $Body
} catch {
    Write-Host ("Exception occurred when calling Test-BodyApplicationOctetstreamBinary: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Body System.IO.FileInfo****System.IO.FileInfo [optional]

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/octet-stream
  • Accept: text/plain

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

Test-BodyMultipartFormdataArrayOfBinary

String Test-BodyMultipartFormdataArrayOfBinary
        [-Files] <System.IO.FileInfo[]>

Test array of binary in multipart mime

Test array of binary in multipart mime

Example

$Files =  # System.IO.FileInfo[] | 

# Test array of binary in multipart mime
try {
    $Result = Test-BodyMultipartFormdataArrayOfBinary -Files $Files
} catch {
    Write-Host ("Exception occurred when calling Test-BodyMultipartFormdataArrayOfBinary: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Files System.IO.FileInfo[]

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: text/plain

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

Test-EchoBodyFreeFormObjectResponseString

String Test-EchoBodyFreeFormObjectResponseString
        [-Body] <System.Nullable[SystemCollectionsHashtable]>

Test free form object

Test free form object

Example

$Body = @{ key_example = ... } # SystemCollectionsHashtable | Free form object (optional)

# Test free form object
try {
    $Result = Test-EchoBodyFreeFormObjectResponseString -Body $Body
} catch {
    Write-Host ("Exception occurred when calling Test-EchoBodyFreeFormObjectResponseString: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Body SystemCollectionsHashtable Free form object [optional]

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

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

Test-EchoBodyPet

Pet Test-EchoBodyPet
        [-Pet]

Test body parameter(s)

Test body parameter(s)

Example

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

# Test body parameter(s)
try {
    $Result = Test-EchoBodyPet -Pet $Pet
} catch {
    Write-Host ("Exception occurred when calling Test-EchoBodyPet: {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 [optional]

Return type

Pet (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

Test-EchoBodyPetResponseString

String Test-EchoBodyPetResponseString
        [-Pet]

Test empty response body

Test empty response body

Example

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

# Test empty response body
try {
    $Result = Test-EchoBodyPetResponseString -Pet $Pet
} catch {
    Write-Host ("Exception occurred when calling Test-EchoBodyPetResponseString: {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 [optional]

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

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

Test-EchoBodyTagResponseString

String Test-EchoBodyTagResponseString
        [-Tag]

Test empty json (request body)

Test empty json (request body)

Example

$Tag = Initialize-Tag -Id 0 -Name "MyName" # Tag | Tag object (optional)

# Test empty json (request body)
try {
    $Result = Test-EchoBodyTagResponseString -Tag $Tag
} catch {
    Write-Host ("Exception occurred when calling Test-EchoBodyTagResponseString: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Tag Tag Tag object [optional]

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

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

Test-EchoBodyAllOfPet

Pet Test-EchoBodyAllOfPet
        [-Pet]

Test body parameter(s)

Test body parameter(s)

Example

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

# Test body parameter(s)
try {
    $Result = Test-EchoBodyAllOfPet -Pet $Pet
} catch {
    Write-Host ("Exception occurred when calling Test-EchoBodyAllOfPet: {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 [optional]

Return type

Pet (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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