# PetApi All URIs are relative to *http://petstore.swagger.io:80/v2* Method | HTTP request | Description ------------- | ------------- | ------------- [**addPet**](PetApi.md#addPet) | **POST** /pet | Add a new pet to the store [**deletePet**](PetApi.md#deletePet) | **DELETE** /pet/{petId} | Deletes a pet [**findPetsByStatus**](PetApi.md#findPetsByStatus) | **GET** /pet/findByStatus | Finds Pets by status [**findPetsByTags**](PetApi.md#findPetsByTags) | **GET** /pet/findByTags | Finds Pets by tags [**getPetById**](PetApi.md#getPetById) | **GET** /pet/{petId} | Find pet by ID [**updatePet**](PetApi.md#updatePet) | **PUT** /pet | Update an existing pet [**updatePetWithForm**](PetApi.md#updatePetWithForm) | **POST** /pet/{petId} | Updates a pet in the store with form data [**uploadFile**](PetApi.md#uploadFile) | **POST** /pet/{petId}/uploadImage | uploads an image [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) # **addPet** > addPet(body) Add a new pet to the store ### Example ```java // Import classes: //import org.openapitools.client.ApiClient; //import io.restassured.builder.RequestSpecBuilder; //import io.restassured.filter.log.ErrorLoggingFilter; PetApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier( () -> new RequestSpecBuilder() .setBaseUri("http://petstore.swagger.io:80/v2"))).pet(); api.addPet() .body(body).execute(r -> r.prettyPeek()); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | ### Return type null (empty response body) ### Authorization [petstore_auth](../README.md#petstore_auth) ### HTTP request headers - **Content-Type**: application/json, application/xml - **Accept**: Not defined # **deletePet** > deletePet(petId, apiKey) Deletes a pet ### Example ```java // Import classes: //import org.openapitools.client.ApiClient; //import io.restassured.builder.RequestSpecBuilder; //import io.restassured.filter.log.ErrorLoggingFilter; PetApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier( () -> new RequestSpecBuilder() .setBaseUri("http://petstore.swagger.io:80/v2"))).pet(); api.deletePet() .petIdPath(petId).execute(r -> r.prettyPeek()); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| Pet id to delete | **apiKey** | **String**| | [optional] ### Return type null (empty response body) ### Authorization [petstore_auth](../README.md#petstore_auth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined # **findPetsByStatus** > List<Pet> findPetsByStatus(status) Finds Pets by status Multiple status values can be provided with comma separated strings ### Example ```java // Import classes: //import org.openapitools.client.ApiClient; //import io.restassured.builder.RequestSpecBuilder; //import io.restassured.filter.log.ErrorLoggingFilter; PetApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier( () -> new RequestSpecBuilder() .setBaseUri("http://petstore.swagger.io:80/v2"))).pet(); api.findPetsByStatus() .statusQuery(status).execute(r -> r.prettyPeek()); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [default to new ArrayList<String>()] [enum: available, pending, sold] ### Return type [**List<Pet>**](Pet.md) ### Authorization [petstore_auth](../README.md#petstore_auth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/xml, application/json # **findPetsByTags** > Set<Pet> findPetsByTags(tags) Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. ### Example ```java // Import classes: //import org.openapitools.client.ApiClient; //import io.restassured.builder.RequestSpecBuilder; //import io.restassured.filter.log.ErrorLoggingFilter; PetApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier( () -> new RequestSpecBuilder() .setBaseUri("http://petstore.swagger.io:80/v2"))).pet(); api.findPetsByTags() .tagsQuery(tags).execute(r -> r.prettyPeek()); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**Set<String>**](String.md)| Tags to filter by | [default to new LinkedHashSet<String>()] ### Return type [**Set<Pet>**](Pet.md) ### Authorization [petstore_auth](../README.md#petstore_auth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/xml, application/json # **getPetById** > Pet getPetById(petId) Find pet by ID Returns a single pet ### Example ```java // Import classes: //import org.openapitools.client.ApiClient; //import io.restassured.builder.RequestSpecBuilder; //import io.restassured.filter.log.ErrorLoggingFilter; PetApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier( () -> new RequestSpecBuilder() .setBaseUri("http://petstore.swagger.io:80/v2"))).pet(); api.getPetById() .petIdPath(petId).execute(r -> r.prettyPeek()); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to return | ### Return type [**Pet**](Pet.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/xml, application/json # **updatePet** > updatePet(body) Update an existing pet ### Example ```java // Import classes: //import org.openapitools.client.ApiClient; //import io.restassured.builder.RequestSpecBuilder; //import io.restassured.filter.log.ErrorLoggingFilter; PetApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier( () -> new RequestSpecBuilder() .setBaseUri("http://petstore.swagger.io:80/v2"))).pet(); api.updatePet() .body(body).execute(r -> r.prettyPeek()); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | ### Return type null (empty response body) ### Authorization [petstore_auth](../README.md#petstore_auth) ### HTTP request headers - **Content-Type**: application/json, application/xml - **Accept**: Not defined # **updatePetWithForm** > updatePetWithForm(petId, name, status) Updates a pet in the store with form data ### Example ```java // Import classes: //import org.openapitools.client.ApiClient; //import io.restassured.builder.RequestSpecBuilder; //import io.restassured.filter.log.ErrorLoggingFilter; PetApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier( () -> new RequestSpecBuilder() .setBaseUri("http://petstore.swagger.io:80/v2"))).pet(); api.updatePetWithForm() .petIdPath(petId).execute(r -> r.prettyPeek()); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet that needs to be updated | **name** | **String**| Updated name of the pet | [optional] **status** | **String**| Updated status of the pet | [optional] ### Return type null (empty response body) ### Authorization [petstore_auth](../README.md#petstore_auth) ### HTTP request headers - **Content-Type**: application/x-www-form-urlencoded - **Accept**: Not defined # **uploadFile** > ModelApiResponse uploadFile(petId, additionalMetadata, file) uploads an image ### Example ```java // Import classes: //import org.openapitools.client.ApiClient; //import io.restassured.builder.RequestSpecBuilder; //import io.restassured.filter.log.ErrorLoggingFilter; PetApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier( () -> new RequestSpecBuilder() .setBaseUri("http://petstore.swagger.io:80/v2"))).pet(); api.uploadFile() .petIdPath(petId).execute(r -> r.prettyPeek()); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | **additionalMetadata** | **String**| Additional data to pass to server | [optional] **file** | **File**| file to upload | [optional] ### Return type [**ModelApiResponse**](ModelApiResponse.md) ### Authorization [petstore_auth](../README.md#petstore_auth) ### HTTP request headers - **Content-Type**: multipart/form-data - **Accept**: application/json # **uploadFileWithRequiredFile** > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) uploads an image (required) ### Example ```java // Import classes: //import org.openapitools.client.ApiClient; //import io.restassured.builder.RequestSpecBuilder; //import io.restassured.filter.log.ErrorLoggingFilter; PetApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier( () -> new RequestSpecBuilder() .setBaseUri("http://petstore.swagger.io:80/v2"))).pet(); api.uploadFileWithRequiredFile() .petIdPath(petId) .requiredFileMultiPart(requiredFile).execute(r -> r.prettyPeek()); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | **requiredFile** | **File**| file to upload | **additionalMetadata** | **String**| Additional data to pass to server | [optional] ### Return type [**ModelApiResponse**](ModelApiResponse.md) ### Authorization [petstore_auth](../README.md#petstore_auth) ### HTTP request headers - **Content-Type**: multipart/form-data - **Accept**: application/json