search

hubmapconsortium / entity-api

A set of web service calls to return information about HuBMAP entities
https://entity.api.hubmapconsortium.org
MIT License
3 stars 1 forks source link

Dataset Id sample and donor aggregate endpoints #604

Closed ChuckKollar closed 4 months ago

ChuckKollar commented 5 months ago

Create one new endpoints in entity-api that will return the samples, organs, and donors uuids of dataset id given.

These endpoints will use the Neo4J queries documented in https://github.com/hubmapconsortium/ingest-api/issues/411

This endpoint will be used in: https://github.com/hubmapconsortium/ingest-api/issues/411

Remember to update the OpenAPI .yaml file.

ChuckKollar commented 5 months ago

See PR: https://github.com/hubmapconsortium/entity-api/pull/612

yuanzhou commented 5 months ago

Update 2/7/2024:
Instead of creating a new endpoint that returns all the uuids, we create two new endpoints /datasets/<id>/donors and /datasets/<id>/samples. The implementation is similar to the existing /datasets/<id>/organs but with modified neo4j queries so we return all the entity dicts rather than just uuids.

For future when needed, we can add uuid filtering to only return uuids to the new endpoints and the existing /datasets/<id>/organs