API

[evanroyrees]

Checklists & Notes

User Registry Service

1. New Users
2. New Projects
3. Upload datasets
4. Upload results

Dataset/Job Registry Service

1. Submission
2. Queries
3. Status/Progress

Integration:

Hosted on CHTC as prescribed by the proposal:
"For this reason, we will purchase a dedicated high memory computation node, which will be maintained and administered by the Center for High Throughput Computing at UW–Madison. The Kwan group will be granted priority access to the node for a minimum of three years (see Miron Livny letter)."

To integrate with grid computing systems such as HTCondor at CHTC, I am initially thinking of using WorkQueue from Purdue's Cooperative Computing Lab.

Formatting Notes & Resources

API formatting conventions will needs to be put in place for future development, therefore we could rely on GET and POST requests following the semantics of a REST API (See REST Resource Naming Guide).

• REST Tutorial
• Postman: an API development environment tool
• A minimal API example using FLASK-RESTFUL
• responses status code guide

Generating Unique IDs reference

We would like to check all five items:

1. Authentication guide ☑
2. Quickstart guide ☑
3. Endpoint definitions ☑
4. Code snippets ☑
5. Example responses ☑

References and API Ideas

• Stripe API Guide
• GitHub API Guide
• Twilio API Guide

API Docs Stretch Goals

• 8 features

[jason-c-kwan]

Yeah, I know it says that in the proposal, but we may end up buying our own server to use outside, because with CHTC you only get to use it for 3 years.

[evanroyrees]

@chanana okay to close this? I think #32 is likely going to be the spot for updates, do you agree?

[chanana]

Yes!