openapi-generator/samples/client/echo_api/powershell

PSOpenAPITools - the PowerShell module for the Echo Server API

Echo Server API

This PowerShell module is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• SDK version: 0.1.2
• Generator version: 7.14.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PowerShellClientCodegen

Frameworks supported

• PowerShell 6.2 or later

Dependencies

Installation

To install from the source, run the following command to build and install the PowerShell module locally:

Build.ps1
Import-Module -Name '.\src\PSOpenAPITools' -Verbose

To avoid function name collision, one can use -Prefix, e.g. Import-Module -Name '.\src\PSOpenAPITools' -Prefix prefix

To uninstall the module, simply run:

Remove-Module -FullyQualifiedName @{ModuleName = "PSOpenAPITools"; ModuleVersion = "0.1.2"}

Tests

To install and run Pester, please execute the following commands in the terminal:

Install-module -name Pester -force

Invoke-Pester

For troubleshooting, please run $DebugPreference = 'Continue' to turn on debugging and disable it with $DebugPreference = 'SilentlyContinue' when done with the troubleshooting.

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AuthApi	Test-AuthHttpBasic	POST /auth/http/basic	To test HTTP basic authentication
AuthApi	Test-AuthHttpBearer	POST /auth/http/bearer	To test HTTP bearer authentication
BodyApi	Test-BinaryGif	POST /binary/gif	Test binary (gif) response body
BodyApi	Test-BodyApplicationOctetstreamBinary	POST /body/application/octetstream/binary	Test body parameter(s)
BodyApi	Test-BodyMultipartFormdataArrayOfBinary	POST /body/application/octetstream/array_of_binary	Test array of binary in multipart mime
BodyApi	Test-BodyMultipartFormdataSingleBinary	POST /body/application/octetstream/single_binary	Test single binary in multipart mime
BodyApi	Test-EchoBodyFreeFormObjectResponseString	POST /echo/body/FreeFormObject/response_string	Test free form object
BodyApi	Test-EchoBodyPet	POST /echo/body/Pet	Test body parameter(s)
BodyApi	Test-EchoBodyPetResponseString	POST /echo/body/Pet/response_string	Test empty response body
BodyApi	Test-EchoBodyTagResponseString	POST /echo/body/Tag/response_string	Test empty json (request body)
BodyApi	Test-EchoBodyAllOfPet	POST /echo/body/allOf/Pet	Test body parameter(s)
BodyApi	Test-EchoBodyStringEnum	POST /echo/body/string_enum	Test string enum response body
FormApi	Test-FormIntegerBooleanString	POST /form/integer/boolean/string	Test form parameter(s)
FormApi	Test-FormObjectMultipart	POST /form/object/multipart	Test form parameter(s) for multipart schema
FormApi	Test-FormOneof	POST /form/oneof	Test form parameter(s) for oneOf schema
HeaderApi	Test-HeaderIntegerBooleanStringEnums	GET /header/integer/boolean/string/enums	Test header parameter(s)
PathApi	Test-sPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath	GET /path/string/{path_string}/integer/{path_integer}/{enum_nonref_string_path}/{enum_ref_string_path}	Test path parameter(s)
QueryApi	Test-EnumRefString	GET /query/enum_ref_string	Test query parameter(s)
QueryApi	Test-QueryDatetimeDateString	GET /query/datetime/date/string	Test query parameter(s)
QueryApi	Test-QueryIntegerBooleanString	GET /query/integer/boolean/string	Test query parameter(s)
QueryApi	Test-QueryStyleDeepObjectExplodeTrueObject	GET /query/style_deepObject/explode_true/object	Test query parameter(s)
QueryApi	Test-QueryStyleDeepObjectExplodeTrueObjectAllOf	GET /query/style_deepObject/explode_true/object/allOf	Test query parameter(s)
QueryApi	Test-QueryStyleFormExplodeFalseArrayInteger	GET /query/style_form/explode_false/array_integer	Test query parameter(s)
QueryApi	Test-QueryStyleFormExplodeFalseArrayString	GET /query/style_form/explode_false/array_string	Test query parameter(s)
QueryApi	Test-QueryStyleFormExplodeTrueArrayString	GET /query/style_form/explode_true/array_string	Test query parameter(s)
QueryApi	Test-QueryStyleFormExplodeTrueObject	GET /query/style_form/explode_true/object	Test query parameter(s)
QueryApi	Test-QueryStyleFormExplodeTrueObjectAllOf	GET /query/style_form/explode_true/object/allOf	Test query parameter(s)

Documentation for Models

• PSOpenAPITools\Model.Bird
• PSOpenAPITools\Model.Category
• PSOpenAPITools\Model.DataQuery
• PSOpenAPITools\Model.DefaultValue
• PSOpenAPITools\Model.NumberPropertiesOnly
• PSOpenAPITools\Model.Pet
• PSOpenAPITools\Model.Query
• PSOpenAPITools\Model.StringEnumRef
• PSOpenAPITools\Model.Tag
• PSOpenAPITools\Model.TestFormObjectMultipartRequestMarker
• PSOpenAPITools\Model.TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
• PSOpenAPITools\Model.TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter

Documentation for Authorization

Authentication schemes defined for the API:

http_auth

• Type: HTTP basic authentication

http_bearer_auth

• Type: HTTP Bearer Token authentication