OpenAPI\Client\PetApi

All URIs are relative to http://petstore.swagger.io:80/v2, except if the operation defines another base path.

Method	HTTP request	Description
addPet()	POST /pet	Add 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
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
uploadFileWithRequiredFile()	POST /fake/{petId}/uploadImageWithRequiredFile	uploads an image (required)

`addPet()`

addPet($pet)

URI(s):

http://localhost/v2 - http://petstore.swagger.io/v2 - http://path-server-test.petstore.local/v2 - http://{server}.swagger.io:{port}/v2 test server with variables
- Variables:
  - server: target server
    - Allowed values:
      - petstore
      - qa-petstore
      - dev-petstore
    - Default value: petstore
  - port: No description provided
    - Allowed values:
      - 80
      - 8080
    - Default value: 80

Add a new pet to the store

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: petstore_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\PetApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pet = new \OpenAPI\Client\Model\Pet(); // \OpenAPI\Client\Model\Pet | Pet object that needs to be added to the store

$hostIndex = 0;
$variables = [
];

try {
    $apiInstance->addPet($pet, $hostIndex, $variables);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->addPet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pet	\OpenAPI\Client\Model\Pet	Pet object that needs to be added to the store
hostIndex	null	int	Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
variables	array	Associative array of variables to pass to the host. Defaults to empty array.	[optional]

Return type

void (empty response body)

Authorization

petstore_auth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deletePet()`

deletePet($pet_id, $api_key)

Deletes a pet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: petstore_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\PetApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pet_id = 56; // int | Pet id to delete
$api_key = 'api_key_example'; // string

try {
    $apiInstance->deletePet($pet_id, $api_key);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->deletePet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pet_id	int	Pet id to delete
api_key	string		[optional]

Return type

void (empty response body)

Authorization

petstore_auth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`findPetsByStatus()`

findPetsByStatus($status): \OpenAPI\Client\Model\Pet[]

Finds Pets by status

Multiple status values can be provided with comma separated strings

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: petstore_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\PetApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$status = ['available']; // string[] | Status values that need to be considered for filter

try {
    $result = $apiInstance->findPetsByStatus($status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->findPetsByStatus: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
status	string[]	Status values that need to be considered for filter	[default to ['available']]

Return type

\OpenAPI\Client\Model\Pet[]

Authorization

petstore_auth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`findPetsByTags()`

findPetsByTags($tags): \OpenAPI\Client\Model\Pet[]

Finds Pets by tags

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: petstore_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\PetApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tags = array('tags_example'); // string[] | Tags to filter by

try {
    $result = $apiInstance->findPetsByTags($tags);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->findPetsByTags: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
tags	string[]	Tags to filter by

Return type

\OpenAPI\Client\Model\Pet[]

Authorization

petstore_auth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getPetById()`

getPetById($pet_id): \OpenAPI\Client\Model\Pet

Find pet by ID

Returns a single pet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\PetApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pet_id = 56; // int | ID of pet to return

try {
    $result = $apiInstance->getPetById($pet_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->getPetById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pet_id	int	ID of pet to return

Return type

\OpenAPI\Client\Model\Pet

Authorization

api_key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updatePet()`

updatePet($pet)

URI(s):

http://localhost/v2 - http://petstore.swagger.io/v2 - http://path-server-test.petstore.local/v2 - http://{server}.swagger.io:{port}/v2 test server with variables
- Variables:
  - server: target server
    - Allowed values:
      - petstore
      - qa-petstore
      - dev-petstore
    - Default value: petstore
  - port: No description provided
    - Allowed values:
      - 80
      - 8080
    - Default value: 80

Update an existing pet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: petstore_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\PetApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pet = new \OpenAPI\Client\Model\Pet(); // \OpenAPI\Client\Model\Pet | Pet object that needs to be added to the store

$hostIndex = 0;
$variables = [
];

try {
    $apiInstance->updatePet($pet, $hostIndex, $variables);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->updatePet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pet	\OpenAPI\Client\Model\Pet	Pet object that needs to be added to the store
hostIndex	null	int	Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
variables	array	Associative array of variables to pass to the host. Defaults to empty array.	[optional]

Return type

void (empty response body)

Authorization

petstore_auth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updatePetWithForm()`

updatePetWithForm($pet_id, $name, $status)

Updates a pet in the store with form data

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: petstore_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\PetApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pet_id = 56; // int | ID of pet that needs to be updated
$name = 'name_example'; // string | Updated name of the pet
$status = 'status_example'; // string | Updated status of the pet

try {
    $apiInstance->updatePetWithForm($pet_id, $name, $status);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->updatePetWithForm: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pet_id	int	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

void (empty response body)

Authorization

petstore_auth

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`uploadFile()`

uploadFile($pet_id, $additional_metadata, $file): \OpenAPI\Client\Model\ApiResponse

uploads an image

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: petstore_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\PetApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pet_id = 56; // int | ID of pet to update
$additional_metadata = 'additional_metadata_example'; // string | Additional data to pass to server
$file = '/path/to/file.txt'; // \SplFileObject | file to upload

try {
    $result = $apiInstance->uploadFile($pet_id, $additional_metadata, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->uploadFile: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pet_id	int	ID of pet to update
additional_metadata	string	Additional data to pass to server	[optional]
file	\SplFileObject\SplFileObject	file to upload	[optional]

Return type

\OpenAPI\Client\Model\ApiResponse

Authorization

petstore_auth

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`uploadFileWithRequiredFile()`

uploadFileWithRequiredFile($pet_id, $required_file, $additional_metadata): \OpenAPI\Client\Model\ApiResponse

uploads an image (required)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: petstore_auth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\PetApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pet_id = 56; // int | ID of pet to update
$required_file = '/path/to/file.txt'; // \SplFileObject | file to upload
$additional_metadata = 'additional_metadata_example'; // string | Additional data to pass to server

try {
    $result = $apiInstance->uploadFileWithRequiredFile($pet_id, $required_file, $additional_metadata);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->uploadFileWithRequiredFile: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pet_id	int	ID of pet to update
required_file	\SplFileObject\SplFileObject	file to upload
additional_metadata	string	Additional data to pass to server	[optional]

Return type

\OpenAPI\Client\Model\ApiResponse

Authorization

petstore_auth

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

PetApi.md

Latest commit

History

PetApi.md

File metadata and controls

OpenAPI\Client\PetApi

addPet()

URI(s):

Example

Parameters

Return type

Authorization

HTTP request headers

deletePet()

Example

Parameters

Return type

Authorization

HTTP request headers

findPetsByStatus()

Example

Parameters

Return type

Authorization

HTTP request headers

findPetsByTags()

Example

Parameters

Return type

Authorization

HTTP request headers

getPetById()

Example

Parameters

Return type

Authorization

HTTP request headers

updatePet()

URI(s):

Example

Parameters

Return type

Authorization

HTTP request headers

updatePetWithForm()

Example

Parameters

Return type

Authorization

HTTP request headers

uploadFile()

Example

Parameters

Return type

Authorization

HTTP request headers

uploadFileWithRequiredFile()

Example

Parameters

Return type

Authorization

HTTP request headers

`addPet()`

`deletePet()`

`findPetsByStatus()`

`findPetsByTags()`

`getPetById()`

`updatePet()`

`updatePetWithForm()`

`uploadFile()`

`uploadFileWithRequiredFile()`