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

Extend GO API to include basic access to GO-CAMs using new abstraction #99

Open
kltm opened this issue Nov 18, 2024 · 0 comments
Open
Assignees
Labels
Needs LA approval Needs final approval from the Lead Architect Needs PI Needs PM approval Needs final approval from the Project Manager Needs PO Needs tech doc Needs TL

Comments

@kltm
Copy link
Member

kltm commented Nov 18, 2024

Project link

https://github.com/orgs/geneontology/projects/225

Project description

There are currently two exposed ways to access GO-CAM information in the GO API. The first is (mostly) using the complicated abstraction that Noctua itself uses, which is too complicated for end users. The second is a somewhat suboptimal abstraction that was designed for the GO-CAM site.

Details still in discussion:
https://docs.google.com/document/d/1h_vnzkP94YC5l3ZmxKyZVOuTzIHIsHRsOLtBSGyB25k/edit?tab=t.0
https://docs.google.com/document/d/1GzTnSY10pWDzvceM5p0Dx6AV1KFAl9thRr2VgjWJCVc/edit?tab=t.0

Scope/Deliverables

  • Add several new GO API endpoint for GO-CAM, returning an NDEx-like abstraction
  • Deploy
  • Update documentation to indicate deprecation of all other GO-CAM endpoints
  • (Make plan for future versions of our widgets to move off of deprecated endpoints)

Motivations

  • Curators
    • Likely N/A
  • Data consumers
    • We will be providing an endpoint with our best-effort abstraction for GO-CAMs (similar to the NDEx work)
    • This will also give us the confidence to improve our documentation and actually "sell" our endpoints
  • Optimizing use of internal resources
    • This puts us on a path to start rationalizing our API
    • It may allow us to deprecate endpoints that use our deprecated SPARQL
  • Current grant aim
  • Positioning for next grant

Coordination (with other resources)

  • List all impacted groups
    • No impacted groups at this time
    • We will have to coordinate when we roll out future versions of the widget
  • Get a formal approval from groups before starting the project

Tasks

TBD

Dependencies

None

Cost/Resources

1M? However, Sierra is partial, so it is expected to take a little time.

Strengths/Opportunities

TBD

Weaknesses/Threats

  • In the interim, we'll have yet another GO-CAM endpoint
    • Possible user confusion here

Risks/Mitigations

TBD

Fail state/Withdrawal

  • Simply don't do this. The API and widgets currently function as-is

Technical specs

TBD (template: https://docs.google.com/document/d/111UqtS3G0aJZpAijZYI3Da0t94OQpGePlPJsqZE4Tio/edit)

Personnel

PI: Chris; PO: Pascale; TL: Sierra

Other comments

N/A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs LA approval Needs final approval from the Lead Architect Needs PI Needs PM approval Needs final approval from the Project Manager Needs PO Needs tech doc Needs TL
Projects
Status: Resourcing (waiting for capacity)
Development

No branches or pull requests

2 participants