martin-mfg 9afea50cab
use map/array model class only if it is generated (#17612)
* fix

* tests

* generate samples

* refactor
2024-01-29 21:35:21 +08:00

32 KiB

PSPetstore.PSPetstore\Api.PSFakeApi

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

Method HTTP request Description
Invoke-PSFakeHealthGet GET /fake/health Health check endpoint
Invoke-PSFakeOuterBooleanSerialize POST /fake/outer/boolean
Invoke-PSFakeOuterCompositeSerialize POST /fake/outer/composite
Invoke-PSFakeOuterNumberSerialize POST /fake/outer/number
Invoke-PSFakeOuterStringSerialize POST /fake/outer/string
Get-PSArrayOfEnums GET /fake/array-of-enums Array of Enums
Test-PSAdditionalPropertiesReference POST /fake/additionalProperties-reference test referenced additionalProperties
Test-PSBodyWithFileSchema PUT /fake/body-with-file-schema
Test-PSBodyWithQueryParams PUT /fake/body-with-query-params
Test-PSClientModel PATCH /fake To test ""client"" model
Test-PSEndpointParameters POST /fake Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
Test-PSEnumParameters GET /fake To test enum parameters
Test-PSGroupParameters DELETE /fake Fake endpoint to test group parameters (optional)
Test-PSInlineAdditionalProperties POST /fake/inline-additionalProperties test inline additionalProperties
Test-PSInlineFreeformAdditionalProperties POST /fake/inline-freeform-additionalProperties test inline free-form additionalProperties
Test-PSJsonFormData GET /fake/jsonFormData test json serialization of form data
Test-PSQueryParameterCollectionFormat PUT /fake/test-query-parameters
Test-PSStringMapReference POST /fake/stringMap-reference test referenced string map

Invoke-PSFakeHealthGet

HealthCheckResult Invoke-PSFakeHealthGet

Health check endpoint

Example


# Health check endpoint
try {
    $Result = Invoke-PSFakeHealthGet
} catch {
    Write-Host ("Exception occurred when calling Invoke-PSFakeHealthGet: {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

HealthCheckResult (PSCustomObject)

Authorization

No authorization required

HTTP request headers

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

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

Invoke-PSFakeOuterBooleanSerialize

Boolean Invoke-PSFakeOuterBooleanSerialize
        [-Body] <System.Nullable[Boolean]>

Test serialization of outer boolean types

Example

$Body = $true # Boolean | Input boolean as post body (optional)

try {
    $Result = Invoke-PSFakeOuterBooleanSerialize -Body $Body
} catch {
    Write-Host ("Exception occurred when calling Invoke-PSFakeOuterBooleanSerialize: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Body Boolean Input boolean as post body [optional]

Return type

Boolean

Authorization

No authorization required

HTTP request headers

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

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

Invoke-PSFakeOuterCompositeSerialize

OuterComposite Invoke-PSFakeOuterCompositeSerialize
        [-OuterComposite]

Test serialization of object with outer number type

Example

$OuterComposite = Initialize-OuterComposite -MyNumber 0 -MyString "MyMyString" -MyBoolean $false # OuterComposite | Input composite as post body (optional)

try {
    $Result = Invoke-PSFakeOuterCompositeSerialize -OuterComposite $OuterComposite
} catch {
    Write-Host ("Exception occurred when calling Invoke-PSFakeOuterCompositeSerialize: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
OuterComposite OuterComposite Input composite as post body [optional]

Return type

OuterComposite (PSCustomObject)

Authorization

No authorization required

HTTP request headers

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

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

Invoke-PSFakeOuterNumberSerialize

Decimal Invoke-PSFakeOuterNumberSerialize
        [-Body] <System.Nullable[Decimal]>

Test serialization of outer number types

Example

$Body = 8.14 # Decimal | Input number as post body (optional)

try {
    $Result = Invoke-PSFakeOuterNumberSerialize -Body $Body
} catch {
    Write-Host ("Exception occurred when calling Invoke-PSFakeOuterNumberSerialize: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Body Decimal Input number as post body [optional]

Return type

Decimal

Authorization

No authorization required

HTTP request headers

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

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

Invoke-PSFakeOuterStringSerialize

String Invoke-PSFakeOuterStringSerialize
        [-Body]

Test serialization of outer string types

Example

$Body = "MyBody" # String | Input string as post body (optional)

try {
    $Result = Invoke-PSFakeOuterStringSerialize -Body $Body
} catch {
    Write-Host ("Exception occurred when calling Invoke-PSFakeOuterStringSerialize: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Body String Input string as post body [optional]

Return type

String

Authorization

No authorization required

HTTP request headers

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

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

Get-PSArrayOfEnums

OuterEnum[] Get-PSArrayOfEnums

Array of Enums

Example


# Array of Enums
try {
    $Result = Get-PSArrayOfEnums
} catch {
    Write-Host ("Exception occurred when calling Get-PSArrayOfEnums: {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

OuterEnum[] (PSCustomObject)

Authorization

No authorization required

HTTP request headers

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

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

Test-PSAdditionalPropertiesReference

void Test-PSAdditionalPropertiesReference
        [-RequestBody] <System.Collections.Hashtable>

test referenced additionalProperties

Example

$RequestBody = @{ key_example =  } # System.Collections.Hashtable | request body

# test referenced additionalProperties
try {
    $Result = Test-PSAdditionalPropertiesReference -RequestBody $RequestBody
} catch {
    Write-Host ("Exception occurred when calling Test-PSAdditionalPropertiesReference: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
RequestBody System.Collections.Hashtable request body

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

Test-PSBodyWithFileSchema

void Test-PSBodyWithFileSchema
        [-FileSchemaTestClass]

For this test, the body for this request much reference a schema named File.

Example

$File = Initialize-File -SourceURI "MySourceURI"
$FileSchemaTestClass = Initialize-FileSchemaTestClass -File $File -Files $File # FileSchemaTestClass | 

try {
    $Result = Test-PSBodyWithFileSchema -FileSchemaTestClass $FileSchemaTestClass
} catch {
    Write-Host ("Exception occurred when calling Test-PSBodyWithFileSchema: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
FileSchemaTestClass FileSchemaTestClass

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

Test-PSBodyWithQueryParams

void Test-PSBodyWithQueryParams
        [-Query]
        [-User]

Example

$Query = "MyQuery" # String | 
$User = Initialize-User -Id 0 -Username "MyUsername" -FirstName "MyFirstName" -LastName "MyLastName" -Email "MyEmail" -Password "MyPassword" -Phone "MyPhone" -UserStatus 0 -ObjectWithNoDeclaredProps  -ObjectWithNoDeclaredPropsNullable  -AnyTypeProp  -AnyTypePropNullable # User | 

try {
    $Result = Test-PSBodyWithQueryParams -Query $Query -User $User
} catch {
    Write-Host ("Exception occurred when calling Test-PSBodyWithQueryParams: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Query String
User User

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

Test-PSClientModel

Client Test-PSClientModel
        [-Client]

To test ""client"" model

To test ""client"" model

Example

$Client = Initialize-Client -Client "MyClient" # Client | client model

# To test ""client"" model
try {
    $Result = Test-PSClientModel -Client $Client
} catch {
    Write-Host ("Exception occurred when calling Test-PSClientModel: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Client Client client model

Return type

Client (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-PSEndpointParameters

void Test-PSEndpointParameters
        [-Number]
        [-Double]
        [-PatternWithoutDelimiter]
        [-Byte]
        [-Integer] <System.Nullable[Int32]>
        [-Int32] <System.Nullable[Int32]>
        [-Int64] <System.Nullable[Int64]>
        [-Float] <System.Nullable[Double]>
        [-String]
        [-Binary] <System.IO.FileInfo>
        [-Date] <System.Nullable[System.DateTime]>
        [-DateTime] <System.Nullable[System.DateTime]>
        [-Password]
        [-Callback]

Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트

Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure HTTP basic authorization: http_basic_test
$Configuration.Username = "YOUR_USERNAME"
$Configuration.Password = "YOUR_PASSWORD"

$Number = 8.14 # Decimal | None
$Double = 1.2 # Double | None
$PatternWithoutDelimiter = "MyPatternWithoutDelimiter" # String | None
$Byte =  # SystemByte | None
$Integer = 56 # Int32 | None (optional)
$Int32 = 56 # Int32 | None (optional)
$Int64 = 789 # Int64 | None (optional)
$Float = 3.4 # Double | None (optional)
$String = "MyString" # String | None (optional)
$Binary =  # System.IO.FileInfo | None (optional)
$Date = (Get-Date) # System.DateTime | None (optional)
$DateTime = (Get-Date) # System.DateTime | None (optional)
$Password = "MyPassword" # String | None (optional)
$Callback = "MyCallback" # String | None (optional)

# Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 
try {
    $Result = Test-PSEndpointParameters -Number $Number -Double $Double -PatternWithoutDelimiter $PatternWithoutDelimiter -Byte $Byte -Integer $Integer -Int32 $Int32 -Int64 $Int64 -Float $Float -String $String -Binary $Binary -Date $Date -DateTime $DateTime -Password $Password -Callback $Callback
} catch {
    Write-Host ("Exception occurred when calling Test-PSEndpointParameters: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Number Decimal None
Double Double None
PatternWithoutDelimiter String None
Byte SystemByte None
Integer Int32 None [optional]
Int32 Int32 None [optional]
Int64 Int64 None [optional]
Float Double None [optional]
String String None [optional]
Binary System.IO.FileInfo****System.IO.FileInfo None [optional]
Date System.DateTime None [optional]
DateTime System.DateTime None [optional]
Password String None [optional]
Callback String None [optional]

Return type

void (empty response body)

Authorization

http_basic_test

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]

Test-PSEnumParameters

void Test-PSEnumParameters
        [-EnumHeaderStringArray] <String[]>
        [-EnumHeaderString]
        [-EnumQueryStringArray] <String[]>
        [-EnumQueryString]
        [-EnumQueryInteger] <System.Nullable[Int32]>
        [-EnumQueryDouble] <System.Nullable[Double]>
        [-EnumFormStringArray] <String[]>
        [-EnumFormString]

To test enum parameters

To test enum parameters

Example

$EnumHeaderStringArray = ">" # String[] | Header parameter enum test (string array) (optional)
$EnumHeaderString = "_abc" # String | Header parameter enum test (string) (optional) (default to "-efg")
$EnumQueryStringArray = ">" # String[] | Query parameter enum test (string array) (optional)
$EnumQueryString = "_abc" # String | Query parameter enum test (string) (optional) (default to "-efg")
$EnumQueryInteger = "1" # Int32 | Query parameter enum test (double) (optional)
$EnumQueryDouble = "1.1" # Double | Query parameter enum test (double) (optional)
$EnumFormStringArray = ">" # String[] | Form parameter enum test (string array) (optional) (default to "$")
$EnumFormString = "_abc" # String | Form parameter enum test (string) (optional) (default to "-efg")

# To test enum parameters
try {
    $Result = Test-PSEnumParameters -EnumHeaderStringArray $EnumHeaderStringArray -EnumHeaderString $EnumHeaderString -EnumQueryStringArray $EnumQueryStringArray -EnumQueryString $EnumQueryString -EnumQueryInteger $EnumQueryInteger -EnumQueryDouble $EnumQueryDouble -EnumFormStringArray $EnumFormStringArray -EnumFormString $EnumFormString
} catch {
    Write-Host ("Exception occurred when calling Test-PSEnumParameters: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
EnumHeaderStringArray String[] Header parameter enum test (string array) [optional]
EnumHeaderString String Header parameter enum test (string) [optional] [default to "-efg"]
EnumQueryStringArray String[] Query parameter enum test (string array) [optional]
EnumQueryString String Query parameter enum test (string) [optional] [default to "-efg"]
EnumQueryInteger Int32 Query parameter enum test (double) [optional]
EnumQueryDouble Double Query parameter enum test (double) [optional]
EnumFormStringArray String[] Form parameter enum test (string array) [optional] [default to "$"]
EnumFormString String Form parameter enum test (string) [optional] [default to "-efg"]

Return type

void (empty response body)

Authorization

No authorization required

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]

Test-PSGroupParameters

void Test-PSGroupParameters
        [-RequiredStringGroup]
        [-RequiredBooleanGroup]
        [-RequiredInt64Group]
        [-StringGroup] <System.Nullable[Int32]>
        [-BooleanGroup] <System.Nullable[Boolean]>
        [-Int64Group] <System.Nullable[Int64]>

Fake endpoint to test group parameters (optional)

Fake endpoint to test group parameters (optional)

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration

$RequiredStringGroup = 56 # Int32 | Required String in group parameters
$RequiredBooleanGroup = $true # Boolean | Required Boolean in group parameters
$RequiredInt64Group = 789 # Int64 | Required Integer in group parameters
$StringGroup = 56 # Int32 | String in group parameters (optional)
$BooleanGroup = $true # Boolean | Boolean in group parameters (optional)
$Int64Group = 789 # Int64 | Integer in group parameters (optional)

# Fake endpoint to test group parameters (optional)
try {
    $Result = Test-PSGroupParameters -RequiredStringGroup $RequiredStringGroup -RequiredBooleanGroup $RequiredBooleanGroup -RequiredInt64Group $RequiredInt64Group -StringGroup $StringGroup -BooleanGroup $BooleanGroup -Int64Group $Int64Group
} catch {
    Write-Host ("Exception occurred when calling Test-PSGroupParameters: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
RequiredStringGroup Int32 Required String in group parameters
RequiredBooleanGroup Boolean Required Boolean in group parameters
RequiredInt64Group Int64 Required Integer in group parameters
StringGroup Int32 String in group parameters [optional]
BooleanGroup Boolean Boolean in group parameters [optional]
Int64Group Int64 Integer in group parameters [optional]

Return type

void (empty response body)

Authorization

bearer_test

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Test-PSInlineAdditionalProperties

void Test-PSInlineAdditionalProperties
        [-RequestBody] <System.Collections.Hashtable>

test inline additionalProperties

Example

$RequestBody = @{ key_example = "MyInner" } # System.Collections.Hashtable | request body

# test inline additionalProperties
try {
    $Result = Test-PSInlineAdditionalProperties -RequestBody $RequestBody
} catch {
    Write-Host ("Exception occurred when calling Test-PSInlineAdditionalProperties: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
RequestBody System.Collections.Hashtable request body

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

Test-PSInlineFreeformAdditionalProperties

void Test-PSInlineFreeformAdditionalProperties
        [-TestInlineFreeformAdditionalPropertiesRequest]

test inline free-form additionalProperties

Example

$TestInlineFreeformAdditionalPropertiesRequest = Initialize-TestInlineFreeformAdditionalPropertiesRequest -SomeProperty "MySomeProperty" # TestInlineFreeformAdditionalPropertiesRequest | request body

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

Parameters

Name Type Description Notes
TestInlineFreeformAdditionalPropertiesRequest TestInlineFreeformAdditionalPropertiesRequest request body

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

Test-PSJsonFormData

void Test-PSJsonFormData
        [-Param]
        [-Param2]

test json serialization of form data

Example

$Param = "MyParam" # String | field1
$Param2 = "MyParam2" # String | field2

# test json serialization of form data
try {
    $Result = Test-PSJsonFormData -Param $Param -Param2 $Param2
} catch {
    Write-Host ("Exception occurred when calling Test-PSJsonFormData: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Param String field1
Param2 String field2

Return type

void (empty response body)

Authorization

No authorization required

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]

Test-PSQueryParameterCollectionFormat

void Test-PSQueryParameterCollectionFormat
        [-Pipe] <String[]>
        [-Ioutil] <String[]>
        [-Http] <String[]>
        [-Url] <String[]>
        [-Context] <String[]>

To test the collection format in query parameters

Example

$Pipe = "MyPipe" # String[] | 
$Ioutil = "MyIoutil" # String[] | 
$Http = "MyHttp" # String[] | 
$Url = "MyUrl" # String[] | 
$Context = "MyContext" # String[] | 

try {
    $Result = Test-PSQueryParameterCollectionFormat -Pipe $Pipe -Ioutil $Ioutil -Http $Http -Url $Url -Context $Context
} catch {
    Write-Host ("Exception occurred when calling Test-PSQueryParameterCollectionFormat: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Pipe String[]
Ioutil String[]
Http String[]
Url String[]
Context String[]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Test-PSStringMapReference

void Test-PSStringMapReference
        [-RequestBody] <System.Collections.Hashtable>

test referenced string map

Example

$RequestBody = @{ key_example = "MyInner" } # System.Collections.Hashtable | request body

# test referenced string map
try {
    $Result = Test-PSStringMapReference -RequestBody $RequestBody
} catch {
    Write-Host ("Exception occurred when calling Test-PSStringMapReference: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
RequestBody System.Collections.Hashtable request body

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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