summaryrefslogtreecommitdiff
path: root/api/api.json
diff options
context:
space:
mode:
authorrautenberg <rautenberg@in-silico.ch>2016-08-30 18:30:36 +0200
committerrautenberg <rautenberg@in-silico.ch>2016-08-30 18:30:36 +0200
commitf96a6cdfed2b41a3262239a125fc8302ec548914 (patch)
tree8b394d46b427876c0daee9e340365a51563c2c99 /api/api.json
parentc328cc73ff6236cd3f901d003e3d87f22def0c7b (diff)
add dataset routes to api
Diffstat (limited to 'api/api.json')
-rw-r--r--api/api.json145
1 files changed, 145 insertions, 0 deletions
diff --git a/api/api.json b/api/api.json
index d811f21..f64959c 100644
--- a/api/api.json
+++ b/api/api.json
@@ -143,6 +143,147 @@
}
}
},
+ "/dataset": {
+ "get": {
+ "tags": [
+ "dataset"
+ ],
+ "description": "Get a list of all datasets",
+ "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"
+ }
+ }
+ }
+ },
+ "/dataset/{id}": {
+ "get": {
+ "tags": [
+ "dataset"
+ ],
+ "description": "Get dataset representation",
+ "parameters": [
+ {
+ "name": "Content-Type",
+ "in": "header",
+ "description": "body Content-Type",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "application/json"
+ ]
+ },
+ {
+ "$ref": "#/parameters/id"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/responses/200"
+ },
+ "400": {
+ "$ref": "#/responses/400"
+ },
+ "401": {
+ "$ref": "#/responses/401"
+ },
+ "403": {
+ "$ref": "#/responses/403"
+ },
+ "404": {
+ "$ref": "#/responses/404"
+ }
+ }
+ }
+ },
+ "/dataset/{id}/{attribute}": {
+ "get": {
+ "tags": [
+ "dataset"
+ ],
+ "description": "Get dataset representation",
+ "parameters": [
+ {
+ "name": "Content-Type",
+ "in": "header",
+ "description": "body Content-Type",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "application/json"
+ ]
+ },
+ {
+ "name": "attribute",
+ "in": "path",
+ "description": "requested attribute",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "compounds",
+ "nanoparticles",
+ "substances",
+ "features"
+ ]
+ },
+ {
+ "$ref": "#/parameters/id"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/responses/200"
+ },
+ "400": {
+ "$ref": "#/responses/400"
+ },
+ "401": {
+ "$ref": "#/responses/401"
+ },
+ "403": {
+ "$ref": "#/responses/403"
+ },
+ "404": {
+ "$ref": "#/responses/404"
+ }
+ }
+ }
+ },
"/validation": {
"get": {
"tags": [
@@ -571,6 +712,10 @@
"description": "Compound"
},
{
+ "name": "dataset",
+ "description": "Dataset"
+ },
+ {
"name": "validation",
"description": "Validation"
}