search

NCATS-Tangerine / translator-knowledge-beacon

NCATS Translator Knowledge Beacon Application Programming Interface plus Sample code
MIT License
7 stars 2 forks source link

Knowledge Beacon 1.2.0 release proposal (discussion) #53

Closed RichardBruskiewich closed 5 years ago

RichardBruskiewich commented 5 years ago

Team discussions with @vdancik, @cmungall and this writer suggest that a modest iteration on the Knowledge Beacon API is desirable. Here are the tables of proposed change (alternatives):

Id Proposal Use Case
1) Add (optional) offset input parameter to all size parameter constrained endpoints Allow sequential 'cursor' driven batching of returned items
2) Make the s parameter optional in the /statements endpoint; replace keywords parameter with s_keywords and t_keywords; replace categories parameter with s_categories and t_categories parameters Generalizes the classical s anchored statement query to potentially allow retrieval of statements matching a (subject category, predicate, object category) pattern.
3) Make the keywords parameter in /concepts optional Simple concept retrieval based on categories only (batch processing can be constrained by size and offset)
RichardBruskiewich commented 5 years ago

After a short hackathon feedback, we are proceeding with the release of Knowledge Beacon Version 1.2 as outlined above