Last active
March 15, 2017 13:45
-
-
Save DavidBiesack/70d2910322d5c68d730878f0d8c36587 to your computer and use it in GitHub Desktop.
Subset of petstore swagger.json, with more readable tag strings
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"swagger": "2.0", | |
"info": { | |
"description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", | |
"version": "1.0.0", | |
"title": "Swagger Petstore", | |
"termsOfService": "http://swagger.io/terms/", | |
"contact": { | |
"email": "apiteam@swagger.io" | |
}, | |
"license": { | |
"name": "Apache 2.0", | |
"url": "http://www.apache.org/licenses/LICENSE-2.0.html" | |
} | |
}, | |
"host": "petstore.swagger.io", | |
"basePath": "/v2", | |
"tags": [ | |
{ | |
"name": "Personal Pet", | |
"description": "Everything about your Pets", | |
"externalDocs": { | |
"description": "Find out more", | |
"url": "http://swagger.io" | |
} | |
}, | |
{ | |
"name": "Pet Store", | |
"description": "Access to Petstore orders" | |
}, | |
{ | |
"name": "Pet Owner", | |
"description": "Operations about user", | |
"externalDocs": { | |
"description": "Find out more about our store", | |
"url": "http://swagger.io" | |
} | |
} | |
], | |
"schemes": [ | |
"http" | |
], | |
"paths": { | |
"/pet": { | |
"post": { | |
"tags": [ | |
"Personal Pet" | |
], | |
"summary": "Add a new pet to the store", | |
"description": "", | |
"operationId": "addPet", | |
"consumes": [ | |
"application/json", | |
"application/xml" | |
], | |
"produces": [ | |
"application/xml", | |
"application/json" | |
], | |
"parameters": [ | |
{ | |
"in": "body", | |
"name": "body", | |
"description": "Pet object that needs to be added to the store", | |
"required": true, | |
"schema": { | |
"$ref": "#/definitions/Pet" | |
} | |
} | |
], | |
"responses": { | |
"405": { | |
"description": "Invalid input" | |
} | |
}, | |
"security": [ | |
{ | |
"petstore_auth": [ | |
"write:pets", | |
"read:pets" | |
] | |
} | |
] | |
}, | |
"put": { | |
"tags": [ | |
"Personal Pet" | |
], | |
"summary": "Update an existing pet", | |
"description": "", | |
"operationId": "updatePet", | |
"consumes": [ | |
"application/json", | |
"application/xml" | |
], | |
"produces": [ | |
"application/xml", | |
"application/json" | |
], | |
"parameters": [ | |
{ | |
"in": "body", | |
"name": "body", | |
"description": "Pet object that needs to be added to the store", | |
"required": true, | |
"schema": { | |
"$ref": "#/definitions/Pet" | |
} | |
} | |
], | |
"responses": { | |
"400": { | |
"description": "Invalid ID supplied" | |
}, | |
"404": { | |
"description": "Pet not found" | |
}, | |
"405": { | |
"description": "Validation exception" | |
} | |
}, | |
"security": [ | |
{ | |
"petstore_auth": [ | |
"write:pets", | |
"read:pets" | |
] | |
} | |
] | |
} | |
}, | |
"/pet/{petId}": { | |
"get": { | |
"tags": [ | |
"Personal Pet" | |
], | |
"summary": "Find pet by ID", | |
"description": "Returns a single pet", | |
"operationId": "getPetById", | |
"produces": [ | |
"application/xml", | |
"application/json" | |
], | |
"parameters": [ | |
{ | |
"name": "petId", | |
"in": "path", | |
"description": "ID of pet to return", | |
"required": true, | |
"type": "integer", | |
"format": "int64" | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "successful operation", | |
"schema": { | |
"$ref": "#/definitions/Pet" | |
} | |
}, | |
"400": { | |
"description": "Invalid ID supplied" | |
}, | |
"404": { | |
"description": "Pet not found" | |
} | |
}, | |
"security": [ | |
{ | |
"api_key": [] | |
} | |
] | |
}, | |
"post": { | |
"tags": [ | |
"Personal Pet" | |
], | |
"summary": "Updates a pet in the store with form data", | |
"description": "", | |
"operationId": "updatePetWithForm", | |
"consumes": [ | |
"application/x-www-form-urlencoded" | |
], | |
"produces": [ | |
"application/xml", | |
"application/json" | |
], | |
"parameters": [ | |
{ | |
"name": "petId", | |
"in": "path", | |
"description": "ID of pet that needs to be updated", | |
"required": true, | |
"type": "integer", | |
"format": "int64" | |
}, | |
{ | |
"name": "name", | |
"in": "formData", | |
"description": "Updated name of the pet", | |
"required": false, | |
"type": "string" | |
}, | |
{ | |
"name": "status", | |
"in": "formData", | |
"description": "Updated status of the pet", | |
"required": false, | |
"type": "string" | |
} | |
], | |
"responses": { | |
"405": { | |
"description": "Invalid input" | |
} | |
}, | |
"security": [ | |
{ | |
"petstore_auth": [ | |
"write:pets", | |
"read:pets" | |
] | |
} | |
] | |
}, | |
"delete": { | |
"tags": [ | |
"Personal Pet" | |
], | |
"summary": "Deletes a pet", | |
"description": "", | |
"operationId": "deletePet", | |
"produces": [ | |
"application/xml", | |
"application/json" | |
], | |
"parameters": [ | |
{ | |
"name": "api_key", | |
"in": "header", | |
"required": false, | |
"type": "string" | |
}, | |
{ | |
"name": "petId", | |
"in": "path", | |
"description": "Pet id to delete", | |
"required": true, | |
"type": "integer", | |
"format": "int64" | |
} | |
], | |
"responses": { | |
"400": { | |
"description": "Invalid ID supplied" | |
}, | |
"404": { | |
"description": "Pet not found" | |
} | |
}, | |
"security": [ | |
{ | |
"petstore_auth": [ | |
"write:pets", | |
"read:pets" | |
] | |
} | |
] | |
} | |
}, | |
"/store/inventory": { | |
"get": { | |
"tags": [ | |
"Pet Store", "Personal Pets" | |
], | |
"summary": "Returns pet inventories by status", | |
"description": "Returns a map of status codes to quantities", | |
"operationId": "getInventory", | |
"produces": [ | |
"application/json" | |
], | |
"parameters": [], | |
"responses": { | |
"200": { | |
"description": "successful operation", | |
"schema": { | |
"type": "object", | |
"additionalProperties": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
} | |
}, | |
"security": [ | |
{ | |
"api_key": [] | |
} | |
] | |
} | |
}, | |
"/user": { | |
"post": { | |
"tags": [ | |
"Pet Owner" | |
], | |
"summary": "Create user", | |
"description": "This can only be done by the logged in user.", | |
"operationId": "createUser", | |
"produces": [ | |
"application/xml", | |
"application/json" | |
], | |
"parameters": [ | |
{ | |
"in": "body", | |
"name": "body", | |
"description": "Created user object", | |
"required": true, | |
"schema": { | |
"$ref": "#/definitions/User" | |
} | |
} | |
], | |
"responses": { | |
"default": { | |
"description": "successful operation" | |
} | |
} | |
} | |
}, | |
"/user/{username}": { | |
"get": { | |
"tags": [ | |
"Pet Owner" | |
], | |
"summary": "Get user by user name", | |
"description": "", | |
"operationId": "getUserByName", | |
"produces": [ | |
"application/xml", | |
"application/json" | |
], | |
"parameters": [ | |
{ | |
"name": "username", | |
"in": "path", | |
"description": "The name that needs to be fetched. Use user1 for testing. ", | |
"required": true, | |
"type": "string" | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "successful operation", | |
"schema": { | |
"$ref": "#/definitions/User" | |
} | |
}, | |
"400": { | |
"description": "Invalid username supplied" | |
}, | |
"404": { | |
"description": "User not found" | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Pet Owner" | |
], | |
"summary": "Updated user", | |
"description": "This can only be done by the logged in user.", | |
"operationId": "updateUser", | |
"produces": [ | |
"application/xml", | |
"application/json" | |
], | |
"parameters": [ | |
{ | |
"name": "username", | |
"in": "path", | |
"description": "name that need to be updated", | |
"required": true, | |
"type": "string" | |
}, | |
{ | |
"in": "body", | |
"name": "body", | |
"description": "Updated user object", | |
"required": true, | |
"schema": { | |
"$ref": "#/definitions/User" | |
} | |
} | |
], | |
"responses": { | |
"400": { | |
"description": "Invalid user supplied" | |
}, | |
"404": { | |
"description": "User not found" | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Pet Owner" | |
], | |
"summary": "Delete user", | |
"description": "This can only be done by the logged in user.", | |
"operationId": "deleteUser", | |
"produces": [ | |
"application/xml", | |
"application/json" | |
], | |
"parameters": [ | |
{ | |
"name": "username", | |
"in": "path", | |
"description": "The name that needs to be deleted", | |
"required": true, | |
"type": "string" | |
} | |
], | |
"responses": { | |
"400": { | |
"description": "Invalid username supplied" | |
}, | |
"404": { | |
"description": "User not found" | |
} | |
} | |
} | |
} | |
}, | |
"securityDefinitions": { | |
"petstore_auth": { | |
"type": "oauth2", | |
"authorizationUrl": "http://petstore.swagger.io/oauth/dialog", | |
"flow": "implicit", | |
"scopes": { | |
"write:pets": "modify pets in your account", | |
"read:pets": "read your pets" | |
} | |
}, | |
"api_key": { | |
"type": "apiKey", | |
"name": "api_key", | |
"in": "header" | |
} | |
}, | |
"definitions": { | |
"Order": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int64" | |
}, | |
"petId": { | |
"type": "integer", | |
"format": "int64" | |
}, | |
"quantity": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"shipDate": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"status": { | |
"type": "string", | |
"description": "Order Status", | |
"enum": [ | |
"placed", | |
"approved", | |
"delivered" | |
] | |
}, | |
"complete": { | |
"type": "boolean", | |
"default": false | |
} | |
}, | |
"xml": { | |
"name": "Order" | |
} | |
}, | |
"Category": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int64" | |
}, | |
"name": { | |
"type": "string" | |
} | |
}, | |
"xml": { | |
"name": "Category" | |
} | |
}, | |
"User": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int64" | |
}, | |
"username": { | |
"type": "string" | |
}, | |
"firstName": { | |
"type": "string" | |
}, | |
"lastName": { | |
"type": "string" | |
}, | |
"email": { | |
"type": "string" | |
}, | |
"password": { | |
"type": "string" | |
}, | |
"phone": { | |
"type": "string" | |
}, | |
"userStatus": { | |
"type": "integer", | |
"format": "int32", | |
"description": "User Status" | |
} | |
}, | |
"xml": { | |
"name": "User" | |
} | |
}, | |
"Tag": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int64" | |
}, | |
"name": { | |
"type": "string" | |
} | |
}, | |
"xml": { | |
"name": "Tag" | |
} | |
}, | |
"Pet": { | |
"type": "object", | |
"required": [ | |
"name", | |
"photoUrls" | |
], | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int64" | |
}, | |
"category": { | |
"$ref": "#/definitions/Category" | |
}, | |
"name": { | |
"type": "string", | |
"example": "doggie" | |
}, | |
"photoUrls": { | |
"type": "array", | |
"xml": { | |
"name": "photoUrl", | |
"wrapped": true | |
}, | |
"items": { | |
"type": "string" | |
} | |
}, | |
"tags": { | |
"type": "array", | |
"xml": { | |
"name": "tag", | |
"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" | |
} | |
} | |
} | |
}, | |
"externalDocs": { | |
"description": "Find out more about Swagger", | |
"url": "http://swagger.io" | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment