Skip to content
Snippets Groups Projects
Commit 559db29a authored by Piotr Gawron's avatar Piotr Gawron
Browse files

auth tokens removed from docs

parent b54b052a
No related branches found
No related tags found
1 merge request!11Resolve "Rest API should follow google guidlines"
This commit is part of merge request !11. Comments created here will be created in the context of that merge request.
Hide whitespace changes
Inline Side-by-side
Showing
with 30 additions and 30 deletions
README.md
+ 30
− 30
View file @ 559db29a
......@@ -59,7 +59,7 @@ curl -X POST -c - http://pg-sandbox.uni.lu/minerva/api/doLogout
* Output: List of all minerva configuration details.
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=4llqer1n2ms298bkqmqet7q59m" http://pg-sandbox.uni.lu/minerva/api/configuration/
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/configuration/
```
### Genomics
......@@ -71,7 +71,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=4llqer1n2ms298bkqmqet7q59m" http://pg-s
* version - version of the reference genome
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=lfqldn2d9a5nksnkkfuqrcilhk" http://pg-sandbox.uni.lu/minerva/api/genomics/taxonomies/9606/genomeTypes/UCSC/versions/hg19/
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/genomics/taxonomies/9606/genomeTypes/UCSC/versions/hg19/
```
### Projects
......@@ -83,7 +83,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=lfqldn2d9a5nksnkkfuqrcilhk" http://pg-s
* projectId - identifier of the project
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=lfqldn2d9a5nksnkkfuqrcilhk" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/
```
* Source file:
......@@ -93,7 +93,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=lfqldn2d9a5nksnkkfuqrcilhk" http://pg-s
* projectId - identifier of the project
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=lfqldn2d9a5nksnkkfuqrcilhk" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_jun16:downloadSource --output some.file
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_jun16:downloadSource --output some.file
```
#### (sub)Maps
......@@ -104,7 +104,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=lfqldn2d9a5nksnkkfuqrcilhk" http://pg-s
* See also `/configuration/` query to get list of possible formats
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" "http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/models/15305:downloadModel?handlerClass=lcsb.mapviewer.converter.model.celldesigner.CellDesignerXmlParser" --output some.file
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" "http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/models/15305:downloadModel?handlerClass=lcsb.mapviewer.converter.model.celldesigner.CellDesignerXmlParser" --output some.file
```
* Download map as an image
......@@ -114,7 +114,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" "http://pg-
* See also `/configuration/` query to get list of possible formats
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" "http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/models/15305:downloadImage?handlerClass=lcsb.mapviewer.converter.graphics.PngImageGenerator" --output some.file
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" "http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/models/15305:downloadImage?handlerClass=lcsb.mapviewer.converter.graphics.PngImageGenerator" --output some.file
```
* Elements:
......@@ -125,7 +125,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" "http://pg-
* `ids` - set of database ids
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=lfqldn2d9a5nksnkkfuqrcilhk" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/models/*/bioEntities/elements/?columns=id,name,type
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/models/*/bioEntities/elements/?columns=id,name,type
```
* Reactions:
......@@ -136,7 +136,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=lfqldn2d9a5nksnkkfuqrcilhk" http://pg-s
* `ids` - set of database ids
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=lfqldn2d9a5nksnkkfuqrcilhk" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/models/*/bioEntities/reactions/?columns=id,name,type
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/models/*/bioEntities/reactions/?columns=id,name,type
```
* Search:
......@@ -145,7 +145,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=lfqldn2d9a5nksnkkfuqrcilhk" http://pg-s
* Parameters: TODO
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/models/*/bioEntities:search?query=SNCA
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/models/*/bioEntities:search?query=SNCA
```
* Suggested search queries:
......@@ -154,7 +154,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-s
* Parameters: TODO
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/models/*/bioEntities/suggestedQueryList
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/models/*/bioEntities/suggestedQueryList
```
......@@ -164,7 +164,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-s
* Parameters: TODO
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" "http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/chemicals:search?query=rotenone"
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" "http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/chemicals:search?query=rotenone"
```
#### Comments
......@@ -174,7 +174,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" "http://pg-
* Parameters: TODO
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" "http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/comments/models/*/"
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" "http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/comments/models/*/"
```
* Reaction comments
......@@ -183,7 +183,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" "http://pg-
* Parameters: TODO
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/comments/models/15305/bioEntities/reactions/187811/
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/comments/models/15305/bioEntities/reactions/187811/
```
* Element comments
......@@ -192,7 +192,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-s
* Parameters: TODO
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/comments/models/15305/bioEntities/elements/431868/
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/comments/models/15305/bioEntities/elements/431868/
```
* Point comments
......@@ -207,7 +207,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-s
* Parameters: TODO
* Example:
```
curl -X POST --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" --data "name=testComment&email=a@a.pl&content=someCont&coordinates=1,2" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/comments/models/15305/bioEntities/elements/431868/
curl -X POST --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" --data "name=testComment&email=a@a.pl&content=someCont&coordinates=1,2" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/comments/models/15305/bioEntities/elements/431868/
```
* Create reaction comment
......@@ -216,7 +216,7 @@ curl -X POST --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" --data "na
* Parameters: TODO
* Example:
```
curl -X POST --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" --data "name=testComment&email=a@a.pl&content=someCont&coordinates=1,2" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/comments/models/15305/bioEntities/reactions/187811
curl -X POST --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" --data "name=testComment&email=a@a.pl&content=someCont&coordinates=1,2" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/comments/models/15305/bioEntities/reactions/187811
```
......@@ -226,7 +226,7 @@ curl -X POST --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" --data "na
* Parameters: TODO
* Example:
```
curl -X POST --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" --data "name=testComment&email=a@a.pl&content=someCont" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/comments/models/15305/points/1.00,2.00
curl -X POST --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" --data "name=testComment&email=a@a.pl&content=someCont" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/comments/models/15305/points/1.00,2.00
```
#### Drugs
......@@ -235,7 +235,7 @@ curl -X POST --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" --data "na
* Parameters: TODO
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/drugs:search?query=aspirin
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/drugs:search?query=aspirin
```
#### MiRNAs
......@@ -245,7 +245,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-s
* Parameters: TODO
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/miRnas:search?query=hsa-miR-125a-3p
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
```
......@@ -256,7 +256,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-s
* Parameters: TODO
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/models/*/publications/
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/models/*/publications/
```
#### Data overlays
......@@ -266,7 +266,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-s
* Parameters: TODO
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/
```
* Data overlay
......@@ -275,7 +275,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-s
* Parameters: TODO
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/
```
* bioEntities (Elements and reactions)
......@@ -284,7 +284,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-s
* Parameters: TODO
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/models/*/bioEntities/
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/models/*/bioEntities/
```
* Reaction
......@@ -293,7 +293,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-s
* Parameters: TODO
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/models/15305/bioEntities/reactions/187811/
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/models/15305/bioEntities/reactions/187811/
```
* Element
......@@ -302,7 +302,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-s
* Parameters: TODO
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/models/15305/bioEntities/elements/431433/
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/models/15305/bioEntities/elements/431433/
```
* Update overlay
......@@ -311,7 +311,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=gaceo10sovupaojseb2ui69igr" http://pg-s
* Parameters: TODO
* Example:
```
curl -X PATCH --data "{\"overlay\":{\"name\":\"test\", \"description\":\"test2\"}}" --cookie "MINERVA_AUTH_TOKEN=h710fmgs3tpijv65gti44v4532" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/
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/
```
......@@ -321,7 +321,7 @@ curl -X PATCH --data "{\"overlay\":{\"name\":\"test\", \"description\":\"test2\"
* Parameters: TODO
* Example:
```
curl -X DELETE --cookie "MINERVA_AUTH_TOKEN=kl3aminujactlvadki2d6ce5gt" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/
curl -X DELETE --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/
```
* Download source
......@@ -330,7 +330,7 @@ curl -X DELETE --cookie "MINERVA_AUTH_TOKEN=kl3aminujactlvadki2d6ce5gt" http://p
* Parameters: TODO
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=kl3aminujactlvadki2d6ce5gt" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203:downloadSource
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203:downloadSource
```
* Add overlay
......@@ -339,7 +339,7 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=kl3aminujactlvadki2d6ce5gt" http://pg-s
* Parameters: TODO
* 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=daehbfm21htm9kp09gvak1m3hk" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/
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/
```
......@@ -350,6 +350,6 @@ curl -X POST --data "content=name%09color%0ACAPN1%09%2300FF00%0APARK7%09%23AC000
* Parameters: TODO
* Example:
```
curl -X GET --cookie "MINERVA_AUTH_TOKEN=daehbfm21htm9kp09gvak1m3hk" http://pg-sandbox.uni.lu/minerva/api/users/testAdmin
curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/users/testAdmin
```
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment