summaryrefslogtreecommitdiff
path: root/api
diff options
context:
space:
mode:
authorgebele <gebele@in-silico.ch>2018-07-05 10:38:55 +0000
committergebele <gebele@in-silico.ch>2018-07-05 10:38:55 +0000
commit878f014ec6cc808af99af5045bcc1a1143cab8d9 (patch)
tree38458f73295d58c2ab487c81056d0abf0e4c4c19 /api
parent395506ca3fe4daa5689fd197e57f7ab944beb1d7 (diff)
updated with endpoint list; refined error handling; refined prediction input
Diffstat (limited to 'api')
-rw-r--r--api/api.json84
1 files changed, 83 insertions, 1 deletions
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"
@@ -1031,6 +1100,10 @@
"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",