{ "swagger": "2.0", "info": { "title": "Petstore (xample.in)", "description": "A Petstore you can call. It has the same paths and models as the Swagger Petstore v3, and it always answers.\n\n**Nothing is saved.** Writes are checked and answered as if they were saved, but the next request sees the sample data again. To keep your changes for one hour, send the header `X-Sandbox: ` (or `?sandbox=`). Sandboxes are in memory only.\n\nAuthentication is described but not enforced: any `api_key` or token is accepted.", "termsOfService": "https://openapi.xample.in/", "contact": { "email": "hello@bitgeek.in" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.0" }, "host": "openapi.xample.in", "basePath": "/petstore", "schemes": [ "https" ], "tags": [ { "name": "pet", "description": "Everything about your Pets" }, { "name": "store", "description": "Access to Petstore orders" }, { "name": "user", "description": "Operations about user" } ], "paths": { "/pet": { "put": { "tags": [ "pet" ], "summary": "Update an existing pet", "description": "Update an existing pet by Id", "operationId": "updatePet", "security": [ { "petstore_auth": [ "write:pets", "read:pets" ] } ], "consumes": [ "application/json", "application/xml", "application/x-www-form-urlencoded" ], "parameters": [ { "name": "X-Sandbox", "in": "header", "description": "Keep your changes in memory for one hour under this name. Without it, writes are answered but not kept.", "required": false, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" }, { "in": "body", "name": "body", "description": "Update an existent pet in the store", "required": true, "schema": { "$ref": "#/definitions/Pet" } } ], "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/Pet" } }, "400": { "description": "Invalid ID supplied", "schema": { "$ref": "#/definitions/ApiResponse" } }, "404": { "description": "Pet not found", "schema": { "$ref": "#/definitions/ApiResponse" } }, "422": { "description": "Validation exception", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json", "application/xml" ] }, "post": { "tags": [ "pet" ], "summary": "Add a new pet to the store", "description": "Add a new pet to the store", "operationId": "addPet", "security": [ { "petstore_auth": [ "write:pets", "read:pets" ] } ], "consumes": [ "application/json", "application/xml", "application/x-www-form-urlencoded" ], "parameters": [ { "name": "X-Sandbox", "in": "header", "description": "Keep your changes in memory for one hour under this name. Without it, writes are answered but not kept.", "required": false, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" }, { "in": "body", "name": "body", "description": "Create a new pet in the store", "required": true, "schema": { "$ref": "#/definitions/Pet" } } ], "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/Pet" } }, "400": { "description": "Invalid input", "schema": { "$ref": "#/definitions/ApiResponse" } }, "422": { "description": "Validation exception", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json", "application/xml" ] } }, "/pet/findByStatus": { "get": { "tags": [ "pet" ], "summary": "Finds Pets by status", "description": "Multiple status values can be provided with comma separated strings", "operationId": "findPetsByStatus", "security": [ { "petstore_auth": [ "write:pets", "read:pets" ] } ], "parameters": [ { "name": "status", "in": "query", "description": "Status values that need to be considered for filter", "required": false, "type": "string", "enum": [ "available", "pending", "sold" ], "default": "available" }, { "name": "X-Sandbox", "in": "header", "description": "Keep your changes in memory for one hour under this name. Without it, writes are answered but not kept.", "required": false, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" } ], "responses": { "200": { "description": "Successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/Pet" } } }, "400": { "description": "Invalid status value", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json", "application/xml" ] } }, "/pet/findByTags": { "get": { "tags": [ "pet" ], "summary": "Finds Pets by tags", "description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", "operationId": "findPetsByTags", "security": [ { "petstore_auth": [ "write:pets", "read:pets" ] } ], "parameters": [ { "name": "tags", "in": "query", "description": "Tags to filter by", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "X-Sandbox", "in": "header", "description": "Keep your changes in memory for one hour under this name. Without it, writes are answered but not kept.", "required": false, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" } ], "responses": { "200": { "description": "Successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/Pet" } } }, "400": { "description": "Invalid tag value", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json", "application/xml" ] } }, "/pet/{petId}": { "get": { "tags": [ "pet" ], "summary": "Find pet by ID", "description": "Returns a single pet", "operationId": "getPetById", "security": [ { "api_key": [] }, { "petstore_auth": [ "write:pets", "read:pets" ] } ], "parameters": [ { "name": "petId", "in": "path", "description": "ID of the pet", "required": true, "type": "integer", "format": "int64", "minimum": 1 }, { "name": "X-Sandbox", "in": "header", "description": "Keep your changes in memory for one hour under this name. Without it, writes are answered but not kept.", "required": false, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" } ], "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/Pet" } }, "400": { "description": "Invalid ID supplied", "schema": { "$ref": "#/definitions/ApiResponse" } }, "404": { "description": "Pet not found", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json", "application/xml" ] }, "post": { "tags": [ "pet" ], "summary": "Updates a pet in the store with form data", "description": "", "operationId": "updatePetWithForm", "security": [ { "petstore_auth": [ "write:pets", "read:pets" ] } ], "parameters": [ { "name": "petId", "in": "path", "description": "ID of the pet", "required": true, "type": "integer", "format": "int64", "minimum": 1 }, { "name": "name", "in": "query", "description": "Name of pet that needs to be updated", "type": "string" }, { "name": "status", "in": "query", "description": "Status of pet that needs to be updated", "type": "string" }, { "name": "X-Sandbox", "in": "header", "description": "Keep your changes in memory for one hour under this name. Without it, writes are answered but not kept.", "required": false, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" } ], "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/Pet" } }, "400": { "description": "Invalid input", "schema": { "$ref": "#/definitions/ApiResponse" } }, "404": { "description": "Pet not found", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json", "application/xml" ] }, "delete": { "tags": [ "pet" ], "summary": "Deletes a pet", "description": "", "operationId": "deletePet", "security": [ { "petstore_auth": [ "write:pets", "read:pets" ] } ], "parameters": [ { "name": "api_key", "in": "header", "description": "", "required": false, "type": "string" }, { "name": "petId", "in": "path", "description": "ID of the pet", "required": true, "type": "integer", "format": "int64", "minimum": 1 }, { "name": "X-Sandbox", "in": "header", "description": "Keep your changes in memory for one hour under this name. Without it, writes are answered but not kept.", "required": false, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" } ], "responses": { "200": { "description": "Pet deleted", "schema": { "$ref": "#/definitions/ApiResponse" } }, "400": { "description": "Invalid pet value", "schema": { "$ref": "#/definitions/ApiResponse" } }, "404": { "description": "Pet not found", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json" ] } }, "/pet/{petId}/uploadImage": { "post": { "tags": [ "pet" ], "summary": "uploads an image", "description": "", "operationId": "uploadFile", "security": [ { "petstore_auth": [ "write:pets", "read:pets" ] } ], "consumes": [ "application/octet-stream" ], "parameters": [ { "name": "petId", "in": "path", "description": "ID of the pet", "required": true, "type": "integer", "format": "int64", "minimum": 1 }, { "name": "additionalMetadata", "in": "query", "description": "Additional Metadata", "required": false, "type": "string" }, { "name": "X-Sandbox", "in": "header", "description": "Keep your changes in memory for one hour under this name. Without it, writes are answered but not kept.", "required": false, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" }, { "in": "body", "name": "body", "description": "", "required": false, "schema": { "type": "string", "format": "binary" } } ], "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/ApiResponse" } }, "404": { "description": "Pet not found", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json" ] } }, "/store/inventory": { "get": { "tags": [ "store" ], "summary": "Returns pet inventories by status", "description": "Returns a map of status codes to quantities", "operationId": "getInventory", "security": [ { "api_key": [] } ], "parameters": [ { "name": "X-Sandbox", "in": "header", "description": "Keep your changes in memory for one hour under this name. Without it, writes are answered but not kept.", "required": false, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" } ], "responses": { "200": { "description": "Successful operation", "schema": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } } } }, "produces": [ "application/json" ] } }, "/store/order": { "post": { "tags": [ "store" ], "summary": "Place an order for a pet", "description": "Place a new order in the store", "operationId": "placeOrder", "consumes": [ "application/json", "application/xml", "application/x-www-form-urlencoded" ], "parameters": [ { "name": "X-Sandbox", "in": "header", "description": "Keep your changes in memory for one hour under this name. Without it, writes are answered but not kept.", "required": false, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" }, { "in": "body", "name": "body", "description": "", "required": false, "schema": { "$ref": "#/definitions/Order" } } ], "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/Order" } }, "400": { "description": "Invalid input", "schema": { "$ref": "#/definitions/ApiResponse" } }, "422": { "description": "Validation exception", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json" ] } }, "/store/order/{orderId}": { "get": { "tags": [ "store" ], "summary": "Find purchase order by ID", "description": "Orders 1 to 10 exist in the sample data. Other values return 404.", "operationId": "getOrderById", "parameters": [ { "name": "orderId", "in": "path", "description": "ID of the order", "required": true, "type": "integer", "format": "int64", "minimum": 1 }, { "name": "X-Sandbox", "in": "header", "description": "Keep your changes in memory for one hour under this name. Without it, writes are answered but not kept.", "required": false, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" } ], "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/Order" } }, "400": { "description": "Invalid ID supplied", "schema": { "$ref": "#/definitions/ApiResponse" } }, "404": { "description": "Order not found", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json", "application/xml" ] }, "delete": { "tags": [ "store" ], "summary": "Delete purchase order by ID", "description": "Deletes the order. Without a sandbox the order is still there on the next request.", "operationId": "deleteOrder", "parameters": [ { "name": "orderId", "in": "path", "description": "ID of the order", "required": true, "type": "integer", "format": "int64", "minimum": 1 }, { "name": "X-Sandbox", "in": "header", "description": "Keep your changes in memory for one hour under this name. Without it, writes are answered but not kept.", "required": false, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" } ], "responses": { "200": { "description": "Order deleted", "schema": { "$ref": "#/definitions/ApiResponse" } }, "400": { "description": "Invalid ID supplied", "schema": { "$ref": "#/definitions/ApiResponse" } }, "404": { "description": "Order not found", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json" ] } }, "/user": { "post": { "tags": [ "user" ], "summary": "Create user", "description": "This can only be done by the logged in user.", "operationId": "createUser", "consumes": [ "application/json", "application/xml", "application/x-www-form-urlencoded" ], "parameters": [ { "name": "X-Sandbox", "in": "header", "description": "Keep your changes in memory for one hour under this name. Without it, writes are answered but not kept.", "required": false, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" }, { "in": "body", "name": "body", "description": "Created user object", "required": false, "schema": { "$ref": "#/definitions/User" } } ], "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/User" } }, "400": { "description": "Invalid input", "schema": { "$ref": "#/definitions/ApiResponse" } }, "422": { "description": "Validation exception", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json", "application/xml" ] } }, "/user/createWithList": { "post": { "tags": [ "user" ], "summary": "Creates list of users with given input array", "description": "Creates list of users with given input array", "operationId": "createUsersWithListInput", "consumes": [ "application/json" ], "parameters": [ { "name": "X-Sandbox", "in": "header", "description": "Keep your changes in memory for one hour under this name. Without it, writes are answered but not kept.", "required": false, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" }, { "in": "body", "name": "body", "description": "", "required": false, "schema": { "type": "array", "items": { "$ref": "#/definitions/User" } } } ], "responses": { "200": { "description": "Successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/User" } } }, "422": { "description": "Validation exception", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json", "application/xml" ] } }, "/user/login": { "get": { "tags": [ "user" ], "summary": "Logs user into the system", "description": "", "operationId": "loginUser", "parameters": [ { "name": "username", "in": "query", "description": "The user name for login", "required": false, "type": "string" }, { "name": "password", "in": "query", "description": "The password for login in clear text", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful operation", "schema": { "type": "string" }, "headers": { "X-Rate-Limit": { "description": "calls per hour allowed by the user", "type": "integer", "format": "int32" }, "X-Expires-After": { "description": "date in UTC when token expires", "type": "string", "format": "date-time" } } }, "400": { "description": "Invalid username/password supplied", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json", "application/xml" ] } }, "/user/logout": { "get": { "tags": [ "user" ], "summary": "Logs out current logged in user session", "description": "", "operationId": "logoutUser", "parameters": [], "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json" ] } }, "/user/{username}": { "get": { "tags": [ "user" ], "summary": "Get user by user name", "description": "Use user1 for testing.", "operationId": "getUserByName", "parameters": [ { "name": "username", "in": "path", "description": "The user name", "required": true, "type": "string" }, { "name": "X-Sandbox", "in": "header", "description": "Keep your changes in memory for one hour under this name. Without it, writes are answered but not kept.", "required": false, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" } ], "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/User" } }, "400": { "description": "Invalid username supplied", "schema": { "$ref": "#/definitions/ApiResponse" } }, "404": { "description": "User not found", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json", "application/xml" ] }, "put": { "tags": [ "user" ], "summary": "Update user", "description": "This can only be done by the logged in user.", "operationId": "updateUser", "consumes": [ "application/json", "application/xml", "application/x-www-form-urlencoded" ], "parameters": [ { "name": "username", "in": "path", "description": "The user name", "required": true, "type": "string" }, { "name": "X-Sandbox", "in": "header", "description": "Keep your changes in memory for one hour under this name. Without it, writes are answered but not kept.", "required": false, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" }, { "in": "body", "name": "body", "description": "Update an existent user in the store", "required": false, "schema": { "$ref": "#/definitions/User" } } ], "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/User" } }, "404": { "description": "User not found", "schema": { "$ref": "#/definitions/ApiResponse" } }, "422": { "description": "Validation exception", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json", "application/xml" ] }, "delete": { "tags": [ "user" ], "summary": "Delete user", "description": "This can only be done by the logged in user.", "operationId": "deleteUser", "parameters": [ { "name": "username", "in": "path", "description": "The user name", "required": true, "type": "string" }, { "name": "X-Sandbox", "in": "header", "description": "Keep your changes in memory for one hour under this name. Without it, writes are answered but not kept.", "required": false, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$" } ], "responses": { "200": { "description": "User deleted", "schema": { "$ref": "#/definitions/ApiResponse" } }, "400": { "description": "Invalid username supplied", "schema": { "$ref": "#/definitions/ApiResponse" } }, "404": { "description": "User not found", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "produces": [ "application/json" ] } } }, "definitions": { "Order": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 10 }, "petId": { "type": "integer", "format": "int64", "example": 198772 }, "quantity": { "type": "integer", "format": "int32", "example": 7 }, "shipDate": { "type": "string", "format": "date-time", "example": "2026-10-20T10:00:00Z" }, "status": { "type": "string", "description": "Order Status", "example": "approved", "enum": [ "placed", "approved", "delivered" ] }, "complete": { "type": "boolean" } }, "xml": { "name": "order" } }, "Category": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1 }, "name": { "type": "string", "example": "Dogs" } }, "xml": { "name": "category" } }, "User": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 10 }, "username": { "type": "string", "example": "theUser" }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "James" }, "email": { "type": "string", "format": "email", "example": "john@example.com" }, "password": { "type": "string", "example": "12345" }, "phone": { "type": "string", "example": "12345" }, "userStatus": { "type": "integer", "description": "User Status", "format": "int32", "example": 1 } }, "xml": { "name": "user" } }, "Tag": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } }, "xml": { "name": "tag" } }, "Pet": { "required": [ "name", "photoUrls" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 10 }, "name": { "type": "string", "example": "doggie" }, "category": { "$ref": "#/definitions/Category" }, "photoUrls": { "type": "array", "xml": { "wrapped": true }, "items": { "type": "string", "xml": { "name": "photoUrl" } } }, "tags": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/definitions/Tag" } }, "status": { "type": "string", "description": "pet status in the store", "enum": [ "available", "pending", "sold" ] } }, "xml": { "name": "pet" } }, "ApiResponse": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "message": { "type": "string" } }, "xml": { "name": "##default" } } }, "externalDocs": { "description": "All sample APIs and spec formats", "url": "https://openapi.xample.in/" }, "securityDefinitions": { "petstore_auth": { "type": "oauth2", "flow": "implicit", "scopes": { "write:pets": "modify pets in your account", "read:pets": "read your pets" }, "authorizationUrl": "https://openapi.xample.in/petstore/oauth/authorize" }, "api_key": { "type": "apiKey", "name": "api_key", "in": "header" } } }