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

Update documentation with search API best practice #2684

Open
ndegwamartin opened this issue Oct 1, 2024 · 0 comments
Open

Update documentation with search API best practice #2684

ndegwamartin opened this issue Oct 1, 2024 · 0 comments
Labels
good first issue Good for newcomers P2 Medium priority issue type:documentation Improvements or additions to documentation

Comments

@ndegwamartin
Copy link
Collaborator

Describe the Issue
We need to add to the documentation some tips and recommendations on how we to efficiently use some of our APIs of interest.

For example, when using the search API there's a significant performance hit if one makes a request for all the records when they span the thousands. See metrics here. A better approach would be to paginate the request and fetch in batches to only return to the user the records they need e.g. 10 or 20 records to render in a view.

cc @jingtang10 @ellykits @aditya-07 @santosh-pingle @nsabale7

@jingtang10 jingtang10 added type:documentation Improvements or additions to documentation good first issue Good for newcomers P2 Medium priority issue labels Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers P2 Medium priority issue type:documentation Improvements or additions to documentation
Projects
Status: New
Development

No branches or pull requests

2 participants