biothings / biothings_explorer

TRAPI service for BioThings Explorer
https://explorer.biothings.io
Apache License 2.0
10 stars 11 forks source link

minor x-bte refactoring: adjust SmartAPI yaml tags #753

Open colleenXu opened 1 year ago

colleenXu commented 1 year ago

Pasted from 9/27 group meeting notes, with bold emphasis added for tasks:

CX: SmartAPI yaml "tags"ˤ

  • What are they for?
  • BioThings-specific requirements?
  • Helpful to have one for "this has x-bte annotation"?

Some tags are important, are used for specific types of apis, and should be used properly/not messed with

Traditionally (but not important/required):

  • We'd include tags for grouping the endpoints
    • Metadata
    • Query
    • "annotation" for the record-specific endpoints: comes from the core biothings apis (mychem, mygene, etc)
  • We'd include tags that give a sense of what data is accessible
    • Gene, phenotype, disease, chem, etc
    • "Association" to refer to the structure of records

BTE is using some method to figure out which APIs have x-bte annotation…based on info.x-translator.team == Service Provider?

Feedback:

  • Don't need to be strict w/ the traditional tags
  • Can remove tags where we don't know what they are or what they're for…
    • "biothings_graph"
  • Other BioThings API owners (like Multiomics / Text-Mining) can add whatever tags they want
  • Yes, it's helpful to have an x-bte tag for "this api has x-bte annotation". Let's do it

X-bte tag:

  • Easy way to browse registry and see what's theoretically accessible through BTE
  • These are probably automatically accessible via api-specific endpoints (v1/smartapi)
  • At the moment, we won't do anything else w/ the tag. But in the future, we could adjust BTE's logic so it finds x-bte annotated APIs w/ this tag…
colleenXu commented 1 year ago

@newgene

I noticed that biothings.ncats.io has a "filter by entity type" that seems to be related to the "traditional tags that give a sense of what data is accessible" described above (2nd point under "traditionally...").

Does that mean that these are actually important in some way for pending BioThings APIs? In our previous discussions, we said they weren't important or required...