RPC documentation cleanup ideas #22799

1. 
   maflcko commented at 7:21 pm on August 25, 2021: member

   • Auto-formatting and sanity checking the RPCExamples with RPCMan
   • Checking passed-in json in self-check. Removing redundant checks (RPCTypeCheck)
   • De-duplicate default values (Started in #20017)
   • Compile the RPC documentation at compile-time to ensure it doesn’t change at runtime and is completely static
2. maflcko added the label Feature on Aug 25, 2021
3. 
   saranshisatgit commented at 11:24 am on August 30, 2021: none

   I would like to contribute but this is my first time . Would like to give me specifics about where to start ?
4. 
   promag commented at 7:29 pm on September 29, 2021: contributor

   I’d like to include support for “streaming”: Some RPC methods return big JSON, which is constructed in memory and then serialized as one big string.
5. 
   fanquake commented at 2:09 pm on August 14, 2022: member

   Maybe combine #14894 into this issue, or vice-versa?
6. maflcko added the label Docs on Jun 15, 2023
7. maflcko added the label RPC/REST/ZMQ on Jun 15, 2023
8. 
   maflcko commented at 8:23 am on March 16, 2026: member

   Auto-formatting and sanity checking the RPCExamples with RPCMan

   An alternative idea would be to parse the example with UniValue, see #31275 (comment)

   I’d like to include support for “streaming”: Some RPC methods return big JSON, which is constructed in memory and then serialized as one big string.

   I think I want to keep this issue about documentation only.

Contributors
maflcko saranshisatgit promag fanquake

Labels
Feature Docs RPC/REST/ZMQ