Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to create a study #109

Open
jar398 opened this issue Sep 12, 2016 · 3 comments
Open

Document how to create a study #109

jar398 opened this issue Sep 12, 2016 · 3 comments

Comments

@jar398
Copy link
Member

jar398 commented Sep 12, 2016

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
Copy link
Member Author

jar398 commented Sep 19, 2016

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
Copy link
Member

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
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants