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

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

Open
colleenXu opened this issue Oct 25, 2023 · 1 comment
Open

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

colleenXu opened this issue Oct 25, 2023 · 1 comment
Labels

Comments

@colleenXu
Copy link
Collaborator

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
Copy link
Collaborator Author

@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...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant