Created
October 2, 2018 10:31
-
-
Save dmitryTsatsarin/8de83ea140ebbbebf752b81094370aec to your computer and use it in GitHub Desktop.
Swagger 2.0 example
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: | |
| title: Simple API overview | |
| version: v2 | |
| paths: | |
| /: | |
| get: | |
| operationId: listVersionsv2 | |
| summary: List API versions | |
| parameters: [{ | |
| "name": "tournament_id", | |
| "required": true, | |
| "in": "path", | |
| "description": "", | |
| "type": "string" | |
| }, { | |
| "name": "data", | |
| "in": "body", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "rounds": { | |
| "description": "", | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "prop1":{ | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "required": ["rounds"] | |
| } | |
| }] | |
| produces: | |
| - application/json | |
| responses: | |
| '200': | |
| description: 200 300 response | |
| examples: | |
| application/json: |- | |
| { | |
| "versions": [ | |
| { | |
| "status": "CURRENT", | |
| "updated": "2011-01-21T11:33:21Z", | |
| "id": "v2.0", | |
| "links": [ | |
| { | |
| "href": "http://127.0.0.1:8774/v2/", | |
| "rel": "self" | |
| } | |
| ] | |
| }, | |
| { | |
| "status": "EXPERIMENTAL", | |
| "updated": "2013-07-23T11:33:21Z", | |
| "id": "v3.0", | |
| "links": [ | |
| { | |
| "href": "http://127.0.0.1:8774/v3/", | |
| "rel": "self" | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| '300': | |
| description: 200 300 response | |
| examples: | |
| application/json: |- | |
| { | |
| "versions": [ | |
| { | |
| "status": "CURRENT", | |
| "updated": "2011-01-21T11:33:21Z", | |
| "id": "v2.0", | |
| "links": [ | |
| { | |
| "href": "http://127.0.0.1:8774/v2/", | |
| "rel": "self" | |
| } | |
| ] | |
| }, | |
| { | |
| "status": "EXPERIMENTAL", | |
| "updated": "2013-07-23T11:33:21Z", | |
| "id": "v3.0", | |
| "links": [ | |
| { | |
| "href": "http://127.0.0.1:8774/v3/", | |
| "rel": "self" | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| /v2: | |
| get: | |
| operationId: getVersionDetailsv2 | |
| summary: Show API version details | |
| produces: | |
| - application/json | |
| responses: | |
| '200': | |
| description: 200 203 response | |
| examples: | |
| application/json: |- | |
| { | |
| "version": { | |
| "status": "CURRENT", | |
| "updated": "2011-01-21T11:33:21Z", | |
| "media-types": [ | |
| { | |
| "base": "application/xml", | |
| "type": "application/vnd.openstack.compute+xml;version=2" | |
| }, | |
| { | |
| "base": "application/json", | |
| "type": "application/vnd.openstack.compute+json;version=2" | |
| } | |
| ], | |
| "id": "v2.0", | |
| "links": [ | |
| { | |
| "href": "http://127.0.0.1:8774/v2/", | |
| "rel": "self" | |
| }, | |
| { | |
| "href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", | |
| "type": "application/pdf", | |
| "rel": "describedby" | |
| }, | |
| { | |
| "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", | |
| "type": "application/vnd.sun.wadl+xml", | |
| "rel": "describedby" | |
| }, | |
| { | |
| "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", | |
| "type": "application/vnd.sun.wadl+xml", | |
| "rel": "describedby" | |
| } | |
| ] | |
| } | |
| } | |
| '203': | |
| description: 200 203 response | |
| examples: | |
| application/json: |- | |
| { | |
| "version": { | |
| "status": "CURRENT", | |
| "updated": "2011-01-21T11:33:21Z", | |
| "media-types": [ | |
| { | |
| "base": "application/xml", | |
| "type": "application/vnd.openstack.compute+xml;version=2" | |
| }, | |
| { | |
| "base": "application/json", | |
| "type": "application/vnd.openstack.compute+json;version=2" | |
| } | |
| ], | |
| "id": "v2.0", | |
| "links": [ | |
| { | |
| "href": "http://23.253.228.211:8774/v2/", | |
| "rel": "self" | |
| }, | |
| { | |
| "href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", | |
| "type": "application/pdf", | |
| "rel": "describedby" | |
| }, | |
| { | |
| "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", | |
| "type": "application/vnd.sun.wadl+xml", | |
| "rel": "describedby" | |
| } | |
| ] | |
| } | |
| } | |
| consumes: | |
| - application/json |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment