diff --git a/README.md b/README.md index e5e5c708c7405edcf459c632dcc8ed840d8f13f2..a54746db563a1a3f819d0105471fd704deba54bb 100644 --- a/README.md +++ b/README.md @@ -269,78 +269,84 @@ curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/mine curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/ ``` -* Data overlay - * URL: `/projects/{projectId}/overlays/{overlayId}/` - * Method: GET - * Parameters: TODO +* Add overlay + * URL: `/projects/{projectId}/overlays/` + * Method: POST + * Parameters: + * 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 GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/ +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/ ``` -* bioEntities (Elements and reactions) - * URL: `/projects/{projectId}/overlays/{overlayId}/models/{modelId}/bioEntities/` - * Method: GET +* Update overlay + * URL: `/projects/{projectId}/overlays/{overlayId}/` + * Method: PATCH * Parameters: TODO * Example: ``` -curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/models/*/bioEntities/ +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/ ``` -* Reaction - * URL: `/projects/{projectId}/overlays/{overlayId}/models/{modelId}/bioEntities/reactions/{reactionId}/` - * Method: GET + +* Remove overlay + * URL: `/projects/{projectId}/overlays/{overlayId}/` + * Method: DELETE * Parameters: TODO * Example: ``` -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/ +curl -X DELETE --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/ ``` -* Element - * URL: `/projects/{projectId}/overlays/{overlayId}/models/{modelId}/bioEntities/elements/{elementId}/` +* Download source + * URL: `/projects/{projectId}/overlays/{overlayId}:downloadSource` * Method: GET * Parameters: TODO * Example: ``` -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/ -``` +curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203:downloadSource +``` -* Update overlay +* Data overlay details * URL: `/projects/{projectId}/overlays/{overlayId}/` - * Method: PATCH + * Method: GET * Parameters: TODO * 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/ +curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" http://pg-sandbox.uni.lu/minerva/api/projects/pdmap_dec15/overlays/3203/ ``` - -* Remove overlay - * URL: `/projects/{projectId}/overlays/{overlayId}/` - * Method: DELETE +* bioEntities (Elements and reactions) + * URL: `/projects/{projectId}/overlays/{overlayId}/models/{modelId}/bioEntities/` + * Method: GET * Parameters: TODO * Example: ``` -curl -X DELETE --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" 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/models/*/bioEntities/ ``` -* Download source - * URL: `/projects/{projectId}/overlays/{overlayId}:downloadSource` +* Reaction + * URL: `/projects/{projectId}/overlays/{overlayId}/models/{modelId}/bioEntities/reactions/{reactionId}/` * Method: GET * Parameters: TODO * Example: ``` -curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" 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/models/15305/bioEntities/reactions/187811/ +``` -* Add overlay - * URL: `/projects/{projectId}/overlays/` - * Method: POST +* Element + * URL: `/projects/{projectId}/overlays/{overlayId}/models/{modelId}/bioEntities/elements/{elementId}/` + * Method: GET * 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=xxxxxxxx" 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/3203/models/15305/bioEntities/elements/431433/ ``` + + ### Users