From 62ecce75e4c40bb9bf51a1ee5f183e28cb76c1fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Barbosa?= Date: Fri, 25 Aug 2017 15:52:35 +0100 Subject: [PATCH] [doc] Add RPC response notes --- doc/developer-notes.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 2f04d6ee6..4694175a9 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.