-
Notifications
You must be signed in to change notification settings - Fork 9.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update JSON example files * Update JSON example files * Update JSON example files Co-authored-by: Mike Ralphson <[email protected]> Co-authored-by: Ron <[email protected]> Co-authored-by: Phil Barila <[email protected]>
- Loading branch information
4 people
authored
Jul 2, 2020
1 parent
97ec9eb
commit d1cc440
Showing
7 changed files
with
1,333 additions
and
0 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| { | ||
| "openapi": "3.0.0", | ||
| "info": { | ||
| "title": "Simple API overview", | ||
| "version": "2.0.0" | ||
| }, | ||
| "paths": { | ||
| "/": { | ||
| "get": { | ||
| "operationId": "listVersionsv2", | ||
| "summary": "List API versions", | ||
| "responses": { | ||
| "200": { | ||
| "description": "200 response", | ||
| "content": { | ||
| "application/json": { | ||
| "examples": { | ||
| "foo": { | ||
| "value": { | ||
| "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": "300 response", | ||
| "content": { | ||
| "application/json": { | ||
| "examples": { | ||
| "foo": { | ||
| "value": "{\n \"versions\": [\n {\n \"status\": \"CURRENT\",\n \"updated\": \"2011-01-21T11:33:21Z\",\n \"id\": \"v2.0\",\n \"links\": [\n {\n \"href\": \"http://127.0.0.1:8774/v2/\",\n \"rel\": \"self\"\n }\n ]\n },\n {\n \"status\": \"EXPERIMENTAL\",\n \"updated\": \"2013-07-23T11:33:21Z\",\n \"id\": \"v3.0\",\n \"links\": [\n {\n \"href\": \"http://127.0.0.1:8774/v3/\",\n \"rel\": \"self\"\n }\n ]\n }\n ]\n}\n" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/v2": { | ||
| "get": { | ||
| "operationId": "getVersionDetailsv2", | ||
| "summary": "Show API version details", | ||
| "responses": { | ||
| "200": { | ||
| "description": "200 response", | ||
| "content": { | ||
| "application/json": { | ||
| "examples": { | ||
| "foo": { | ||
| "value": { | ||
| "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": "203 response", | ||
| "content": { | ||
| "application/json": { | ||
| "examples": { | ||
| "foo": { | ||
| "value": { | ||
| "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" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| { | ||
| "openapi": "3.0.0", | ||
| "info": { | ||
| "title": "Callback Example", | ||
| "version": "1.0.0" | ||
| }, | ||
| "paths": { | ||
| "/streams": { | ||
| "post": { | ||
| "description": "subscribes a client to receive out-of-band data", | ||
| "parameters": [ | ||
| { | ||
| "name": "callbackUrl", | ||
| "in": "query", | ||
| "required": true, | ||
| "description": "the location where data will be sent. Must be network accessible\nby the source server\n", | ||
| "schema": { | ||
| "type": "string", | ||
| "format": "uri", | ||
| "example": "https://tonys-server.com" | ||
| } | ||
| } | ||
| ], | ||
| "responses": { | ||
| "201": { | ||
| "description": "subscription successfully created", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "description": "subscription information", | ||
| "required": [ | ||
| "subscriptionId" | ||
| ], | ||
| "properties": { | ||
| "subscriptionId": { | ||
| "description": "this unique identifier allows management of the subscription", | ||
| "type": "string", | ||
| "example": "2531329f-fb09-4ef7-887e-84e648214436" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "callbacks": { | ||
| "onData": { | ||
| "{$request.query.callbackUrl}/data": { | ||
| "post": { | ||
| "requestBody": { | ||
| "description": "subscription payload", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "type": "object", | ||
| "properties": { | ||
| "timestamp": { | ||
| "type": "string", | ||
| "format": "date-time" | ||
| }, | ||
| "userData": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "responses": { | ||
| "202": { | ||
| "description": "Your server implementation should return this HTTP status code\nif the data was received successfully\n" | ||
| }, | ||
| "204": { | ||
| "description": "Your server should return this HTTP status code if no longer interested\nin further updates\n" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.