remarks about API docs
paragraph | |
---|---|
2. QuickStart guide | $ curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/projects/' -i -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" |
remove cookie token? It s not necessary | |
2. Logout | $ curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/doLogout' -i -X POST |
cookie is missing | |
1.2. Convert network from an input format to an output format | curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/convert/CellDesigner_SBML:GPML' -i -X POST --data-binary @input_file.xml -H 'Content-Type: text/plain' |
Is header ok? It works, but file is not plain txt? | |
1. Create new file in the system | curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/files/' -i -X POST -d 'filename=test_file&length=400' --cookie "MINERVA_AUTH_TOKEN=xxx" -H 'Content-Type: application/x-www-form-urlencoded' |
it works also without Header, could we remove header? | |
5. Start downloading genome data from remote database to minerva | review in 5.3. Response Fields |
this is empty (no details return), maybe if there is no response we could removed it or add info? It is little bit confusing that fields are empty. | |
8. Delete downloaded genome | curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/genomics/{genomeId}/' -i -X DELETE --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" |
genomeId is not provided explicit, it is describen in "6.3. Response Fields" as "ObjectID - unique id of genome in minerva". is it ok? | |
10. Delete gene mapping | curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/genomics/10/geneMapping/{geneMappingId}/' -i -X DELETE --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" |
where is geneMappingId returned? | |
3. Create user - 3.3. Request Parameters" | there are colors (maxColor, minColor....) defined as required parameters, is it correct? |
there is not privileges defined while create user. To set privileges, i need to go to "update users priveleges". Is it how it should work? Privileges are not set while 'create user'? | |
3. Create user - 3.1. CURL sample | curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/users/xyz' -i -X POST -d 'name=FirstName&password=FirstName' --cookie "MINERVA_AUTH_TOKEN=xxx" -H 'Content-Type: application/x-www-form-urlencoded' |
the value of password is little bit confusing |