Mercurial > hg > thermostat-ng > web-gateway
view services/schema/src/main/webapp/WEB-INF/swagger-template.json @ 292:1738c834713c
Add schema service to serve combined API swagger file
This patch serves an uber-api Swagger file from URL
https://127.0.0.1:30000/schema/fullapi-swagger.yaml (or ... .json)
Rviewed-by: sgehwolf
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-October/025369.html
author | Simon Tooke <stooke@redhat.com> |
---|---|
date | Tue, 24 Oct 2017 14:46:18 -0400 |
parents | |
children |
line wrap: on
line source
{ "swagger": "2.0", "info": { "version": "0.0.1", "title": "Thermostat Combined API", "license": { "name": "GPL v2 with Classpath Exception", "url": "http://www.gnu.org/licenses" } }, "consumes": [ "application/json" ], "produces": [ "application/json", "text/html; charset=utf-8" ], "basePath": "/", "paths": { }, "definitions": { "environment-items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "metric": { "type": "object", "properties": { "$numberLong": { "type": "string" } } } }, "parameters": { "system-id": { "name": "systemId", "in": "path", "required": true, "type": "string", "description": "The system ID for the current request." }, "jvm-id": { "name": "jvmId", "in": "path", "required": true, "type": "string", "description": "The JVM ID for the current request." }, "timestamp": { "name": "timeStamp", "in": "path", "required": true, "type": "integer", "format": "int64", "description": "The UNIX timestamp in milliseconds to set the last_updated field for." }, "limit": { "name": "limit", "in": "query", "description": "Maximum number of items to return. Example '1'", "type": "integer", "required": false, "default": 1 }, "offset": { "name": "offset", "in": "query", "description": "Offset of first item to return. Example '0'", "type": "integer", "required": false, "default": 0 }, "sort": { "name": "sort", "in": "query", "description": "Sort string. Comma separated list of fields prefixed with '+' for ascending or '-' for descending. Example '?sort=+a,-b' Fields use dot notation for embedded documents. Example 'outer.inner' refers to field inner contained in field outer.", "type": "string", "required": false }, "query": { "name": "query", "in": "query", "description": "Query string. Comma separated list of key, comparator, value pairs. Comparator supports '==', '<=', '>=', '<', '>', '!='. Example '?query=a==b,c!=d'. Keys are fields in documents and use dot notation for embedded documents. Example 'outer.inner' refers to field inner contained in field outer.", "type": "string", "required": false }, "include": { "name": "include", "in": "query", "description": "Inclusion string. Comma separated list of fields to include in the response. Example '?include=a,b' Fields use dot notation for embedded documents. Example 'outer.inner' refers to field inner contained in field outer. Cannot be used in combination with 'exclude' parameter Overriden by 'exclude' parameter", "type": "string", "required": false }, "exclude": { "name": "exclude", "in": "query", "description": "Exclusion string. Comma separated list of fields to exclude in the response. Example '?exclude=a,b' Fields use dot notation for embedded documents. Example 'outer.inner' refers to field inner contained in field outer. Cannot be used in combination with 'include' parameter; takes precedence over 'include' parameter", "type": "string", "required": false } } }