From 878f014ec6cc808af99af5045bcc1a1143cab8d9 Mon Sep 17 00:00:00 2001 From: gebele Date: Thu, 5 Jul 2018 10:38:55 +0000 Subject: updated with endpoint list; refined error handling; refined prediction input --- api/api.json | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 83 insertions(+), 1 deletion(-) (limited to 'api') diff --git a/api/api.json b/api/api.json index 6aa95ad..718421f 100644 --- a/api/api.json +++ b/api/api.json @@ -32,6 +32,75 @@ "url": "https://github.com/opentox/lazar-rest" }, "paths": { + "/endpoint": { + "get": { + "x-orn-@type": "x-orn:Endpoint", + "x-orn:path": "https://lazar.prod.openrisknet.org/endpoint", + "x-orn:method": "Get", + "tags": [ + "endpoint" + ], + "description": "Get a list of all available endpoints", + "parameters": [ + { + "$ref": "#/components/parameters/subjectid" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/200" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + } + } + }, + "/endpoint/{endpoint}": { + "get": { + "x-orn-@type": "x-orn:Endpoint", + "x-orn:path": "https://lazar.prod.openrisknet.org/endpoint", + "x-orn:method": "Get", + "tags": [ + "endpoint" + ], + "description": "Get a list of all available models for an endpoint", + "parameters": [ + { + "$ref": "#/components/parameters/endpoint" + }, + { + "$ref": "#/components/parameters/subjectid" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/200" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + } + } + }, "/model": { "get": { "x-orn-@type": "x-orn:Model", @@ -107,7 +176,7 @@ "tags": [ "model" ], - "description": "Predict a compound or a nanoparticle", + "description": "Predict a compound or a nanoparticle. Also a comma seperated list is allowed.", "parameters": [ { "$ref": "#/components/parameters/id" @@ -1030,6 +1099,10 @@ "name": "descriptor", "description": "Descriptor" }, + { + "name": "endpoint", + "description": "Endpoint" + }, { "name": "feature", "description": "Feature" @@ -1116,6 +1189,15 @@ "type": "string" } }, + "endpoint": { + "name": "endpoint", + "in": "path", + "description": "type", + "required": true, + "schema": { + "type": "string" + } + }, "InChI": { "name": "InChI", "in": "path", -- cgit v1.2.3