Skip to content

README.md

Latest commit

 

History

History
230 lines (187 loc) · 12.7 KB

README.md

File metadata and controls

230 lines (187 loc) · 12.7 KB

PSPetstore - the PowerShell module for the OpenAPI Petstore

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: " \

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

  • API version: 1.0.0
  • SDK version: 0.1.2
  • Generator version: 7.20.0-SNAPSHOT
  • 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://localhost/v2

Class Method HTTP request Description
PSAnotherFakeApi Invoke-PS123TestSpecialTags PATCH /another-fake/dummy To test special tags
PSDefaultApi Invoke-PSFooGet GET /foo
PSFakeApi Invoke-PSFakeHealthGet GET /fake/health Health check endpoint
PSFakeApi Invoke-PSFakeOuterBooleanSerialize POST /fake/outer/boolean
PSFakeApi Invoke-PSFakeOuterCompositeSerialize POST /fake/outer/composite
PSFakeApi Invoke-PSFakeOuterNumberSerialize POST /fake/outer/number
PSFakeApi Invoke-PSFakeOuterStringSerialize POST /fake/outer/string
PSFakeApi Get-PSArrayOfEnums GET /fake/array-of-enums Array of Enums
PSFakeApi Test-PSAdditionalPropertiesReference POST /fake/additionalProperties-reference test referenced additionalProperties
PSFakeApi Test-PSBodyWithFileSchema PUT /fake/body-with-file-schema
PSFakeApi Test-PSBodyWithQueryParams PUT /fake/body-with-query-params
PSFakeApi Test-PSClientModel PATCH /fake To test ""client"" model
PSFakeApi Test-PSEndpointParameters POST /fake Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
PSFakeApi Test-PSEnumParameters GET /fake To test enum parameters
PSFakeApi Test-PSGroupParameters DELETE /fake Fake endpoint to test group parameters (optional)
PSFakeApi Test-PSInlineAdditionalProperties POST /fake/inline-additionalProperties test inline additionalProperties
PSFakeApi Test-PSInlineFreeformAdditionalProperties POST /fake/inline-freeform-additionalProperties test inline free-form additionalProperties
PSFakeApi Test-PSJsonFormData GET /fake/jsonFormData test json serialization of form data
PSFakeApi Test-PSQueryParameterCollectionFormat PUT /fake/test-query-parameters
PSFakeApi Test-PSStringMapReference POST /fake/stringMap-reference test referenced string map
PSFakeClassnameTags123Api Test-PSClassname PATCH /fake_classname_test To test class name in snake case
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
PSPetApi Invoke-PSUploadFileWithRequiredFile POST /fake/{petId}/uploadImageWithRequiredFile uploads an image (required)
PSStoreApi Remove-PSOrder DELETE /store/order/{order_id} Delete purchase order by ID
PSStoreApi Get-PSInventory GET /store/inventory Returns pet inventories by status
PSStoreApi Get-PSOrderById GET /store/order/{order_id} 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

Documentation for Authorization

Authentication schemes defined for the API:

petstore_auth

api_key

  • Type: API key

  • API key parameter name: api_key_name

  • Location: HTTP header

api_key_query

  • Type: API key

  • API key parameter name: api_key_query_name

  • Location: URL query string

http_basic_test

  • Type: HTTP basic authentication

bearer_test

  • Type: HTTP Bearer Token authentication (JWT)

http_signature_test

  • Type: HTTP signature authentication