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

[docs] Outline easy optimizations for endpoints #489

Open
emostov opened this issue Mar 23, 2021 · 0 comments
Open

[docs] Outline easy optimizations for endpoints #489

emostov opened this issue Mar 23, 2021 · 0 comments
Labels
I5 - Documentation 📖 Documentation needs fixes or additions P7 - Nice to Have Nice, but not urgent

Comments

@emostov
Copy link
Contributor

emostov commented Mar 23, 2021

There should be some documentation on what query params for specific endpoints can improve performance.

This would likely outline the options for specific paths that reduce RPC calls, computation, etc.

I think there can be notes added to query params in the docs mentioning what might be faster and also quick "Optimization getting started" guide in the README that points out some common use cases. For example, the most obvious things to me are opting out of the authorId in the blocks endpoint or opting out of the metadata in the transaction material endpoint unless there has been a runtime upgrade.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I5 - Documentation 📖 Documentation needs fixes or additions P7 - Nice to Have Nice, but not urgent
Projects
None yet
Development

No branches or pull requests

1 participant