{ "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Dev Api", "description": "This is a sample server Petstore server. You can find out more about Swagger at http:\/\/swagger.io<\/a> or on irc.freenode.net, #swagger. For this sample, you can use the api key \"special-key\" to test the authorization filters", "termsOfService": "http:\/\/swagger.io\/terms\/" }, "servers": [ "http:\/\/petstore.swagger.io\/v2" ], "paths": { "\/pet": { "post": { "summary": "Add a new pet to the store", "description": "", "operationId": "AddPet", "deprecated": 0, "parameters": [], "responses": { "405": { "description": "Invalid input" } } }, "put": { "summary": "Update an existing pet", "description": "", "operationId": "UpdatePet", "deprecated": 0, "parameters": [], "responses": { "400": { "description": "Invalid ID supplied" } } } }, "\/pet\/findByStatus": { "get": { "summary": "Finds Pets by status", "description": "Multiple status values can be provided with comma seperated strings", "operationId": "FindPetsByStatus", "deprecated": 0, "parameters": [ { "name": "status", "in": "query", "description": "Status values that need to be considered for filter" } ], "responses": { "200": { "description": "successful operation", "content": { "application\/json": { "schema": { "$href": "#\/components\/schemas\/Pet" } } } } } } }, "\/pet\/findByTags": { "get": { "summary": "Finds Pets by tags", "description": "Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.", "operationId": "FindPetsByTags", "deprecated": 0, "parameters": [ { "name": "tags", "in": "query", "description": "Tags to filter by" } ], "responses": { "200": { "description": "successful operation", "content": { "application\/json": { "schema": { "$href": "#\/components\/schemas\/Pet" } } } } } } }, "\/pet\/{petId}": { "get": { "summary": "Find pet by ID", "description": "Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions", "operationId": "GetPetById", "deprecated": 0, "parameters": [ { "name": "petId", "in": "path", "description": "ID of pet that needs to be fetched" } ], "responses": { "200": { "description": "successful operation", "content": { "application\/json": { "schema": { "$href": "#\/components\/schemas\/Pet" } } } } } }, "post": { "summary": "Updates a pet in the store with form data", "description": "", "operationId": "UpdatePetWithForm", "deprecated": 0, "parameters": [ { "name": "petId", "in": "path", "description": "ID of pet that needs to be fetched" }, { "name": "name", "in": "formData", "description": "Updated name of the pet" }, { "name": "status", "in": "formData", "description": "Updated status of the pet" } ], "responses": { "405": { "description": "Invalid input" } } }, "delete": { "summary": "Deletes a pet", "description": "", "operationId": "DeletePet", "deprecated": 0, "parameters": [ { "name": "petId", "in": "path", "description": "ID of pet that needs to be fetched" } ], "responses": { "400": { "description": "Invalid ID supplied" } } } }, "\/store\/order": { "post": { "summary": "Place an order for a pet", "description": "", "operationId": "PlaceOrder", "deprecated": 0, "parameters": [], "responses": { "200": { "description": "successful operation", "content": { "application\/json": { "schema": { "$href": "#\/components\/schemas\/Pet" } } } } } } }, "\/store\/order\/{orderId}": { "get": { "summary": "Find purchase order by ID", "description": "For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions", "operationId": "GetOrderById", "deprecated": 0, "parameters": [ { "name": "orderId", "in": "path", "description": "ID of pet that needs to be fetched" } ], "responses": { "200": { "description": "successful operation", "content": { "application\/json": { "schema": { "$href": "#\/components\/schemas\/Pet" } } } } } }, "delete": { "summary": "Delete purchase order by ID", "description": "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors", "operationId": "DeleteOrder", "deprecated": 0, "parameters": [ { "name": "orderId", "in": "path", "description": "ID of pet that needs to be fetched" } ], "responses": { "400": { "description": "Invalid ID supplied" } } } }, "\/user": { "post": { "summary": "Create user", "description": "This can only be done by the logged in user.", "operationId": "CreateUser", "deprecated": 0, "parameters": [], "responses": { "default": { "description": "successful operation" } } } }, "\/user\/createWithArray": { "post": { "summary": "Creates list of users with given input array", "description": "", "operationId": "CreateUsersWithArrayInput", "deprecated": 0, "parameters": [], "responses": { "default": { "description": "successful operation" } } } }, "\/user\/createWithList": { "post": { "summary": "Creates list of users with given input array", "description": "", "operationId": "CreateUsersWithListInput", "deprecated": 0, "parameters": [], "responses": { "default": { "description": "successful operation" } } } }, "\/user\/login": { "get": { "summary": "Logs user into the system", "description": "", "operationId": "LoginUser", "deprecated": 0, "parameters": [ { "name": "username", "in": "query", "description": "The user name for login" }, { "name": "password", "in": "query", "description": "The password for login in clear text" } ], "responses": { "200": { "description": "successful operation", "content": { "application\/json": { "schema": { "$href": "#\/components\/schemas\/Pet" } } } } } } }, "\/user\/logout": { "get": { "summary": "Logs out current logged in user session", "description": "", "operationId": "LogoutUser", "deprecated": 0, "parameters": [], "responses": { "default": { "description": "successful operation" } } } }, "\/user\/{username}": { "get": { "summary": "Get user by user name", "description": "", "operationId": "GetUserByName", "deprecated": 0, "parameters": [ { "name": "username", "in": "path", "description": "The name that needs to be fetched. Use user1 for testing. " } ], "responses": { "200": { "description": "successful operation", "content": { "application\/json": { "schema": { "$href": "#\/components\/schemas\/Pet" } } } } } }, "put": { "summary": "Updated user", "description": "This can only be done by the logged in user.", "operationId": "UpdateUser", "deprecated": 0, "parameters": [ { "name": "username", "in": "path", "description": "The name that needs to be fetched. Use user1 for testing. " } ], "responses": { "400": { "description": "Invalid ID supplied" } } }, "delete": { "summary": "Delete user", "description": "This can only be done by the logged in user.", "operationId": "DeleteUser", "deprecated": 0, "parameters": [ { "name": "username", "in": "path", "description": "The name that needs to be fetched. Use user1 for testing. " } ], "responses": { "400": { "description": "Invalid ID supplied" } } } } }, "components": { "schemas": { "User": { "type": "object", "properties": { "id": { "description": "", "type": "integer" }, "username": { "description": "", "type": "string" }, "firstName": { "description": "", "type": "string" }, "lastName": { "description": "", "type": "string" }, "email": { "description": "", "type": "string" }, "password": { "description": "", "type": "string" }, "phone": { "description": "", "type": "string" }, "userStatus": { "description": "User Status", "type": "integer" } } }, "Category": { "type": "object", "properties": { "id": { "description": "", "type": "integer" }, "name": { "description": "", "type": "string" } } }, "Pet": { "type": "object", "properties": { "id": { "description": "", "type": "integer" }, "Category": { "description": "", "type": "object" }, "category": { "description": "", "type": "" }, "name": { "description": "", "type": "string" }, "photoUrls": { "description": "", "type": "array" }, "tags": { "description": "", "type": "array" }, "status": { "description": "pet status in the store", "type": "string" } } }, "photoUrls": { "type": "array" }, "tags": { "type": "array" }, "Tag": { "type": "object", "properties": { "id": { "description": "", "type": "integer" }, "name": { "description": "", "type": "string" } } }, "Order": { "type": "object", "properties": { "id": { "description": "", "type": "integer" }, "petId": { "description": "", "type": "integer" }, "quantity": { "description": "", "type": "integer" }, "shipDate": { "description": "", "type": "string" }, "status": { "description": "pet status in the store", "type": "string" }, "complete": { "description": "", "type": "boolean" } } } } } }