PetStore.API.Swagger

Contents

• Order
  • Status
• Pet
  • Status
• PetControllerBase
  • AddPet(body)
  • DeletePet(petId)
  • FindPetsByStatus(status)
  • FindPetsByTags(tags)
  • GetPetById(petId)
  • UpdatePet(body)
  • UpdatePetWithForm(petId,name,status)
  • UploadFile(petId,additionalMetadata,file)
• StoreControllerBase
  • DeleteOrder(orderId)
  • GetInventory()
  • GetOrderById(orderId)
  • PlaceOrder(body)
• User
  • UserStatus
• UserControllerBase
  • CreateUser(body)
  • CreateUsersWithArrayInput(body)
  • CreateUsersWithListInput(body)
  • DeleteUser(username)
  • GetUserByName(username)
  • LoginUser(username,password)
  • LogoutUser()
  • UpdateUser(username,body)

Order type

Namespace

PetStore.API.Swagger.Controllers.Generated

Status property

Summary

Order Status

Pet type

Namespace

PetStore.API.Swagger.Controllers.Generated

Status property

Summary

pet status in the store

PetControllerBase type

Namespace

PetStore.API.Swagger.Controllers.Generated

AddPet(body) method

Summary

Add a new pet to the store

Parameters

Name	Type	Description
body	PetStore.API.Swagger.Controllers.Generated.Pet	Pet object that needs to be added to the store

DeletePet(petId) method

Summary

Deletes a pet

Parameters

Name	Type	Description
petId	System.String	Pet id to delete

FindPetsByStatus(status) method

Summary

Finds Pets by status

Returns

successful operation

Parameters

Name	Type	Description
status	System.Collections.Generic.IEnumerable{PetStore.API.Swagger.Controllers.Generated.Anonymous}	Status values that need to be considered for filter

FindPetsByTags(tags) method

Summary

Finds Pets by tags

Returns

successful operation

Parameters

Name	Type	Description
tags	System.Collections.Generic.IEnumerable{System.String}	Tags to filter by

GetPetById(petId) method

Summary

Find pet by ID

Returns

successful operation

Parameters

Name	Type	Description
petId	System.Int64	ID of pet to return

UpdatePet(body) method

Summary

Update an existing pet

Parameters

Name	Type	Description
body	PetStore.API.Swagger.Controllers.Generated.Pet	Pet object that needs to be added to the store

UpdatePetWithForm(petId,name,status) method

Summary

Updates a pet in the store with form data

Parameters

Name	Type	Description
petId	System.Int64	ID of pet that needs to be updated
name	System.String	Updated name of the pet
status	System.String	Updated status of the pet

UploadFile(petId,additionalMetadata,file) method

Summary

uploads an image

Returns

successful operation

Parameters

Name	Type	Description
petId	System.Int64	ID of pet to update
additionalMetadata	System.String	Additional data to pass to server
file	PetStore.API.Swagger.Controllers.Generated.FileParameter	file to upload

StoreControllerBase type

Namespace

PetStore.API.Swagger.Controllers.Generated

DeleteOrder(orderId) method

Summary

Delete purchase order by ID

Parameters

Name	Type	Description
orderId	System.Int64	ID of the order that needs to be deleted

GetInventory() method

Summary

Returns pet inventories by status

Returns

successful operation

Parameters

This method has no parameters.

GetOrderById(orderId) method

Summary

Find purchase order by ID

Returns

successful operation

Parameters

Name	Type	Description
orderId	System.Int64	ID of pet that needs to be fetched

PlaceOrder(body) method

Summary

Place an order for a pet

Returns

successful operation

Parameters

Name	Type	Description
body	PetStore.API.Swagger.Controllers.Generated.Order	order placed for purchasing the pet

User type

Namespace

PetStore.API.Swagger.Controllers.Generated

UserStatus property

Summary

User Status

UserControllerBase type

Namespace

PetStore.API.Swagger.Controllers.Generated

CreateUser(body) method

Summary

Create user

Returns

successful operation

Parameters

Name	Type	Description
body	PetStore.API.Swagger.Controllers.Generated.User	Created user object

CreateUsersWithArrayInput(body) method

Summary

Creates list of users with given input array

Returns

successful operation

Parameters

Name	Type	Description
body	System.Collections.Generic.IEnumerable{PetStore.API.Swagger.Controllers.Generated.User}	List of user object

CreateUsersWithListInput(body) method

Summary

Creates list of users with given input array

Returns

successful operation

Parameters

Name	Type	Description
body	System.Collections.Generic.IEnumerable{PetStore.API.Swagger.Controllers.Generated.User}	List of user object

DeleteUser(username) method

Summary

Delete user

Parameters

Name	Type	Description
username	System.String	The name that needs to be deleted

GetUserByName(username) method

Summary

Get user by user name

Returns

successful operation

Parameters

Name	Type	Description
username	System.String	The name that needs to be fetched. Use user1 for testing.

LoginUser(username,password) method

Summary

Logs user into the system

Returns

successful operation

Parameters

Name	Type	Description
username	System.String	The user name for login
password	System.String	The password for login in clear text

LogoutUser() method

Summary

Logs out current logged in user session

Returns

successful operation

Parameters

This method has no parameters.

UpdateUser(username,body) method

Summary

Updated user

Parameters

Name	Type	Description
username	System.String	name that need to be updated
body	PetStore.API.Swagger.Controllers.Generated.User	Updated user object