aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWladimir J. van der Laan <laanwj@gmail.com>2017-09-06 19:38:33 +0200
committerWladimir J. van der Laan <laanwj@gmail.com>2017-09-06 19:39:00 +0200
commit21e2f2f79961a1f0235577d4c69b178f3e2e6297 (patch)
treed5265e44a944520175f857ace763df388fb9bec6
parent5368614aa106b96e02ffb9e68eb86ebe197bc07f (diff)
parent62ecce75e4c40bb9bf51a1ee5f183e28cb76c1fc (diff)
downloadbitcoin-21e2f2f79961a1f0235577d4c69b178f3e2e6297.tar.xz
Merge #11135: Update developer notes with RPC response guidelines
62ecce75e [doc] Add RPC response notes (João Barbosa) Pull request description: Tree-SHA512: 795969813eefab47ac03050bd70762fc36d86edb00bdfe1ba76837a810370d61dc88749c51153bd3949eb3885f084b4ba8736b4bbf90dfef65e3fe1939304bd8
-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.