aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoão Barbosa <joao.paulo.barbosa@gmail.com>2017-08-25 15:52:35 +0100
committerJoão Barbosa <joao.paulo.barbosa@gmail.com>2017-08-25 15:54:33 +0100
commit62ecce75e4c40bb9bf51a1ee5f183e28cb76c1fc (patch)
treef685f1e4eb0955d60670a311fa727b12177f4e1e /doc
parent3f726c99f819f97f2ab21b94d34c6b3129cd883a (diff)
downloadbitcoin-62ecce75e4c40bb9bf51a1ee5f183e28cb76c1fc.tar.xz
[doc] Add RPC response notes
Diffstat (limited to 'doc')
-rw-r--r--doc/developer-notes.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
index 2f04d6ee6c..4694175a90 100644
--- a/doc/developer-notes.md
+++ b/doc/developer-notes.md
@@ -619,3 +619,8 @@ A few guidelines for introducing and reviewing new RPC interfaces:
- *Rationale*: as well as complicating the implementation and interfering
with the introduction of multi-wallet, wallet and non-wallet code should be
separated to avoid introducing circular dependencies between code units.
+
+- Try to make the RPC response a JSON object.
+
+ - *Rationale*: If a RPC response is not a JSON object then it is harder to avoid API breakage if
+ new data in the response is needed.