docs(api): hot_first_actions / hot_first_window + hot_only for get_actions#7
Conversation
Documents the opt-in hot-first routing config for get_actions account polls (api config reference + example config) and adds the previously-undocumented hot_only query param to the v2 get_actions endpoint reference. Pairs with hyperion-history-api#176.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation to introduce new configuration options and query parameters for optimizing action queries. Specifically, it documents the hot_only query parameter in the API docs and the hot_first_actions and hot_first_window configuration settings in the provider setup guide. Feedback on these changes highlights a missing closing pipe in the Markdown table row for hot_only in docs/api/v2.md, which should be added to ensure consistent formatting.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
There was a problem hiding this comment.
Pull request overview
Documents newly introduced “hot-first” routing behavior for /v2/history/get_actions and adds missing API parameter documentation, aligning the docs with the corresponding history-api implementation work.
Changes:
- Added
hot_first_actionsandhot_first_windowto the chain API configuration reference andconfig.jsonexample. - Documented the previously undocumented
hot_onlyquery parameter for/v2/history/get_actions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/providers/setup/chain.md | Adds config reference + example JSON entries for hot-first get_actions routing behavior. |
| docs/api/v2.md | Adds hot_only to the /v2/history/get_actions query parameter table. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Documents the new hot-first routing for
get_actionsaccount polls, paired with eosrio/hyperion-history-api#176.Changes
providers/setup/chain.md— addshot_first_actions(default off) andhot_first_window(default 2) to the API configuration reference and the exampleconfig.json. Notes thetotal-reflects-hot-window caveat and that it's safe to enable without reindexing.api/v2.md— adds the previously-undocumentedhot_onlyquery param to the/v2/history/get_actionsparameter table.Notes
hot_first_actionslands indev(next 4.x maintenance release).