openapi-generator/samples/client/petstore/javascript-promise/docs/PetApi.md

SwaggerPetstore.PetApi

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

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

addPet

addPet(body)

Add a new pet to the store

Example

var SwaggerPetstore = require('swagger_petstore');
var defaultClient = SwaggerPetstore.ApiClient.instance;

// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SwaggerPetstore.PetApi();

var body = new SwaggerPetstore.Pet(); // Pet | Pet object that needs to be added to the store

apiInstance.addPet(body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

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

Return type

null (empty response body)

Authorization

petstore_auth

HTTP request headers

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

deletePet

deletePet(petId, opts)

Deletes a pet

Example

var SwaggerPetstore = require('swagger_petstore');
var defaultClient = SwaggerPetstore.ApiClient.instance;

// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SwaggerPetstore.PetApi();

var petId = 789; // Number | Pet id to delete

var opts = { 
  'apiKey': "apiKey_example" // String | 
};
apiInstance.deletePet(petId, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

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

Return type

null (empty response body)

Authorization

petstore_auth

HTTP request headers

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

findPetsByStatus

[Pet] findPetsByStatus(status)

Finds Pets by status

Multiple status values can be provided with comma separated strings

Example

var SwaggerPetstore = require('swagger_petstore');
var defaultClient = SwaggerPetstore.ApiClient.instance;

// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SwaggerPetstore.PetApi();

var status = ["status_example"]; // [String] | Status values that need to be considered for filter

apiInstance.findPetsByStatus(status).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
status	[String]	Status values that need to be considered for filter

Return type

[Pet]

Authorization

petstore_auth

HTTP request headers

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

findPetsByTags

[Pet] findPetsByTags(tags)

Finds Pets by tags

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

Example

var SwaggerPetstore = require('swagger_petstore');
var defaultClient = SwaggerPetstore.ApiClient.instance;

// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SwaggerPetstore.PetApi();

var tags = ["tags_example"]; // [String] | Tags to filter by

apiInstance.findPetsByTags(tags).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

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

Return type

[Pet]

Authorization

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

var SwaggerPetstore = require('swagger_petstore');
var defaultClient = SwaggerPetstore.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new SwaggerPetstore.PetApi();

var petId = 789; // Number | ID of pet to return

apiInstance.getPetById(petId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
petId	Number	ID of pet to return

Return type

Pet

Authorization

api_key

HTTP request headers

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

updatePet

updatePet(body)

Update an existing pet

Example

var SwaggerPetstore = require('swagger_petstore');
var defaultClient = SwaggerPetstore.ApiClient.instance;

// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SwaggerPetstore.PetApi();

var body = new SwaggerPetstore.Pet(); // Pet | Pet object that needs to be added to the store

apiInstance.updatePet(body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

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

Return type

null (empty response body)

Authorization

petstore_auth

HTTP request headers

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

updatePetWithForm

updatePetWithForm(petId, opts)

Updates a pet in the store with form data

Example

var SwaggerPetstore = require('swagger_petstore');
var defaultClient = SwaggerPetstore.ApiClient.instance;

// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SwaggerPetstore.PetApi();

var petId = 789; // Number | ID of pet that needs to be updated

var opts = { 
  'name': "name_example", // String | Updated name of the pet
  'status': "status_example" // String | Updated status of the pet
};
apiInstance.updatePetWithForm(petId, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
petId	Number	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 request headers

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

uploadFile

ApiResponse uploadFile(petId, opts)

uploads an image

Example

var SwaggerPetstore = require('swagger_petstore');
var defaultClient = SwaggerPetstore.ApiClient.instance;

// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SwaggerPetstore.PetApi();

var petId = 789; // Number | ID of pet to update

var opts = { 
  'additionalMetadata': "additionalMetadata_example", // String | Additional data to pass to server
  'file': "/path/to/file.txt" // File | file to upload
};
apiInstance.uploadFile(petId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
petId	Number	ID of pet to update
additionalMetadata	String	Additional data to pass to server	[optional]
file	File	file to upload	[optional]

Return type

ApiResponse

Authorization

petstore_auth

HTTP request headers

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