openapi-generator/samples/client/petstore/java/default/docs/PetApi.md

PetApi

All URIs are relative to http://petstore.swagger.io/v2

Method	HTTP request	Description
addPet	POST /pet	Add a new pet to the store
addPetUsingByteArray	POST /pet?testing_byte_array=true	Fake endpoint to test byte array in body parameter for adding a new pet to the store
deletePet	DELETE /pet/{petId}	Deletes a pet
findPetsByStatus	GET /pet/findByStatus	Finds Pets by status
findPetsByTags	GET /pet/findByTags	Finds Pets by tags
getPetById	GET /pet/{petId}	Find pet by ID
getPetByIdInObject	GET /pet/{petId}?response=inline_arbitrary_object	Fake endpoint to test inline arbitrary object return by 'Find pet by ID'
petPetIdtestingByteArraytrueGet	GET /pet/{petId}?testing_byte_array=true	Fake endpoint to test byte array return by 'Find pet by ID'
updatePet	PUT /pet	Update an existing pet
updatePetWithForm	POST /pet/{petId}	Updates a pet in the store with form data
uploadFile	POST /pet/{petId}/uploadImage	uploads an image

addPet

addPet(body)

Add a new pet to the store

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: petstore_auth
OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

PetApi apiInstance = new PetApi();
Pet body = new Pet(); // Pet | Pet object that needs to be added to the store
try {
    apiInstance.addPet(body);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#addPet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	Pet	Pet object that needs to be added to the store	[optional]

Return type

null (empty response body)

Authorization

petstore_auth

HTTP reuqest headers

• Content-Type: application/json, application/xml
• Accept: application/json, application/xml

addPetUsingByteArray

addPetUsingByteArray(body)

Fake endpoint to test byte array in body parameter for adding a new pet to the store

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: petstore_auth
OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

PetApi apiInstance = new PetApi();
byte[] body = BINARY_DATA_HERE; // byte[] | Pet object in the form of byte array
try {
    apiInstance.addPetUsingByteArray(body);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#addPetUsingByteArray");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	byte[]	Pet object in the form of byte array	[optional]

Return type

null (empty response body)

Authorization

petstore_auth

HTTP reuqest headers

• Content-Type: application/json, application/xml
• Accept: application/json, application/xml

deletePet

deletePet(petId, apiKey)

Deletes a pet

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: petstore_auth
OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

PetApi apiInstance = new PetApi();
Long petId = 789L; // Long | Pet id to delete
String apiKey = "apiKey_example"; // String | 
try {
    apiInstance.deletePet(petId, apiKey);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#deletePet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
petId	Long	Pet id to delete
apiKey	String		[optional]

Return type

null (empty response body)

Authorization

petstore_auth

HTTP reuqest headers

• Content-Type: Not defined
• Accept: application/json, application/xml

findPetsByStatus

List<Pet> findPetsByStatus(status)

Finds Pets by status

Multiple status values can be provided with comma separated strings

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: petstore_auth
OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

PetApi apiInstance = new PetApi();
List<String> status = Arrays.asList("available"); // List<String> | Status values that need to be considered for query
try {
    List<Pet> result = apiInstance.findPetsByStatus(status);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#findPetsByStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
status	List<String>	Status values that need to be considered for query	[optional] [default to available]

Return type

List<Pet>

Authorization

petstore_auth

HTTP reuqest headers

• Content-Type: Not defined
• Accept: application/json, application/xml

findPetsByTags

List<Pet> findPetsByTags(tags)

Finds Pets by tags

Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: petstore_auth
OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

PetApi apiInstance = new PetApi();
List<String> tags = Arrays.asList("tags_example"); // List<String> | Tags to filter by
try {
    List<Pet> result = apiInstance.findPetsByTags(tags);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#findPetsByTags");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
tags	List<String>	Tags to filter by	[optional]

Return type

List<Pet>

Authorization

petstore_auth

HTTP reuqest headers

• Content-Type: Not defined
• Accept: application/json, application/xml

getPetById

Pet getPetById(petId)

Find pet by ID

Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: petstore_auth
OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

PetApi apiInstance = new PetApi();
Long petId = 789L; // Long | ID of pet that needs to be fetched
try {
    Pet result = apiInstance.getPetById(petId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#getPetById");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
petId	Long	ID of pet that needs to be fetched

Return type

Pet

Authorization

petstore_auth, api_key

HTTP reuqest headers

• Content-Type: Not defined
• Accept: application/json, application/xml

getPetByIdInObject

InlineResponse200 getPetByIdInObject(petId)

Fake endpoint to test inline arbitrary object return by 'Find pet by ID'

Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: petstore_auth
OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

PetApi apiInstance = new PetApi();
Long petId = 789L; // Long | ID of pet that needs to be fetched
try {
    InlineResponse200 result = apiInstance.getPetByIdInObject(petId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#getPetByIdInObject");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
petId	Long	ID of pet that needs to be fetched

Return type

InlineResponse200

Authorization

petstore_auth, api_key

HTTP reuqest headers

• Content-Type: Not defined
• Accept: application/json, application/xml

petPetIdtestingByteArraytrueGet

byte[] petPetIdtestingByteArraytrueGet(petId)

Fake endpoint to test byte array return by 'Find pet by ID'

Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: petstore_auth
OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

PetApi apiInstance = new PetApi();
Long petId = 789L; // Long | ID of pet that needs to be fetched
try {
    byte[] result = apiInstance.petPetIdtestingByteArraytrueGet(petId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#petPetIdtestingByteArraytrueGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
petId	Long	ID of pet that needs to be fetched

Return type

byte[]

Authorization

petstore_auth, api_key

HTTP reuqest headers

• Content-Type: Not defined
• Accept: application/json, application/xml

updatePet

updatePet(body)

Update an existing pet

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: petstore_auth
OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

PetApi apiInstance = new PetApi();
Pet body = new Pet(); // Pet | Pet object that needs to be added to the store
try {
    apiInstance.updatePet(body);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#updatePet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	Pet	Pet object that needs to be added to the store	[optional]

Return type

null (empty response body)

Authorization

petstore_auth

HTTP reuqest headers

• Content-Type: application/json, application/xml
• Accept: application/json, application/xml

updatePetWithForm

updatePetWithForm(petId, name, status)

Updates a pet in the store with form data

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: petstore_auth
OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

PetApi apiInstance = new PetApi();
String petId = "petId_example"; // String | ID of pet that needs to be updated
String name = "name_example"; // String | Updated name of the pet
String status = "status_example"; // String | Updated status of the pet
try {
    apiInstance.updatePetWithForm(petId, name, status);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#updatePetWithForm");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
petId	String	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

HTTP reuqest headers

• Content-Type: application/x-www-form-urlencoded
• Accept: application/json, application/xml

uploadFile

uploadFile(petId, additionalMetadata, file)

uploads an image

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: petstore_auth
OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

PetApi apiInstance = new PetApi();
Long petId = 789L; // Long | ID of pet to update
String additionalMetadata = "additionalMetadata_example"; // String | Additional data to pass to server
File file = new File("/path/to/file.txt"); // File | file to upload
try {
    apiInstance.uploadFile(petId, additionalMetadata, file);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#uploadFile");
    e.printStackTrace();
}

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

null (empty response body)

Authorization

petstore_auth

HTTP reuqest headers

• Content-Type: multipart/form-data
• Accept: application/json, application/xml