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

Filtering for list endpoints #507

Open
david-crespo opened this issue Dec 13, 2021 · 1 comment
Open

Filtering for list endpoints #507

david-crespo opened this issue Dec 13, 2021 · 1 comment
Labels
api Related to the API.
Milestone

Comments

@david-crespo
Copy link
Contributor

We will need to able to filter list endpoints. Presumably, because these are GET endpoints, we will do this filtering through query parameters.

Example table design with filtering (Figma) image

It seems to me we will want something like the following in Nexus:

  • For each paginated endpoint, specify the fields clients can filter on and their schemas
  • Expose the above specifications in the OpenAPI spec as query parameters so clients know how to use them

Corners to cut

  • Start with only name and timestamp fields

Open questions

  • How do we do text matching on names
    • Presumably we want to keep it simple and start with something like WHERE name ILIKE '<query>%' and worry about getting fancy later
@davepacheco
Copy link
Collaborator

I know we've talked a bunch about the scalability problems with this. (Basically, how do you avoid this turning into a table scan?) I can't remember if we've written this down somewhere.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Related to the API.
Projects
None yet
Development

No branches or pull requests

4 participants