search

OpenTreeOfLife / germinator

miscellaneous scripts and data for concerns that span more than one of the Open Tree code repositories: integration tests, system statistics, etc.
BSD 2-Clause "Simplified" License
21 stars 7 forks source link

Document how to create a study #109

Open jar398 opened 8 years ago

jar398 commented 8 years ago

The API documentation explains how to fetch the nexson for a study, but doesn't say anything about how to create a study in the first place, or update one. We have taken as a goal that the API documentation should cover everything that the webapp needs, so create documentation is necessary.

jar398 commented 7 years ago

On 2016-09-19, @mtholder provided a link to a google doc linking to instructions for getting an OAuth token and to a script for uploading a NexSON. The document begins:

"Please don’t distribute this until we are a little more confident that our validator is rejecting invalid content. We will make this document public at some point when we have a way to throttle the api"

mtholder commented 7 years ago

fwiw, I think all of the pieces are present in https://github.com/OpenTreeOfLife/phylesystem-api/tree/master/docs I think we just need to decide when it is "safe" to post an easy-to-use summary of all of the steps. I mainly want to be confident that we reject reuploads of the same study (I don't think that we do that now), and that we reject huge uploads and uploads with large numbers of trees.

mtholder commented 7 years ago

correction: the phylesystem-api parts of that doc are documented at my link. The NCL and NeXML->NexSON parts are in other repos.