Last active
September 8, 2023 10:34
-
-
Save ilozano2/056a8ac16c3f3fbff247376898dc3bbc to your computer and use it in GitHub Desktop.
one-endpoint-openapi.json
This file contains hidden or 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
| { | |
| "openapi": "3.0.2", | |
| "info": { | |
| "title": "Swagger Petstore - OpenAPI 3.0", | |
| "description": "This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about\nSwagger at [http://swagger.io](http://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!\nYou can now help us improve the API whether it's by making changes to the definition itself or to the code.\nThat way, with time, we can improve the API in general, and expose some of the new features in OAS3.\n\nSome useful links:\n- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)\n- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)", | |
| "termsOfService": "http://swagger.io/terms/", | |
| "contact": { | |
| "email": "[email protected]" | |
| }, | |
| "license": { | |
| "name": "Apache 2.0", | |
| "url": "http://www.apache.org/licenses/LICENSE-2.0.html" | |
| }, | |
| "version": "1.0.17" | |
| }, | |
| "externalDocs": { | |
| "description": "Find out more about Swagger", | |
| "url": "http://swagger.io" | |
| }, | |
| "servers": [ | |
| { | |
| "url": "/api/v3" | |
| } | |
| ], | |
| "tags": [ | |
| { | |
| "name": "pet", | |
| "description": "Everything about your Pets", | |
| "externalDocs": { | |
| "description": "Find out more", | |
| "url": "http://swagger.io" | |
| } | |
| }, | |
| { | |
| "name": "store", | |
| "description": "Access to Petstore orders", | |
| "externalDocs": { | |
| "description": "Find out more about our store", | |
| "url": "http://swagger.io" | |
| } | |
| }, | |
| { | |
| "name": "user", | |
| "description": "Operations about user" | |
| } | |
| ], | |
| "paths": { | |
| "/pet/findByStatus": { | |
| "get": { | |
| "tags": [ | |
| "pet" | |
| ], | |
| "summary": "Finds Pets by status", | |
| "description": "Multiple status values can be provided with comma separated strings", | |
| "operationId": "findPetsByStatus", | |
| "parameters": [ | |
| { | |
| "name": "status", | |
| "in": "query", | |
| "description": "Status values that need to be considered for filter", | |
| "required": false, | |
| "explode": true, | |
| "schema": { | |
| "type": "string", | |
| "default": "available", | |
| "enum": [ | |
| "available", | |
| "pending", | |
| "sold" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "content": { | |
| "application/xml": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Pet" | |
| } | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Pet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Invalid status value" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "petstore_auth": [ | |
| "write:pets", | |
| "read:pets" | |
| ] | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "components": { | |
| "schemas": { | |
| "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" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "Order Status", | |
| "example": "approved", | |
| "enum": [ | |
| "placed", | |
| "approved", | |
| "delivered" | |
| ] | |
| }, | |
| "complete": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "xml": { | |
| "name": "order" | |
| } | |
| }, | |
| "Customer": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64", | |
| "example": 100000 | |
| }, | |
| "username": { | |
| "type": "string", | |
| "example": "fehguy" | |
| }, | |
| "address": { | |
| "type": "array", | |
| "xml": { | |
| "name": "addresses", | |
| "wrapped": true | |
| }, | |
| "items": { | |
| "$ref": "#/components/schemas/Address" | |
| } | |
| } | |
| }, | |
| "xml": { | |
| "name": "customer" | |
| } | |
| }, | |
| "Address": { | |
| "type": "object", | |
| "properties": { | |
| "street": { | |
| "type": "string", | |
| "example": "437 Lytton" | |
| }, | |
| "city": { | |
| "type": "string", | |
| "example": "Palo Alto" | |
| }, | |
| "state": { | |
| "type": "string", | |
| "example": "CA" | |
| }, | |
| "zip": { | |
| "type": "string", | |
| "example": "94301" | |
| } | |
| }, | |
| "xml": { | |
| "name": "address" | |
| } | |
| }, | |
| "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", | |
| "example": "[email protected]" | |
| }, | |
| "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": "#/components/schemas/Category" | |
| }, | |
| "photoUrls": { | |
| "type": "array", | |
| "xml": { | |
| "wrapped": true | |
| }, | |
| "items": { | |
| "type": "string", | |
| "xml": { | |
| "name": "photoUrl" | |
| } | |
| } | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "xml": { | |
| "wrapped": true | |
| }, | |
| "items": { | |
| "$ref": "#/components/schemas/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" | |
| } | |
| } | |
| }, | |
| "requestBodies": { | |
| "Pet": { | |
| "description": "Pet object that needs to be added to the store", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Pet" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Pet" | |
| } | |
| } | |
| } | |
| }, | |
| "UserArray": { | |
| "description": "List of user object", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/User" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "securitySchemes": { | |
| "petstore_auth": { | |
| "type": "oauth2", | |
| "flows": { | |
| "implicit": { | |
| "authorizationUrl": "https://petstore3.swagger.io/oauth/authorize", | |
| "scopes": { | |
| "write:pets": "modify pets in your account", | |
| "read:pets": "read your pets" | |
| } | |
| } | |
| } | |
| }, | |
| "api_key": { | |
| "type": "apiKey", | |
| "name": "api_key", | |
| "in": "header" | |
| } | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment