Bitcoin OpenRPC Specification #29477

1. 
   kilianmh commented at 7:25 pm on February 25, 2024: none

   Please describe the feature you’d like to see added.

   OpenRPC is a (human and) machine-readable, programming language-agnostic JSON-RPC API interface description standard.

   Is your feature related to a problem, if so please describe it.

   Having such a document could facilitate e.g. specification driven development, interactive documentation, code generation (documentation / clients), and automation of test cases.

   Describe the solution you’d like

   Generate the specification file automatically from src/rpc documentation.

   Describe any alternatives you’ve considered

   Write the specification “by hand” and update it manually.

   Please leave any additional context

   Ideally, Bitcoin core should switch to JSON-RPC version 2.0 (OpenRPC builds on top of JSON-RPC 2.0). In practice, we can still use OpenRPC generated clients as long as the missing "jsonrpc": "2.0" is ignored. JSON-RPC 2.0 was implemented in implemented in #27101 and #30238.

2. kilianmh added the label Feature on Feb 25, 2024
3. 
   edilmedeiros commented at 7:08 pm on August 4, 2024: contributor

   This is a stricter duplicate of #29912 where there’s a more general discussion about the topic of formalizing the RPC API.

   I would recommend posting your suggestion there and closing this.

4. bitcoin deleted a comment on Aug 4, 2024
5. bitcoin deleted a comment on Aug 4, 2024
6. 
   edilmedeiros commented at 1:17 am on August 5, 2024: contributor

   About JSON-RPC 2.0 compliance, I believe it was implemented in #27101 and #30238.
7. 
   kilianmh commented at 5:11 am on August 5, 2024: none

   About JSON-RPC 2.0 compliance, I believe it was implemented in #27101 and #30238.

   Indeed, I updated the description accordingly.

   This is a stricter duplicate of #29912 where there’s a more general discussion about the topic of formalizing the RPC API. I would recommend posting your suggestion there and closing this.

   Not sure about closing since this issue was opened earlier then #29912 and this issue here is the only one strictly concerned with implementing an OpenRPC Specification.

Contributors
kilianmh edilmedeiros

Labels
Feature