GigaDB API

[only1chunts]

We know the API needs work, but I dont know how to put that into a suitable ticket for the backlog? The functions of the API will include:

• support external users download dataset samples #508
• support external users download dataset files #679
• communicate with RVT system about datasets linked to GigaByte manuscripts
• communicate with ORCID about datasets being published that have users with ORCIDs
• currently, the search function is linked to the API, and search results using the API should return the same results as the websearch
• CLOCKKS uses our API to know which datasets are new and need archiving
• CNGB will need to use it to pull details into their view of GigaDB
• potential to talk to BioSamples database to exchange sample metadata
• more...?

There are some tickets already with mention of API, e.g. #27 #609 #610 #468 #341 and probably more!

User story

As a user
I want something implemented
So that I can benefit

Acceptance criteria

Given conditions
When event
Then outcome

Given conditions
When event
Then outcome

Additional Info

Product Backlog Item Ready Checklist

• [ ] Business value is clearly articulated
• [ ] Item is understood enough by the IT team so it can make an informed decision as to whether it can complete this item
• [ ] Dependencies are identified and no external dependencies would block this item from being completed
• [ ] At the time of the scheduled sprint, the IT team has the appropriate composition to complete this item
• [ ] This item is estimated and small enough to comfortably be completed in one sprint
• [ ] Acceptance criteria are clear and testable
• [ ] Performance criteria, if any, are defined and testable
• [ ] The Scrum team understands how to demonstrate this item at the sprint review

Product Backlog Item Done Checklist

• [ ] Code is complete
• [ ] Automated tests related to the changes are implemented and passing
• [ ] All automated test suites are passing locally
• [ ] Code is refactored to best practices and coding standards
• [ ] Documentation is updated as needed
• [ ] A Pull Request has been created and review requested
• [ ] Pull Request is reviewed and approved
• [ ] The item has been merged to the develop branch
• [ ] All automated test suites are passing on continuous Integration pipeline and item is ready to release

[rija]

Hi @only1chunts

I thought about GigaDB APIs a lot over the years, mostly from a software architecture point of view, I have several architecture diagram lying around. It may be worth exploring this Epic outside the backlog for awhile until we have some clear user stories and technical tasks we can define. Maybe by starting a google doc where we can centralise use case research, designs and discussions?

[only1chunts]

the current version (v3) of the XML output schema is public here and its linked to from our API help page This will need to be removed/updated when the new API is implemented.

[rija]

Additional infos:

• https://ropensci.org/
• https://biothings.io/about (See #1504)
• https://www.openapis.org

[rija]

Hi @only1chunts, If you don't mind, I'll remove this issue from the product backlog as it will never be implemented directly as it stands. Furthermore, I've started growing the Google Docs below that now has the same info as this ticket and more. The discussion can continue there.

https://docs.google.com/document/d/1Dq49pu90i3ItFLK1oudRd0CBzG2FTJGK-b-PiUvufOw/edit?usp=sharing

I won't close the ticket as it relates to something in progress.