diff options
author | rautenberg <rautenberg@in-silico.ch> | 2016-08-29 09:49:32 +0200 |
---|---|---|
committer | rautenberg <rautenberg@in-silico.ch> | 2016-08-29 09:49:32 +0200 |
commit | 452e50bb4760176f004b8c7faff379f69564b3d0 (patch) | |
tree | 1a7a854c7ed8db9735076a105d86f3f99d16c1f8 /api | |
parent | e3284e859455db4e773d1005ff8ecdb87a6233b1 (diff) |
add initial validation routes
Diffstat (limited to 'api')
-rw-r--r-- | api/api.json | 103 |
1 files changed, 100 insertions, 3 deletions
diff --git a/api/api.json b/api/api.json index 5672f64..476b941 100644 --- a/api/api.json +++ b/api/api.json @@ -1,9 +1,9 @@ { "swagger": "2.0", "info": { - "description": "REST Webservice for lazar\n", + "description": "REST Webservice for lazar and nano-lazar\n", "version": "0.0.1", - "title": "Lazar REST Service", + "title": "Lazar & Nano-Lazar REST Service", "contact": { "name": "in silico toxicology gmbh", "email": "service@in-silico.ch", @@ -143,6 +143,92 @@ } } }, + "/validation": { + "get": { + "tags": [ + "validation" + ], + "description": "Get a list of all validation types", + "parameters": [ + { + "name": "accept", + "in": "header", + "description": "requested Content-Type", + "required": true, + "type": "string", + "enum": [ + "text/uri-list", + "application/json" + ] + } + ], + "produces": [ + "text/uri-list", + "application/json" + ], + "responses": { + "200": { + "$ref": "#/responses/200" + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/validation/{validationtype}/{id}": { + "tags": [ + "model" + ], + "description": "Get model representation", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "body Content-Type", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "$ref": "#/parameters/valtype" + }, + { + "$ref": "#/parameters/modelid" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "$ref": "#/responses/200" + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + } + } + }, "/compound/descriptor": { "get": { "tags": [ @@ -387,6 +473,13 @@ "description": "InChI String", "required": true, "type": "string" + }, + "valtype": { + "name": "validationtype", + "in": "path", + "description": "validation type", + "required": true, + "type": "string" } }, "responses": { @@ -429,6 +522,10 @@ { "name": "compound", "description": "Compound" + }, + { + "name": "validation", + "description": "Validation" } ] -} +}
\ No newline at end of file |