fix(docs): add notes about indexer in rpc specs #4584
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kodemartin
approved these changes
Dec 20, 2024
| @@ -14,7 +14,7 @@ use jsonrpsee::{core::RpcResult, proc_macros::rpc}; | |||
| #[open_rpc(namespace = "iotax", tag = "Extended API")] | |||
| #[rpc(server, client, namespace = "iotax")] | |||
| pub trait ExtendedApi { | |||
| /// Return a list of epoch info | |||
| /// Return a list of epoch info. Exclusively served by the indexer | |||
There was a problem hiding this comment.
Suggested change
| /// Return a list of epoch info. Exclusively served by the indexer | |
| /// Return a list of epoch info. Exclusively served by the indexer. |
There was a problem hiding this comment.
And below as well please 🙏
lucas-tortora
approved these changes
Dec 20, 2024
vivekjain23
approved these changes
Dec 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of change
Some RPC endpoints are only available on indexer. So I added a note and changed the text where needed.
Links to any relevant issues
Fixes #4565.
Type of change
How the change has been tested
Run locally
Change checklist