summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgebele <gebele@in-silico.ch>2018-07-20 15:34:45 +0000
committergebele <gebele@in-silico.ch>2018-07-20 15:34:45 +0000
commit270742ab03bd8df74f9197e6f48e11702b0efbdc (patch)
tree9e22e757d5f3c0b7b212458a1e3d781dec756022
parent878f014ec6cc808af99af5045bcc1a1143cab8d9 (diff)
reordered;added valtypes enum;
-rw-r--r--api/api.json640
1 files changed, 326 insertions, 314 deletions
diff --git a/api/api.json b/api/api.json
index 718421f..b7065b2 100644
--- a/api/api.json
+++ b/api/api.json
@@ -15,7 +15,7 @@
],
"info": {
"description": "REST API webservice for lazar and nano-lazar. \n\n*lazar* (lazy structure–activity relationships) is a modular framework for\npredictive toxicology. With activated Authentication & Authorization,\nsubjectid authorization token are obligatory for designated services.\n",
- "version": "1.1.0",
+ "version": "1.3.0",
"title": "Lazar & Nano-Lazar REST Service",
"contact": {
"name": "in silico toxicology gmbh",
@@ -32,20 +32,12 @@
"url": "https://github.com/opentox/lazar-rest"
},
"paths": {
- "/endpoint": {
+ "/api/api.json": {
"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"
- }
+ "api"
],
+ "description": "Get swagger api in JSON",
"responses": {
"200": {
"$ref": "#/components/responses/200"
@@ -53,35 +45,23 @@
"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",
+ "/aa/authenticate": {
+ "post": {
+ "x-orn-@type": "x-orn:Authentication",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/aa/authenticate",
+ "x-orn:method": "Post",
"tags": [
- "endpoint"
- ],
- "description": "Get a list of all available models for an endpoint",
- "parameters": [
- {
- "$ref": "#/components/parameters/endpoint"
- },
- {
- "$ref": "#/components/parameters/subjectid"
- }
+ "authentication"
],
+ "summary": "Get token",
+ "description": "Authentication against OpenSSO. Returns authentication token. Requires\nUsername and Password.\n",
+ "operationId": "login",
"responses": {
"200": {
"$ref": "#/components/responses/200"
@@ -92,28 +72,34 @@
"401": {
"$ref": "#/components/responses/401"
},
- "404": {
- "$ref": "#/components/responses/404"
- },
"500": {
"$ref": "#/components/responses/500"
}
+ },
+ "requestBody": {
+ "description": "username and password",
+ "required": true,
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "x-orn:schema": "application/x-www-form-urlencoded",
+ "schema": {
+ "$ref": "#/components/schemas/postauth"
+ }
+ }
+ }
}
}
},
- "/model": {
- "get": {
- "x-orn-@type": "x-orn:Model",
- "x-orn:path": "https://lazar.prod.openrisknet.org/model",
- "x-orn:method": "Get",
+ "/aa/logout": {
+ "post": {
+ "x-orn-@type": "x-orn:Authentication",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/aa/logout",
+ "x-orn:method": "Post",
+ "description": "Devalidates a token. Requires Subjectid.",
+ "summary": "Destroy token",
+ "operationId": "logout",
"tags": [
- "model"
- ],
- "description": "Get a list of all prediction models",
- "parameters": [
- {
- "$ref": "#/components/parameters/subjectid"
- }
+ "authentication"
],
"responses": {
"200": {
@@ -125,29 +111,35 @@
"401": {
"$ref": "#/components/responses/401"
},
- "404": {
- "$ref": "#/components/responses/404"
- },
"500": {
"$ref": "#/components/responses/500"
}
+ },
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "x-orn:schema": "application/x-www-form-urlencoded",
+ "schema": {
+ "$ref": "#/components/schemas/postlogout"
+ }
+ }
+ }
}
}
},
- "/model/{id}": {
+ "/compound/descriptor": {
"get": {
- "x-orn-@type": "x-orn:Model",
- "x-orn:path": "https://lazar.prod.openrisknet.org/model",
+ "x-orn-@type": "x-orn:Descriptor",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/compound/descriptor",
"x-orn:method": "Get",
"tags": [
- "model"
+ "compound",
+ "descriptor"
],
- "description": "Get model representation",
+ "description": "Get a list of all descriptors",
"parameters": [
{
- "$ref": "#/components/parameters/id"
- },
- {
"$ref": "#/components/parameters/subjectid"
}
],
@@ -161,27 +153,26 @@
"401": {
"$ref": "#/components/responses/401"
},
- "403": {
- "$ref": "#/components/responses/403"
- },
"404": {
"$ref": "#/components/responses/404"
+ },
+ "500": {
+ "$ref": "#/components/responses/500"
}
}
},
"post": {
"x-orn-@type": "x-orn:Prediction",
- "x-orn:path": "https://lazar.prod.openrisknet.org/model/{id}",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/compound/descriptor",
"x-orn:method": "Post",
"tags": [
- "model"
+ "compound",
+ "descriptor"
],
- "description": "Predict a compound or a nanoparticle. Also a comma seperated list is allowed.",
+ "summary": "Descriptor calculation",
+ "description": "Calculate descriptors for a single compound as SMILES string",
"parameters": [
{
- "$ref": "#/components/parameters/id"
- },
- {
"$ref": "#/components/parameters/subjectid"
}
],
@@ -195,38 +186,48 @@
"401": {
"$ref": "#/components/responses/401"
},
- "403": {
- "$ref": "#/components/responses/403"
- },
"404": {
"$ref": "#/components/responses/404"
+ },
+ "500": {
+ "$ref": "#/components/responses/500"
}
},
"requestBody": {
- "description": "SMILES identifier or Nanoparticle URI or comma separated\nlist of SMILES identifiers or Nanoparticle URI\n",
+ "description": "identifier and descriptor/s",
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"x-orn:schema": "application/x-www-form-urlencoded",
"schema": {
- "$ref": "#/components/schemas/postmodel"
+ "$ref": "#/components/schemas/postdescriptor"
}
}
}
}
}
},
- "/report": {
+ "/compound/descriptor/{descriptor}": {
"get": {
- "x-orn-@type": "x-orn:Report",
- "x-orn:path": "https://lazar.prod.openrisknet.org/report",
+ "x-orn-@type": "x-orn:Descriptor",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/compound/descriptor/{descriptor}",
"x-orn:method": "Get",
"tags": [
- "report"
+ "compound",
+ "descriptor"
],
- "description": "Get a list of QMRF reports",
+ "description": "Get informations about a single descriptor",
"parameters": [
{
+ "name": "descriptor",
+ "in": "path",
+ "description": "descriptor name or ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
"$ref": "#/components/parameters/subjectid"
}
],
@@ -249,18 +250,18 @@
}
}
},
- "/report/{id}": {
+ "/compound/{InChI}": {
"get": {
- "x-orn-@type": "x-orn:Report",
- "x-orn:path": "https://lazar.prod.openrisknet.org/report/{id}",
+ "x-orn-@type": "x-orn:Compound",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/compound/{InChI}",
"x-orn:method": "Get",
"tags": [
- "report"
+ "compound"
],
- "description": "Get QMRF for prediction model",
+ "description": "Get compound representation",
"parameters": [
{
- "$ref": "#/components/parameters/id"
+ "$ref": "#/components/parameters/InChI"
},
{
"$ref": "#/components/parameters/subjectid"
@@ -268,19 +269,71 @@
],
"responses": {
"200": {
- "$ref": "#/components/responses/200"
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "x-orn:returns": "application/json",
+ "schema": {
+ "x-orn:property": "InChI",
+ "type": "string",
+ "example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
+ }
+ },
+ "chemical/x-daylight-smiles": {
+ "x-orn:returns": "chemical/x-daylight-smiles",
+ "schema": {
+ "x-orn:property": "InChI",
+ "type": "string",
+ "example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
+ }
+ },
+ "chemical/x-inchi": {
+ "x-orn:returns": "chemical/x-inchi",
+ "schema": {
+ "x-orn:property": "InChI",
+ "type": "string",
+ "example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
+ }
+ },
+ "chemical/x-mdl-sdfile": {
+ "x-orn:returns": "chemical/x-mdl-sdfile",
+ "schema": {
+ "x-orn:property": "InChI",
+ "type": "string",
+ "example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
+ }
+ },
+ "image/png": {
+ "x-orn:returns": "image/png",
+ "schema": {
+ "x-orn:property": "InChI",
+ "type": "string",
+ "example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
+ }
+ },
+ "image/svg+xml": {
+ "x-orn:returns": "image/svg+xml",
+ "schema": {
+ "x-orn:property": "InChI",
+ "type": "string",
+ "example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
+ }
+ },
+ "text/plain": {
+ "x-orn:returns": "text/plain",
+ "schema": {
+ "x-orn:property": "InChI",
+ "type": "string",
+ "example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
+ }
+ }
+ }
},
"400": {
"$ref": "#/components/responses/400"
},
- "401": {
- "$ref": "#/components/responses/401"
- },
- "403": {
- "$ref": "#/components/responses/403"
- },
- "404": {
- "$ref": "#/components/responses/404"
+ "500": {
+ "$ref": "#/components/responses/500"
}
}
}
@@ -363,8 +416,8 @@
"example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
}
}
- }
- },
+ }
+ },
"400": {
"$ref": "#/components/responses/400"
},
@@ -437,15 +490,15 @@
}
}
},
- "/substance": {
+ "/endpoint": {
"get": {
- "x-orn-@type": "x-orn:Substance",
- "x-orn:path": "https://lazar.prod.openrisknet.org/substance",
+ "x-orn-@type": "x-orn:Endpoint",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/endpoint",
"x-orn:method": "Get",
"tags": [
- "substance"
+ "endpoint"
],
- "description": "Get a list of all substances",
+ "description": "Get a list of all available endpoints",
"parameters": [
{
"$ref": "#/components/parameters/subjectid"
@@ -470,18 +523,18 @@
}
}
},
- "/substance/{id}": {
+ "/endpoint/{endpoint}": {
"get": {
- "x-orn-@type": "x-orn:Substance",
- "x-orn:path": "https://lazar.prod.openrisknet.org/substance/{id}",
+ "x-orn-@type": "x-orn:Endpoint",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/endpoint",
"x-orn:method": "Get",
"tags": [
- "substance"
+ "endpoint"
],
- "description": "Get substance representation",
+ "description": "Get a list of all available models for an endpoint",
"parameters": [
{
- "$ref": "#/components/parameters/id"
+ "$ref": "#/components/parameters/endpoint"
},
{
"$ref": "#/components/parameters/subjectid"
@@ -497,9 +550,6 @@
"401": {
"$ref": "#/components/responses/401"
},
- "403": {
- "$ref": "#/components/responses/403"
- },
"404": {
"$ref": "#/components/responses/404"
},
@@ -509,15 +559,15 @@
}
}
},
- "/nanoparticle": {
+ "/feature": {
"get": {
- "x-orn-@type": "x-orn:Nanoparticle",
- "x-orn:path": "https://lazar.prod.openrisknet.org/nanoparticle",
+ "x-orn-@type": "x-orn:Feature",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/feature",
"x-orn:method": "Get",
"tags": [
- "nanoparticle"
+ "feature"
],
- "description": "Get a list of all nanoparticles",
+ "description": "Get a list of ids for all features",
"parameters": [
{
"$ref": "#/components/parameters/subjectid"
@@ -542,15 +592,15 @@
}
}
},
- "/nanoparticle/{id}": {
+ "/feature/{id}": {
"get": {
- "x-orn-@type": "x-orn:Nanoparticle",
- "x-orn:path": "https://lazar.prod.openrisknet.org/nanoparticle/{id}",
+ "x-orn-@type": "x-orn:Feature",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/feature/{id}",
"x-orn:method": "Get",
"tags": [
- "nanoparticle"
+ "feature"
],
- "description": "Get nanoparticle representation",
+ "description": "Get feature representation",
"parameters": [
{
"$ref": "#/components/parameters/id"
@@ -581,15 +631,15 @@
}
}
},
- "/feature": {
+ "/nanoparticle": {
"get": {
- "x-orn-@type": "x-orn:Feature",
- "x-orn:path": "https://lazar.prod.openrisknet.org/feature",
+ "x-orn-@type": "x-orn:Nanoparticle",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/nanoparticle",
"x-orn:method": "Get",
"tags": [
- "feature"
+ "nanoparticle"
],
- "description": "Get a list of ids for all features",
+ "description": "Get a list of all nanoparticles",
"parameters": [
{
"$ref": "#/components/parameters/subjectid"
@@ -614,15 +664,15 @@
}
}
},
- "/feature/{id}": {
+ "/nanoparticle/{id}": {
"get": {
- "x-orn-@type": "x-orn:Feature",
- "x-orn:path": "https://lazar.prod.openrisknet.org/feature/{id}",
+ "x-orn-@type": "x-orn:Nanoparticle",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/nanoparticle/{id}",
"x-orn:method": "Get",
"tags": [
- "feature"
+ "nanoparticle"
],
- "description": "Get feature representation",
+ "description": "Get nanoparticle representation",
"parameters": [
{
"$ref": "#/components/parameters/id"
@@ -653,15 +703,15 @@
}
}
},
- "/validation": {
+ "/model": {
"get": {
- "x-orn-@type": "x-orn:Validation",
- "x-orn:path": "https://lazar.prod.openrisknet.org/validation",
+ "x-orn-@type": "x-orn:Model",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/model",
"x-orn:method": "Get",
"tags": [
- "validation"
+ "model"
],
- "description": "Get a list of all validation types",
+ "description": "Get a list of all prediction models",
"parameters": [
{
"$ref": "#/components/parameters/subjectid"
@@ -686,18 +736,18 @@
}
}
},
- "/validation/{validationtype}": {
+ "/model/{id}": {
"get": {
- "x-orn-@type": "x-orn:Validation",
- "x-orn:path": "https://lazar.prod.openrisknet.org/validation/{validationtype}",
+ "x-orn-@type": "x-orn:Model",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/model",
"x-orn:method": "Get",
"tags": [
- "validation"
+ "model"
],
- "description": "Get all validations of a validation type",
+ "description": "Get model representation",
"parameters": [
{
- "$ref": "#/components/parameters/valtype"
+ "$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/subjectid"
@@ -718,27 +768,19 @@
},
"404": {
"$ref": "#/components/responses/404"
- },
- "500": {
- "$ref": "#/components/responses/500"
}
}
- }
- },
- "/validation/{validationtype}/{id}": {
- "get": {
- "x-orn-@type": "x-orn:Validation",
- "x-orn:path": "https://lazar.prod.openrisknet.org/validation/{validationtype}/{id}",
- "x-orn:method": "Get",
+ },
+ "post": {
+ "x-orn-@type": "x-orn:Prediction",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/model/{id}",
+ "x-orn:method": "Post",
"tags": [
- "validation"
+ "model"
],
- "description": "Get validation representation",
+ "description": "Predict a compound or a nanoparticle. Also a comma seperated list is allowed.",
"parameters": [
{
- "$ref": "#/components/parameters/valtype"
- },
- {
"$ref": "#/components/parameters/id"
},
{
@@ -760,23 +802,31 @@
},
"404": {
"$ref": "#/components/responses/404"
- },
- "500": {
- "$ref": "#/components/responses/500"
+ }
+ },
+ "requestBody": {
+ "description": "SMILES identifier or Nanoparticle URI or comma separated\nlist of SMILES identifiers or Nanoparticle URI\n",
+ "required": true,
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "x-orn:schema": "application/x-www-form-urlencoded",
+ "schema": {
+ "$ref": "#/components/schemas/postmodel"
+ }
+ }
}
}
}
},
- "/compound/descriptor": {
+ "/report": {
"get": {
- "x-orn-@type": "x-orn:Descriptor",
- "x-orn:path": "https://lazar.prod.openrisknet.org/compound/descriptor",
+ "x-orn-@type": "x-orn:Report",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/report",
"x-orn:method": "Get",
"tags": [
- "compound",
- "descriptor"
+ "report"
],
- "description": "Get a list of all descriptors",
+ "description": "Get a list of QMRF reports",
"parameters": [
{
"$ref": "#/components/parameters/subjectid"
@@ -799,19 +849,22 @@
"$ref": "#/components/responses/500"
}
}
- },
- "post": {
- "x-orn-@type": "x-orn:Prediction",
- "x-orn:path": "https://lazar.prod.openrisknet.org/compound/descriptor",
- "x-orn:method": "Post",
+ }
+ },
+ "/report/{id}": {
+ "get": {
+ "x-orn-@type": "x-orn:Report",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/report/{id}",
+ "x-orn:method": "Get",
"tags": [
- "compound",
- "descriptor"
+ "report"
],
- "summary": "Descriptor calculation",
- "description": "Calculate descriptors for a single compound as SMILES string",
+ "description": "Get QMRF for prediction model",
"parameters": [
{
+ "$ref": "#/components/parameters/id"
+ },
+ {
"$ref": "#/components/parameters/subjectid"
}
],
@@ -825,48 +878,26 @@
"401": {
"$ref": "#/components/responses/401"
},
+ "403": {
+ "$ref": "#/components/responses/403"
+ },
"404": {
"$ref": "#/components/responses/404"
- },
- "500": {
- "$ref": "#/components/responses/500"
- }
- },
- "requestBody": {
- "description": "identifier and descriptor/s",
- "required": true,
- "content": {
- "application/x-www-form-urlencoded": {
- "x-orn:schema": "application/x-www-form-urlencoded",
- "schema": {
- "$ref": "#/components/schemas/postdescriptor"
- }
- }
}
}
}
},
- "/compound/descriptor/{descriptor}": {
+ "/substance": {
"get": {
- "x-orn-@type": "x-orn:Descriptor",
- "x-orn:path": "https://lazar.prod.openrisknet.org/compound/descriptor/{descriptor}",
+ "x-orn-@type": "x-orn:Substance",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/substance",
"x-orn:method": "Get",
"tags": [
- "compound",
- "descriptor"
+ "substance"
],
- "description": "Get informations about a single descriptor",
+ "description": "Get a list of all substances",
"parameters": [
{
- "name": "descriptor",
- "in": "path",
- "description": "descriptor name or ID",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
"$ref": "#/components/parameters/subjectid"
}
],
@@ -889,18 +920,18 @@
}
}
},
- "/compound/{InChI}": {
+ "/substance/{id}": {
"get": {
- "x-orn-@type": "x-orn:Compound",
- "x-orn:path": "https://lazar.prod.openrisknet.org/compound/{InChI}",
+ "x-orn-@type": "x-orn:Substance",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/substance/{id}",
"x-orn:method": "Get",
"tags": [
- "compound"
+ "substance"
],
- "description": "Get compound representation",
+ "description": "Get substance representation",
"parameters": [
{
- "$ref": "#/components/parameters/InChI"
+ "$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/subjectid"
@@ -908,81 +939,40 @@
],
"responses": {
"200": {
- "description": "OK",
- "content": {
- "application/json": {
- "x-orn:returns": "application/json",
- "schema": {
- "x-orn:property": "InChI",
- "type": "string",
- "example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
- }
- },
- "chemical/x-daylight-smiles": {
- "x-orn:returns": "chemical/x-daylight-smiles",
- "schema": {
- "x-orn:property": "InChI",
- "type": "string",
- "example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
- }
- },
- "chemical/x-inchi": {
- "x-orn:returns": "chemical/x-inchi",
- "schema": {
- "x-orn:property": "InChI",
- "type": "string",
- "example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
- }
- },
- "chemical/x-mdl-sdfile": {
- "x-orn:returns": "chemical/x-mdl-sdfile",
- "schema": {
- "x-orn:property": "InChI",
- "type": "string",
- "example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
- }
- },
- "image/png": {
- "x-orn:returns": "image/png",
- "schema": {
- "x-orn:property": "InChI",
- "type": "string",
- "example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
- }
- },
- "image/svg+xml": {
- "x-orn:returns": "image/svg+xml",
- "schema": {
- "x-orn:property": "InChI",
- "type": "string",
- "example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
- }
- },
- "text/plain": {
- "x-orn:returns": "text/plain",
- "schema": {
- "x-orn:property": "InChI",
- "type": "string",
- "example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
- }
- }
- }
+ "$ref": "#/components/responses/200"
},
"400": {
"$ref": "#/components/responses/400"
},
+ "401": {
+ "$ref": "#/components/responses/401"
+ },
+ "403": {
+ "$ref": "#/components/responses/403"
+ },
+ "404": {
+ "$ref": "#/components/responses/404"
+ },
"500": {
"$ref": "#/components/responses/500"
}
}
}
},
- "/api/api.json": {
+ "/validation": {
"get": {
+ "x-orn-@type": "x-orn:Validation",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/validation",
+ "x-orn:method": "Get",
"tags": [
- "api"
+ "validation"
+ ],
+ "description": "Get a list of all validation types",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/subjectid"
+ }
],
- "description": "Get swagger api in JSON",
"responses": {
"200": {
"$ref": "#/components/responses/200"
@@ -990,23 +980,35 @@
"400": {
"$ref": "#/components/responses/400"
},
+ "401": {
+ "$ref": "#/components/responses/401"
+ },
+ "404": {
+ "$ref": "#/components/responses/404"
+ },
"500": {
"$ref": "#/components/responses/500"
}
}
}
},
- "/aa/authenticate": {
- "post": {
- "x-orn-@type": "x-orn:Authentication",
- "x-orn:path": "https://lazar.prod.openrisknet.org/aa/authenticate",
- "x-orn:method": "Post",
+ "/validation/{validationtype}": {
+ "get": {
+ "x-orn-@type": "x-orn:Validation",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/validation/{validationtype}",
+ "x-orn:method": "Get",
"tags": [
- "authentication"
+ "validation"
+ ],
+ "description": "Get all validations of a validation type",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/valtype"
+ },
+ {
+ "$ref": "#/components/parameters/subjectid"
+ }
],
- "summary": "Get token",
- "description": "Authentication against OpenSSO. Returns authentication token. Requires\nUsername and Password.\n",
- "operationId": "login",
"responses": {
"200": {
"$ref": "#/components/responses/200"
@@ -1017,34 +1019,37 @@
"401": {
"$ref": "#/components/responses/401"
},
+ "403": {
+ "$ref": "#/components/responses/403"
+ },
+ "404": {
+ "$ref": "#/components/responses/404"
+ },
"500": {
"$ref": "#/components/responses/500"
}
- },
- "requestBody": {
- "description": "username and password",
- "required": true,
- "content": {
- "application/x-www-form-urlencoded": {
- "x-orn:schema": "application/x-www-form-urlencoded",
- "schema": {
- "$ref": "#/components/schemas/postauth"
- }
- }
- }
}
}
},
- "/aa/logout": {
- "post": {
- "x-orn-@type": "x-orn:Authentication",
- "x-orn:path": "https://lazar.prod.openrisknet.org/aa/logout",
- "x-orn:method": "Post",
- "description": "Devalidates a token. Requires Subjectid.",
- "summary": "Destroy token",
- "operationId": "logout",
+ "/validation/{validationtype}/{id}": {
+ "get": {
+ "x-orn-@type": "x-orn:Validation",
+ "x-orn:path": "https://lazar.prod.openrisknet.org/validation/{validationtype}/{id}",
+ "x-orn:method": "Get",
"tags": [
- "authentication"
+ "validation"
+ ],
+ "description": "Get validation representation",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/valtype"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ },
+ {
+ "$ref": "#/components/parameters/subjectid"
+ }
],
"responses": {
"200": {
@@ -1056,20 +1061,15 @@
"401": {
"$ref": "#/components/responses/401"
},
+ "403": {
+ "$ref": "#/components/responses/403"
+ },
+ "404": {
+ "$ref": "#/components/responses/404"
+ },
"500": {
"$ref": "#/components/responses/500"
}
- },
- "requestBody": {
- "required": true,
- "content": {
- "application/x-www-form-urlencoded": {
- "x-orn:schema": "application/x-www-form-urlencoded",
- "schema": {
- "$ref": "#/components/schemas/postlogout"
- }
- }
- }
}
}
}
@@ -1213,7 +1213,13 @@
"description": "validation type",
"required": true,
"schema": {
- "type": "string"
+ "type": "string",
+ "enum": [
+ "crossvalidation",
+ "leaveoneout",
+ "repeatedcrossvalidation",
+ "regressioncrossvalidation"
+ ]
}
},
"subjectid": {
@@ -1244,6 +1250,12 @@
"schema": {
"type": "object"
}
+ },
+ "text/plain": {
+ "x-orn:returns": "text/uri-list",
+ "schema": {
+ "type": "object"
+ }
}
}
},
@@ -1264,4 +1276,4 @@
}
}
}
-}
+} \ No newline at end of file