openapi-generator/samples/client/petstore/powershell

PSPetstore - the PowerShell module for the OpenAPI Petstore

This is a sample server Petstore server. For this sample, you can use the api key special-key to test the authorization filters.

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

• API version: 1.0.0
• SDK version: 0.1.2
• Build package: org.openapitools.codegen.languages.PowerShellClientCodegen

Frameworks supported

• PowerShell 5.0 or later

Dependencies

Installation

To install from PowerShell Gallery (https://www.powershellgallery.com/packages/PSPetstore)

Import-Module -Name PSPetstore -Verbose

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

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

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

To uninstall the module, simply run:

Remove-Module -FullyQualifiedName @{ModuleName = "PSPetstore"; 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://petstore.swagger.io:80/v2

Class	Method	HTTP request	Description
PSPetApi	Add-PSPet	POST /pet	Add a new pet to the store
PSPetApi	Remove-Pet	DELETE /pet/{petId}	Deletes a pet
PSPetApi	Find-PSPetsByStatus	GET /pet/findByStatus	Finds Pets by status
PSPetApi	Find-PSPetsByTags	GET /pet/findByTags	Finds Pets by tags
PSPetApi	Get-PSPetById	GET /pet/{petId}	Find pet by ID
PSPetApi	Update-PSPet	PUT /pet	Update an existing pet
PSPetApi	Update-PSPetWithForm	POST /pet/{petId}	Updates a pet in the store with form data
PSPetApi	Invoke-PSUploadFile	POST /pet/{petId}/uploadImage	uploads an image
PSStoreApi	Remove-PSOrder	DELETE /store/order/{orderId}	Delete purchase order by ID
PSStoreApi	Get-PSInventory	GET /store/inventory	Returns pet inventories by status
PSStoreApi	Get-PSOrderById	GET /store/order/{orderId}	Find purchase order by ID
PSStoreApi	Invoke-PSPlaceOrder	POST /store/order	Place an order for a pet
PSUserApi	New-PSUser	POST /user	Create user
PSUserApi	New-PSUsersWithArrayInput	POST /user/createWithArray	Creates list of users with given input array
PSUserApi	New-PSUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
PSUserApi	Remove-PSUser	DELETE /user/{username}	Delete user
PSUserApi	Get-PSUserByName	GET /user/{username}	Get user by user name
PSUserApi	Invoke-PSLoginUser	GET /user/login	Logs user into the system
PSUserApi	Invoke-PSLogoutUser	GET /user/logout	Logs out current logged in user session
PSUserApi	Update-PSUser	PUT /user/{username}	Updated user

Documentation for Models

• PSPetstore/Model.ApiResponse
• PSPetstore/Model.Category
• PSPetstore/Model.Order
• PSPetstore/Model.Pet
• PSPetstore/Model.Tag
• PSPetstore/Model.User

Documentation for Authorization

api_key

• Type: API key

• API key parameter name: api_key

• Location: HTTP header

auth_cookie

• Type: API key

• API key parameter name: AUTH_KEY

• Location:

petstore_auth

• Type: OAuth
• Flow: implicit
• Authorization URL: http://petstore.swagger.io/api/oauth/dialog
• Scopes:
  • write:pets: modify pets in your account
  • read:pets: read your pets