intermine / intermine/bluegenes
clojure.spec Intermine web service
- Dominant language
- Clojure
- Stars
- 75
- Forks
- 59
- PR merge metrics
- No merged PRs in 30d
Description
We should consider writing clojure.spec descriptions of the intermine API. This can be used for the following purposes, all across bluegenes, imcljs and im-tables-3.
- Validate that the Intermine instance is sending correct data
- Generate fake data for unit tests
- Should make it easy to write tests without having to rely on HTTP requests to a running Intermine instance
I think this would be worth revisiting in mid-to-late 2020, when clojure.spec2 is released and out of alpha phase.
Note: I will update this issue with more use cases I find.
Contributor guide
Research direction
Review the existing Intermine API usage across bluegenes, imcljs and im-tables-3, along with the issue's clojure.spec2 timing note. Define the API descriptions so responses can be validated and fake data can support unit tests without HTTP requests to a running Intermine instance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- clojure
- Domain
- api, testing
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100