search

hubmapconsortium / search-api

HuBMAP search service and associated pieces to create an index
https://search.api.hubmapconsortium.org
MIT License
2 stars 2 forks source link

CLT Manifest Endpoints #821

Closed shirey closed 1 month ago

shirey commented 2 months ago

Currently API users who want to download HuBMAP data need to translate queries to valid Globus endpoint links in order to download the data. This can be cumbersome if a lot of datasets match a given query. To assist these users we'll create new endpoints that output a manifest file consumable by the HuBMAP CLT Tool based on existing query types.

To the existing endpoints /search, /<index-name>/search and /param-search/dataset add the new query argument produce-clt-manifest, which when set to true (e.g. /search?produce-clt-manifext=true) will produce a manifest.txt file which contains the information to download all datasets which match the query in valid CLT mainifest syntax. To produce the list of datasets, the query result should be filtered (after performing the ES query) to only returned datasets, ignoring other entity types, Donors, Samples, Collections, etc. If the query succeeds, but no datasets are present in the returned query return a 204, empty response status.

yuanzhou commented 1 month ago

Note: existing issue on PROD, not introduced by this round of updates.

/param-search/datasets only returns a maximum of10 results

Will address in a separate card.