From c8d98751a973d3fdb5cbe9e9604066eb06f22980 Mon Sep 17 00:00:00 2001
From: Piotr Gawron <piotr.gawron@uni.lu>
Date: Mon, 10 Jul 2017 15:14:40 +0200
Subject: [PATCH] Update README.md
---
README.md | 58 +++++++++++++++++++++++++++----------------------------
1 file changed, 29 insertions(+), 29 deletions(-)
diff --git a/README.md b/README.md
index 36b6055fad..ebefb9ef5e 100644
--- a/README.md
+++ b/README.md
@@ -243,10 +243,10 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine
* Method: GET
* Parameters:
* `projectId` - identifier of the project
- * `modelId` - identifier of the (sub)map in the project or wildcard '*' character
+ * `modelId` - identifier of the (sub)map in the project or wildcard '*' character
* `coordinates` - coordinates of the point on (sub)map
- * `columns` (\*) - set of columns for each result. Possible values are: title, type, content, removed, coord, modelId, elementId, id, pinned, author, email,
- * `removed` (\*) - if defined then removed paramter must match.
+ * `columns` (\*) - set of columns for each result. Possible values are: title, type, content, removed, coord, modelId, elementId, id, pinned, author, email,
+ * `removed` (\*) - if defined then removed paramter must match.
* Example: TODO
* Create element comment
@@ -254,7 +254,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine
* Method: POST
* Parameters:
* `projectId` - identifier of the project
- * `modelId` - identifier of the (sub)map in the project
+ * `modelId` - identifier of the (sub)map in the project
* `elementId` - identifier of the element to be commented
* `name` - name of the author
* `email` - email of the author
@@ -271,7 +271,7 @@ curl -X POST --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" --data "name=testComment&ema
* Method: POST
* Parameters:
* `projectId` - identifier of the project
- * `modelId` - identifier of the (sub)map in the project
+ * `modelId` - identifier of the (sub)map in the project
* `reactionId` - identifier of the reaction
* `name` - name of the author
* `email` - email of the author
@@ -289,7 +289,7 @@ curl -X POST --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" --data "name=testComment&ema
* Method: GET
* Parameters:
* `projectId` - identifier of the project
- * `modelId` - identifier of the (sub)map in the project
+ * `modelId` - identifier of the (sub)map in the project
* `name` - name of the author
* `email` - email of the author
* `content` - content of the comment
@@ -304,10 +304,10 @@ curl -X POST --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" --data "name=testComment&ema
* URL: `/projects/{projectId}/drugs:search`
* Method: GET
* Parameters:
- * `projectId` - identifier of the project
- * `columns` (\*) - set of columns for each result. Possible values are: name, references, description, bloodBrainBarrier, brandNames, synonyms, id, targets,
- * `query` (\*) - drug name or synonym
- * `target` (\*) - target for which we are lookig for drugs. Target is defined as TYPE:ID. For example "ALIAS:534" is searching for drugs that target Alias with id=534.
+ * `projectId` - identifier of the project
+ * `columns` (\*) - set of columns for each result. Possible values are: name, references, description, bloodBrainBarrier, brandNames, synonyms, id, targets,
+ * `query` (\*) - drug name or synonym
+ * `target` (\*) - target for which we are lookig for drugs. Target is defined as TYPE:ID. For example "ALIAS:534" is searching for drugs that target Alias with id=534.
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/drugs:search?query=aspirin
@@ -318,10 +318,10 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine
* URL: `/projects/{projectId}/miRnas:search`
* Method: GET
* Parameters:
- * `projectId` - identifier of the project
- * `columns` (\*) - set of columns for each result. Possible values are: name, id, targets,
- * `query` (\*) - mirna id
- * `target` (\*) - target for which we are lookig for drugs. Target is defined as TYPE:ID. For example "ALIAS:534" is searching for drugs that target Alias with id=534.
+ * `projectId` - identifier of the project
+ * `columns` (\*) - set of columns for each result. Possible values are: name, id, targets,
+ * `query` (\*) - mirna id
+ * `target` (\*) - target for which we are lookig for drugs. Target is defined as TYPE:ID. For example "ALIAS:534" is searching for drugs that target Alias with id=534.
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/miRnas:search?query=hsa-miR-125a-3p
@@ -334,7 +334,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine
* Method: GET
* Parameters:
* `projectId` - identifier of the project
- * `modelId` - identifier of the (sub)map in the project or wildcard '*' character
+ * `modelId` - identifier of the (sub)map in the project or wildcard '\*' character
* `start` (\*) - first element to be return when pagination is on (default 0)
* `length` (\*) - how many publication we want to retrieve (default 10)
@@ -359,10 +359,10 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine
* Method: POST
* Parameters:
* `projectId` - identifier of the project
- * `name` - name of the data overlay
- * `content` - content of the file that is uploaded with definition what should be visible where
- * `description` - short desription of the data overlay
- * `filename` - name of the file that should be used when downloading the source
+ * `name` - name of the data overlay
+ * `content` - content of the file that is uploaded with definition what should be visible where
+ * `description` - short desription of the data overlay
+ * `filename` - name of the file that should be used when downloading the source
* Example:
```
curl -X POST --data "content=name%09color%0ACAPN1%09%2300FF00%0APARK7%09%23AC0000&description=test%20desc&filename=test.txt&name=test%20nam" --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/
@@ -375,14 +375,14 @@ curl -X POST --data "content=name%09color%0ACAPN1%09%2300FF00%0APARK7%09%23AC000
* `projectId` - identifier of the project
* `overlayId` - identifier of data overlay
* Body: json with updated overlay
-```
- {
- "overlay": {
- "name" : name,
- "description" : description
- }
- }
-```
+
+{
+ "overlay": {
+ "name" : name,
+ "description" : description
+ }
+}
+
* Example:
```
curl -X PATCH --data "{\"overlay\":{\"name\":\"test\", \"description\":\"test2\"}}" --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/
@@ -437,7 +437,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine
* Method: GET
* Parameters:
* `projectId` - identifier of the project
- * `modelId` - identifier of the (sub)map in the project
+ * `modelId` - identifier of the (sub)map in the project
* `overlayId` - identifier of data overlay
* `reactionId` - identifier of the reaction
* Example:
@@ -450,7 +450,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine
* Method: GET
* Parameters:
* `projectId` - identifier of the project
- * `modelId` - identifier of the (sub)map in the project
+ * `modelId` - identifier of the (sub)map in the project
* `overlayId` - identifier of data overlay
* `elementId` - identifier of the element
* Example:
--
GitLab