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

search-api endpoint enhancement: Which "entities" satisfy *ranges* for numerical criteria? #602

Open
AlanSimmons opened this issue Jan 1, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request P Pitt dev team search-api-endpoints

Comments

@AlanSimmons
Copy link
Contributor

Use case 5 of #590

This is an enhancement of the endpoint for Use Case 4 described in #601.

Story

As a consumer of the search-api, I want to be able to obtain information on a set of "entities" with values that fall within certain numerical ranges. Examples:

  1. Return data for all datasets from CODEX assays that were performed on tissue samples that were obtained from the small intestines of female donors between the ages of 40 and 60.
  2. List all files from LC-MS assays that have file extension RAW and that have a file size of over 200 MB.
  3. List all antibodies from a particular vendor with catalog numbers in the range X to Y.

Target

Developers of applications that would call the API.

Technical Translation

Return an ElasticSearch query response that can handle numeric ranges.

The endpoint for Use Case 4 returns values that exactly match. This endpoint will need to handle ranges--e.g.,

  • minimum values (e.g., >=)
  • maximum values (e.g., <=)

Solution options

Ability to specify ranges in endpoints. This would likely require some custom parsing of parameters, such as discussed here

@AlanSimmons AlanSimmons added enhancement New feature or request P Pitt dev team search-api-endpoints labels Jan 1, 2023
@AlanSimmons AlanSimmons changed the title search-api endpoint enhancement: Which "entities" satisfy ranges for numerical criteria? search-api endpoint enhancement: Which "entities" satisfy *ranges* for numerical criteria? Jan 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request P Pitt dev team search-api-endpoints
Projects
Status: Ready
Development

No branches or pull requests

2 participants