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

More powerful list endpoint for additional search function #88

Open
nsheff opened this issue Jan 22, 2025 · 0 comments
Open

More powerful list endpoint for additional search function #88

nsheff opened this issue Jan 22, 2025 · 0 comments
Milestone

Comments

@nsheff
Copy link
Member

nsheff commented Jan 22, 2025

In #4 we posed the idea that a user could use an alias (eg grch38) to find sequence collections with that alias.

We realized this could be made possible if we do 2 things:

  1. Update the spec so that the /list endpoint MAY respond to a ?attr=value request where the attr is an array, by treating this as filtering to any seqcols where the the array attr contains value as one of its elements. Previously this wasn't really defined by the spec, but if we define it, then it makes the list endpoint a bit more powerful because it doesn't just look for exact matches.
  2. introduce the aliases attribute to a collection, with a formal definition (it's an array of human-readable identifiers that could be searched in this manner).

Then you'd just search by saying ?alias=grch38. This more powerful list method could also be used for other attributes (like, "find all the arrays for which x is listed as one of the contributors", or even "find all the arrays where sequence digest xyz is in the list of sequence digests").

So we decided it could make sense to add this to the spec as a MAY extension for 1.1

The alias idea is also related to #79

@nsheff nsheff added this to the v1.1 milestone Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant