Skip to content
Inspironix APIs/
/pet

Swagger Petstore - OpenAPI 3.0 (1.0.20-SNAPSHOT)

This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at http://swagger.io. In the third iteration of the pet store, we've switched to the design first approach! You can now help us improve the API whether it's by making changes to the definition itself or to the code. That way, with time, we can improve the API in general, and expose some of the new features in OAS3.

Some useful links:

Find out more about Swagger
Download OpenAPI description
petstore.json
petstore.yaml
Overview
E-mail
apiteam@swagger.io
License
Apache 2.0
Terms of Service
Languages
Servers
Mock server
https://phronesis-inspironix.redocly.app/_mock/apis/pets-store-api/petstore
https://phronesis-inspironix.redocly.app/v3

pet

Everything about your Pets

Operations

Add a new pet to the store

Request

Add a new pet to the store

Security
petstore_auth(Required scopes:
write:pets
read:pets
)
Body
required

Create a new pet in the store

idinteger(int64)
Example: 10
namestringrequired
Example: "doggie"
categoryobject(Category)
photoUrlsArray of stringsrequired
tagsArray of objects(Tag)
statusstring

pet status in the store

Enum"available""pending""sold"
curl -i -X POST \
  https://phronesis-inspironix.redocly.app/_mock/apis/pets-store-api/petstore/pet \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 10,
    "name": "doggie",
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "photoUrls": [
      "string"
    ],
    "tags": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "status": "available"
  }'

Responses

Successful operation

Body
idinteger(int64)
Example: 10
namestringrequired
Example: "doggie"
categoryobject(Category)
photoUrlsArray of stringsrequired
tagsArray of objects(Tag)
statusstring

pet status in the store

Enum"available""pending""sold"
Response
<pet>
  <id>10</id>
  <name>doggie</name>
  <category>
    <id>1</id>
    <name>Dogs</name>
  </category>
  <photoUrls>
    <photoUrl>string</photoUrl>
  </photoUrls>
  <tags>
    <tag>
      <id>0</id>
      <name>string</name>
    </tag>
  </tags>
  <status>available</status>
</pet>

Update an existing pet

Request

Update an existing pet by Id

Security
petstore_auth(Required scopes:
write:pets
read:pets
)
Body
required

Update an existent pet in the store

idinteger(int64)
Example: 10
namestringrequired
Example: "doggie"
categoryobject(Category)
photoUrlsArray of stringsrequired
tagsArray of objects(Tag)
statusstring

pet status in the store

Enum"available""pending""sold"
curl -i -X PUT \
  https://phronesis-inspironix.redocly.app/_mock/apis/pets-store-api/petstore/pet \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 10,
    "name": "doggie",
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "photoUrls": [
      "string"
    ],
    "tags": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "status": "available"
  }'

Responses

Successful operation

Body
idinteger(int64)
Example: 10
namestringrequired
Example: "doggie"
categoryobject(Category)
photoUrlsArray of stringsrequired
tagsArray of objects(Tag)
statusstring

pet status in the store

Enum"available""pending""sold"
Response
<pet>
  <id>10</id>
  <name>doggie</name>
  <category>
    <id>1</id>
    <name>Dogs</name>
  </category>
  <photoUrls>
    <photoUrl>string</photoUrl>
  </photoUrls>
  <tags>
    <tag>
      <id>0</id>
      <name>string</name>
    </tag>
  </tags>
  <status>available</status>
</pet>

Finds Pets by status

Request

Multiple status values can be provided with comma separated strings

Security
petstore_auth(Required scopes:
write:pets
read:pets
)
Query
statusstring

Status values that need to be considered for filter

Default "available"
Enum"available""pending""sold"
curl -i -X GET \
  'https://phronesis-inspironix.redocly.app/_mock/apis/pets-store-api/petstore/pet/findByStatus?status=available' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Body
Array [
idinteger(int64)
Example: 10
namestringrequired
Example: "doggie"
categoryobject(Category)
photoUrlsArray of stringsrequired
tagsArray of objects(Tag)
statusstring

pet status in the store

Enum"available""pending""sold"
]
Response
<pet>
  <id>10</id>
  <name>doggie</name>
  <category>
    <id>1</id>
    <name>Dogs</name>
  </category>
  <photoUrls>
    <photoUrl>string</photoUrl>
  </photoUrls>
  <tags>
    <tag>
      <id>0</id>
      <name>string</name>
    </tag>
  </tags>
  <status>available</status>
</pet>

Finds Pets by tags

Request

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

Security
petstore_auth(Required scopes:
write:pets
read:pets
)
Query
tagsArray of strings

Tags to filter by

curl -i -X GET \
  'https://phronesis-inspironix.redocly.app/_mock/apis/pets-store-api/petstore/pet/findByTags?tags=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Body
Array [
idinteger(int64)
Example: 10
namestringrequired
Example: "doggie"
categoryobject(Category)
photoUrlsArray of stringsrequired
tagsArray of objects(Tag)
statusstring

pet status in the store

Enum"available""pending""sold"
]
Response
<pet>
  <id>10</id>
  <name>doggie</name>
  <category>
    <id>1</id>
    <name>Dogs</name>
  </category>
  <photoUrls>
    <photoUrl>string</photoUrl>
  </photoUrls>
  <tags>
    <tag>
      <id>0</id>
      <name>string</name>
    </tag>
  </tags>
  <status>available</status>
</pet>

Find pet by ID

Request

Returns a single pet

Security
api_key or petstore_auth(Required scopes:
write:pets
read:pets
)
Path
petIdinteger(int64)required

ID of pet to return

curl -i -X GET \
  'https://phronesis-inspironix.redocly.app/_mock/apis/pets-store-api/petstore/pet/{petId}' \
  -H 'api_key: YOUR_API_KEY_HERE'

Responses

successful operation

Body
idinteger(int64)
Example: 10
namestringrequired
Example: "doggie"
categoryobject(Category)
photoUrlsArray of stringsrequired
tagsArray of objects(Tag)
statusstring

pet status in the store

Enum"available""pending""sold"
Response
<pet>
  <id>10</id>
  <name>doggie</name>
  <category>
    <id>1</id>
    <name>Dogs</name>
  </category>
  <photoUrls>
    <photoUrl>string</photoUrl>
  </photoUrls>
  <tags>
    <tag>
      <id>0</id>
      <name>string</name>
    </tag>
  </tags>
  <status>available</status>
</pet>

Updates a pet in the store with form data

Request

Security
petstore_auth(Required scopes:
write:pets
read:pets
)
Path
petIdinteger(int64)required

ID of pet that needs to be updated

Query
namestring

Name of pet that needs to be updated

statusstring

Status of pet that needs to be updated

curl -i -X POST \
  'https://phronesis-inspironix.redocly.app/_mock/apis/pets-store-api/petstore/pet/{petId}?name=string&status=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Invalid input

Deletes a pet

Request

Security
petstore_auth(Required scopes:
write:pets
read:pets
)
Path
petIdinteger(int64)required

Pet id to delete

Headers
api_keystring
curl -i -X DELETE \
  'https://phronesis-inspironix.redocly.app/_mock/apis/pets-store-api/petstore/pet/{petId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'api_key: string'

Responses

Invalid pet value

uploads an image

Request

Security
petstore_auth(Required scopes:
write:pets
read:pets
)
Path
petIdinteger(int64)required

ID of pet to update

Query
additionalMetadatastring

Additional Metadata

Bodyapplication/octet-stream
string(binary)
curl -i -X POST \
  'https://phronesis-inspironix.redocly.app/_mock/apis/pets-store-api/petstore/pet/{petId}/uploadImage?additionalMetadata=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/octet-stream' \
  -d string

Responses

successful operation

Bodyapplication/json
codeinteger(int32)
typestring
messagestring
Response
application/json
{
  "code": 0,
  "type": "string",
  "message": "string"
}

store

Access to Petstore orders

Operations

user

Operations about user

Operations