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

Add collection IDs and SHAs to /tree_of_life/about (verbose response) #228

Open
jimallman opened this issue Dec 3, 2020 · 1 comment
Open
Assignees

Comments

@jimallman
Copy link
Member

jimallman commented Dec 3, 2020

Ideally the new collection editor will include its status vs. the latest published synthetic tree. It seems logical to add this information to the existing /tree_of_life/about method, rather than adding a new one.

Added response fields might look like this:

$ curl -X POST https://devapi.opentreeoflife.org/v3/tree_of_life/about -d '{"include_source_list":true}'
{
  "date_created": "2019-12-23 11:41:23",
  ...
  "num_source_collections": 14,
  ...
 "source_id_map": {
  "3.2draft9": {
    "taxonomy": "3.2draft9"
  },
  "ot_1000@tree1": {
   "git_sha": "3008105691283414a18a6c8a728263b2aa8e7960",
   "study_id": "ot_1000",
   "tree_id": "tree1",
   "collection_id": "opentreeoflife/default"    ADD this for each tree as well?
  },
  ... all trees listed, then all collections ...
  "opentreeoflife/default": {
    "git_sha": "3008105691283414a18a6c8a728263b2aa8e7960",
    "name": "Inputs to synthesis (default)", 
    "description": "Trees for synthesis, but ranked lower than other synthesis collections"
  },
  ...

If we don't feel good about adding collection details to the existing source_id_map, perhaps add a sibling structure collection_id_map to hold them?

@jimallman
Copy link
Member Author

Apologies for the scattershot assignees on this issue. I've lost track of where this API method was actually implemented, and by whom.

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

4 participants