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

Add querystring parameters to limit which fields are returned #201

Open
Mr0grog opened this issue Jun 11, 2021 · 1 comment
Open

Add querystring parameters to limit which fields are returned #201

Mr0grog opened this issue Jun 11, 2021 · 1 comment
Labels
api enhancement New feature or request Partner: VtS Supporting or integrating with Vaccinate the States

Comments

@Mr0grog
Copy link
Collaborator

Mr0grog commented Jun 11, 2021

For clients who don’t need detailed data, cutting some fields (e.g. availability.slots or availability.capacity) from responses can make the response smaller and make the queries faster since joins take less memory. We should add a querystring parameter than allows clients to ask for fewer fields.

I’m not 100% sure on the best form for this; it could be as simple as some presets, like ?detail_level=light, or it could be a comma-separated list of fields, like ?fields=id,external_ids,name,availability.valid_at,availability.available,availability.products.

This is not yet a high priority need, but I’m noting it down since Vaccinate the States wants to integrate on the front-end instead of the back-end, and this could be a particularly useful feature for that.

@Mr0grog Mr0grog added enhancement New feature or request api labels Jun 11, 2021
@Mr0grog Mr0grog added the Partner: VtS Supporting or integrating with Vaccinate the States label Jun 16, 2021
@Mr0grog
Copy link
Collaborator Author

Mr0grog commented Jun 19, 2023

This project has been shut down. This issue has been left open as a guide for anyone forking this project — addressing this issue (or at least knowing about it!) is likely to be worthwhile for you if you are maintaining a running copy or fork of UNIVAF.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api enhancement New feature or request Partner: VtS Supporting or integrating with Vaccinate the States
Projects
None yet
Development

No branches or pull requests

1 participant