Skip to content

Update documentation with search API best practice #2684

Open

Description

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    P2Medium priority issuegood first issueGood for newcomerstype:documentationImprovements or additions to documentation

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions