2021-05-30 11:43:31 +02:00
openapi : 3.0 .0
info :
2022-02-08 13:31:20 +08:00
description : "This is a sample server Petstore server. For this sample, you can\
\ use the api key `special-key` to test the authorization filters."
2021-05-30 11:43:31 +02:00
license :
name : Apache-2.0
url : https://www.apache.org/licenses/LICENSE-2.0.html
title : OpenAPI Petstore
version : 1.0 .0
externalDocs :
description : Find out more about Swagger
url : http://swagger.io
servers :
- url : http://petstore.swagger.io/v2
tags :
- description : Everything about your Pets
name : pet
- description : Access to Petstore orders
name : store
- description : Operations about user
name : user
paths :
/pet :
post :
2022-02-21 18:37:52 +08:00
description : ""
2021-05-30 11:43:31 +02:00
operationId : addPet
requestBody :
2025-06-02 15:33:27 +08:00
$ref : "#/components/requestBodies/Pet"
2021-05-30 11:43:31 +02:00
responses :
"200" :
content :
application/xml :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Pet"
2021-05-30 11:43:31 +02:00
application/json :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Pet"
2021-05-30 11:43:31 +02:00
description : successful operation
"405" :
description : Invalid input
security :
- petstore_auth :
- write:pets
- read:pets
summary : Add a new pet to the store
tags :
- pet
put :
2022-02-21 18:37:52 +08:00
description : ""
2023-01-04 03:15:23 +01:00
externalDocs :
description : API documentation for the updatePet operation
url : http://petstore.swagger.io/v2/doc/updatePet
2021-05-30 11:43:31 +02:00
operationId : updatePet
requestBody :
2025-06-02 15:33:27 +08:00
$ref : "#/components/requestBodies/Pet"
2021-05-30 11:43:31 +02:00
responses :
"200" :
content :
application/xml :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Pet"
2021-05-30 11:43:31 +02:00
application/json :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Pet"
2021-05-30 11:43:31 +02:00
description : successful operation
"400" :
description : Invalid ID supplied
"404" :
description : Pet not found
"405" :
description : Validation exception
security :
- petstore_auth :
- write:pets
- read:pets
summary : Update an existing pet
tags :
- pet
/pet/findByStatus :
get :
description : Multiple status values can be provided with comma separated strings
operationId : findPetsByStatus
parameters :
2021-08-03 19:11:16 +10:00
- deprecated : true
description : Status values that need to be considered for filter
2021-05-30 11:43:31 +02:00
explode : false
in : query
name : status
required : true
schema :
items :
default : available
enum :
- available
- pending
- sold
type : string
type : array
style : form
responses :
"200" :
content :
application/xml :
schema :
items :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Pet"
2021-05-30 11:43:31 +02:00
type : array
application/json :
schema :
items :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Pet"
2021-05-30 11:43:31 +02:00
type : array
description : successful operation
"400" :
description : Invalid status value
security :
- petstore_auth :
- read:pets
summary : Finds Pets by status
tags :
- pet
/pet/findByTags :
get :
deprecated : true
2022-02-08 13:31:20 +08:00
description : "Multiple tags can be provided with comma separated strings. Use\
\ tag1, tag2, tag3 for testing."
2021-05-30 11:43:31 +02:00
operationId : findPetsByTags
parameters :
- description : Tags to filter by
explode : false
in : query
name : tags
required : true
schema :
items :
type : string
type : array
style : form
responses :
"200" :
content :
application/xml :
schema :
items :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Pet"
2021-05-30 11:43:31 +02:00
type : array
application/json :
schema :
items :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Pet"
2021-05-30 11:43:31 +02:00
type : array
description : successful operation
"400" :
description : Invalid tag value
security :
- petstore_auth :
- read:pets
summary : Finds Pets by tags
tags :
- pet
/pet/{petId}:
delete :
2022-02-21 18:37:52 +08:00
description : ""
2021-05-30 11:43:31 +02:00
operationId : deletePet
parameters :
- explode : false
in : header
name : api_key
required : false
schema :
type : string
style : simple
- description : Pet id to delete
explode : false
in : path
name : petId
required : true
schema :
format : int64
type : integer
style : simple
responses :
"400" :
description : Invalid pet value
security :
- petstore_auth :
- write:pets
- read:pets
summary : Deletes a pet
tags :
- pet
get :
description : Returns a single pet
operationId : getPetById
parameters :
- description : ID of pet to return
explode : false
in : path
name : petId
required : true
schema :
format : int64
type : integer
style : simple
responses :
"200" :
content :
application/xml :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Pet"
2021-05-30 11:43:31 +02:00
application/json :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Pet"
2021-05-30 11:43:31 +02:00
description : successful operation
"400" :
description : Invalid ID supplied
"404" :
description : Pet not found
security :
- api_key : [ ]
summary : Find pet by ID
tags :
- pet
post :
2022-02-21 18:37:52 +08:00
description : ""
2021-05-30 11:43:31 +02:00
operationId : updatePetWithForm
parameters :
- description : ID of pet that needs to be updated
explode : false
in : path
name : petId
required : true
schema :
format : int64
type : integer
style : simple
requestBody :
content :
application/x-www-form-urlencoded :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/updatePetWithForm_request"
2021-05-30 11:43:31 +02:00
responses :
"405" :
description : Invalid input
security :
- petstore_auth :
- write:pets
- read:pets
summary : Updates a pet in the store with form data
tags :
- pet
/pet/{petId}/uploadImage:
post :
2022-02-21 18:37:52 +08:00
description : ""
2021-05-30 11:43:31 +02:00
operationId : uploadFile
parameters :
- description : ID of pet to update
explode : false
in : path
name : petId
required : true
schema :
format : int64
type : integer
style : simple
requestBody :
content :
multipart/form-data :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/uploadFile_request"
2021-05-30 11:43:31 +02:00
responses :
"200" :
content :
application/json :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/ApiResponse"
2021-05-30 11:43:31 +02:00
description : successful operation
security :
- petstore_auth :
- write:pets
- read:pets
summary : uploads an image
tags :
- pet
/store/inventory :
get :
description : Returns a map of status codes to quantities
operationId : getInventory
responses :
"200" :
content :
application/json :
schema :
additionalProperties :
format : int32
type : integer
type : object
description : successful operation
security :
- api_key : [ ]
summary : Returns pet inventories by status
tags :
- store
/store/order :
post :
2022-02-21 18:37:52 +08:00
description : ""
2021-05-30 11:43:31 +02:00
operationId : placeOrder
requestBody :
content :
application/json :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Order"
2021-05-30 11:43:31 +02:00
description : order placed for purchasing the pet
required : true
responses :
"200" :
content :
application/xml :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Order"
2021-05-30 11:43:31 +02:00
application/json :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Order"
2021-05-30 11:43:31 +02:00
description : successful operation
"400" :
description : Invalid Order
summary : Place an order for a pet
tags :
- store
/store/order/{orderId}:
delete :
description : For valid response try integer IDs with value < 1000. Anything
above 1000 or nonintegers will generate API errors
operationId : deleteOrder
parameters :
- description : ID of the order that needs to be deleted
explode : false
in : path
name : orderId
required : true
schema :
type : string
style : simple
responses :
"400" :
description : Invalid ID supplied
"404" :
description : Order not found
summary : Delete purchase order by ID
tags :
- store
get :
description : For valid response try integer IDs with value <= 5 or > 10. Other
2022-11-08 00:30:24 +11:00
values will generate exceptions
2021-05-30 11:43:31 +02:00
operationId : getOrderById
parameters :
- description : ID of pet that needs to be fetched
explode : false
in : path
name : orderId
required : true
schema :
format : int64
maximum : 5
minimum : 1
type : integer
style : simple
responses :
"200" :
content :
application/xml :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Order"
2021-05-30 11:43:31 +02:00
application/json :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Order"
2021-05-30 11:43:31 +02:00
description : successful operation
"400" :
description : Invalid ID supplied
"404" :
description : Order not found
summary : Find purchase order by ID
tags :
- store
/user :
post :
description : This can only be done by the logged in user.
operationId : createUser
requestBody :
content :
application/json :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/User"
2021-05-30 11:43:31 +02:00
description : Created user object
required : true
responses :
default :
description : successful operation
security :
- api_key : [ ]
summary : Create user
tags :
- user
/user/createWithArray :
post :
2022-02-21 18:37:52 +08:00
description : ""
2021-05-30 11:43:31 +02:00
operationId : createUsersWithArrayInput
requestBody :
2025-06-02 15:33:27 +08:00
$ref : "#/components/requestBodies/UserArray"
2021-05-30 11:43:31 +02:00
responses :
default :
description : successful operation
security :
- api_key : [ ]
summary : Creates list of users with given input array
tags :
- user
/user/createWithList :
post :
2022-02-21 18:37:52 +08:00
description : ""
2021-05-30 11:43:31 +02:00
operationId : createUsersWithListInput
requestBody :
2025-06-02 15:33:27 +08:00
$ref : "#/components/requestBodies/UserArray"
2021-05-30 11:43:31 +02:00
responses :
default :
description : successful operation
security :
- api_key : [ ]
summary : Creates list of users with given input array
tags :
- user
/user/login :
get :
2022-02-21 18:37:52 +08:00
description : ""
2021-05-30 11:43:31 +02:00
operationId : loginUser
parameters :
- description : The user name for login
explode : true
in : query
name : username
required : true
schema :
2022-02-08 13:31:20 +08:00
pattern : "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$"
2021-05-30 11:43:31 +02:00
type : string
style : form
- description : The password for login in clear text
explode : true
in : query
name : password
required : true
schema :
type : string
style : form
responses :
"200" :
content :
application/xml :
schema :
type : string
application/json :
schema :
type : string
description : successful operation
headers :
Set-Cookie :
description : Cookie authentication key for use with the `api_key` apiKey
authentication.
explode : false
schema :
example : AUTH_KEY=abcde12345; Path=/; HttpOnly
type : string
style : simple
X-Rate-Limit :
description : calls per hour allowed by the user
explode : false
schema :
format : int32
type : integer
style : simple
X-Expires-After :
2021-08-29 00:58:24 +10:00
description : date in UTC when token expires
2021-05-30 11:43:31 +02:00
explode : false
schema :
format : date-time
type : string
style : simple
"400" :
description : Invalid username/password supplied
summary : Logs user into the system
tags :
- user
/user/logout :
get :
2022-02-21 18:37:52 +08:00
description : ""
2021-05-30 11:43:31 +02:00
operationId : logoutUser
responses :
default :
description : successful operation
security :
- api_key : [ ]
summary : Logs out current logged in user session
tags :
- user
/user/{username}:
delete :
description : This can only be done by the logged in user.
operationId : deleteUser
parameters :
- description : The name that needs to be deleted
explode : false
in : path
name : username
required : true
schema :
type : string
style : simple
responses :
"400" :
description : Invalid username supplied
"404" :
description : User not found
security :
- api_key : [ ]
summary : Delete user
tags :
- user
get :
2022-02-21 18:37:52 +08:00
description : ""
2021-05-30 11:43:31 +02:00
operationId : getUserByName
parameters :
- description : The name that needs to be fetched. Use user1 for testing.
explode : false
in : path
name : username
required : true
schema :
type : string
style : simple
responses :
"200" :
content :
application/xml :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/User"
2021-05-30 11:43:31 +02:00
application/json :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/User"
2021-05-30 11:43:31 +02:00
description : successful operation
"400" :
description : Invalid username supplied
"404" :
description : User not found
summary : Get user by user name
tags :
- user
put :
description : This can only be done by the logged in user.
operationId : updateUser
parameters :
- description : name that need to be deleted
explode : false
in : path
name : username
required : true
schema :
type : string
style : simple
requestBody :
content :
application/json :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/User"
2021-05-30 11:43:31 +02:00
description : Updated user object
required : true
responses :
"400" :
description : Invalid user supplied
"404" :
description : User not found
security :
- api_key : [ ]
summary : Updated user
tags :
- user
2023-06-04 13:37:12 +08:00
/fake/query_param_default :
get :
description : ""
operationId : fake_query_param_default
parameters :
- description : has default value
explode : true
in : query
2023-11-21 12:34:43 +09:00
name : hasDefault
2023-06-04 13:37:12 +08:00
required : false
schema :
default : Hello World
type : string
style : form
- description : no default value
explode : true
in : query
2023-11-21 12:34:43 +09:00
name : noDefault
2023-06-04 13:37:12 +08:00
required : false
schema :
type : string
style : form
responses :
"400" :
description : Invalid username supplied
"404" :
description : User not found
summary : test query parameter default value
tags :
- fake
2021-05-30 11:43:31 +02:00
components :
requestBodies :
UserArray :
content :
application/json :
schema :
items :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/User"
2021-05-30 11:43:31 +02:00
type : array
description : List of user object
required : true
Pet :
content :
application/json :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Pet"
2021-05-30 11:43:31 +02:00
application/xml :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Pet"
2021-05-30 11:43:31 +02:00
description : Pet object that needs to be added to the store
required : true
schemas :
Order :
description : An order for a pets from the pet store
example :
petId : 6
quantity : 1
id : 0
shipDate : 2000-01-23T04:56:07.000 +00 : 00
complete : false
status : placed
properties :
id :
format : int64
title : id
type : integer
petId :
format : int64
title : petId
type : integer
quantity :
format : int32
title : quantity
type : integer
shipDate :
format : date-time
title : shipDate
type : string
status :
description : Order Status
enum :
- placed
- approved
- delivered
title : status
type : string
complete :
default : false
title : complete
type : boolean
title : Pet Order
type : object
xml :
name : Order
Category :
description : A category for a pet
example :
name : name
id : 6
properties :
id :
format : int64
title : id
type : integer
name :
2022-02-08 13:31:20 +08:00
pattern : "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$"
2021-05-30 11:43:31 +02:00
title : name
type : string
title : Pet category
type : object
xml :
name : Category
User :
description : A User who is purchasing from the pet store
example :
firstName : firstName
lastName : lastName
password : password
userStatus : 6
phone : phone
id : 0
email : email
username : username
properties :
id :
format : int64
2021-11-29 09:31:38 -08:00
title : id
2021-05-30 11:43:31 +02:00
type : integer
username :
2021-11-29 09:31:38 -08:00
title : username
2021-05-30 11:43:31 +02:00
type : string
firstName :
2021-11-29 09:31:38 -08:00
title : firstName
2021-05-30 11:43:31 +02:00
type : string
lastName :
2021-11-29 09:31:38 -08:00
title : lastName
2021-05-30 11:43:31 +02:00
type : string
email :
2021-11-29 09:31:38 -08:00
title : email
2021-05-30 11:43:31 +02:00
type : string
password :
2021-11-29 09:31:38 -08:00
title : password
2021-05-30 11:43:31 +02:00
type : string
phone :
2021-11-29 09:31:38 -08:00
title : phone
2021-05-30 11:43:31 +02:00
type : string
userStatus :
description : User Status
format : int32
2021-11-29 09:31:38 -08:00
title : userStatus
2021-05-30 11:43:31 +02:00
type : integer
title : a User
type : object
xml :
name : User
Tag :
description : A tag for a pet
example :
name : name
id : 1
properties :
id :
format : int64
title : id
type : integer
name :
title : name
type : string
title : Pet Tag
type : object
xml :
name : Tag
Pet :
description : A pet for sale in the pet store
example :
photoUrls :
- photoUrls
- photoUrls
name : doggie
id : 0
category :
name : name
id : 6
tags :
- name : name
id : 1
- name : name
id : 1
status : available
properties :
id :
format : int64
title : id
type : integer
category :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Category"
2021-05-30 11:43:31 +02:00
name :
example : doggie
title : name
type : string
photoUrls :
items :
type : string
title : photoUrls
type : array
xml :
name : photoUrl
wrapped : true
tags :
items :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Tag"
2021-05-30 11:43:31 +02:00
title : tags
type : array
xml :
name : tag
wrapped : true
status :
2021-08-03 19:11:16 +10:00
deprecated : true
2021-05-30 11:43:31 +02:00
description : pet status in the store
enum :
- available
- pending
- sold
title : status
type : string
required :
- name
- photoUrls
title : a Pet
type : object
xml :
name : Pet
ApiResponse :
description : Describes the result of uploading an image resource
example :
code : 0
type : type
message : message
properties :
code :
format : int32
title : code
type : integer
type :
title : type
type : string
message :
title : message
type : string
title : An uploaded response
type : object
2022-05-10 17:13:57 +08:00
updatePetWithForm_request :
2021-05-30 11:43:31 +02:00
properties :
name :
description : Updated name of the pet
type : string
status :
description : Updated status of the pet
type : string
type : object
2022-05-10 17:13:57 +08:00
uploadFile_request :
2021-05-30 11:43:31 +02:00
properties :
additionalMetadata :
description : Additional data to pass to server
type : string
file :
description : file to upload
format : binary
type : string
type : object
securitySchemes :
petstore_auth :
flows :
implicit :
authorizationUrl : http://petstore.swagger.io/api/oauth/dialog
scopes :
write:pets : modify pets in your account
read:pets : read your pets
type : oauth2
api_key :
in : header
name : api_key
type : apiKey
