From 82393036e31ab4a7d36ce822b96f4f85d247396a Mon Sep 17 00:00:00 2001 From: Christian Decker Date: Thu, 29 Nov 2018 15:56:12 +0100 Subject: [PATCH] plugin: Update documentation of the rpcmethods Suggested-by: Lisa Neigut <@niftynei> Signed-off-by: Christian Decker --- doc/plugins.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/plugins.md b/doc/plugins.md index 5cc1af7dd..b0c7f88da 100644 --- a/doc/plugins.md +++ b/doc/plugins.md @@ -82,7 +82,15 @@ currently only string options are supported.* The `rpcmethods` are methods that will be exposed via `lightningd`'s JSON-RPC over Unix-Socket interface, just like the builtin commands. Any parameters given to the JSON-RPC calls will be passed -through verbatim. +through verbatim. Notice that the `name` and the `description` fields +are mandatory, while the `long_description` can be omitted (it'll be +set to `description` if it was not provided). + +Plugins are free to register any `name` for their `rpcmethod` as long +as the name was not previously registered. This includes both built-in +methods, such as `help` and `getinfo`, as well as methods registered +by other plugins. If there is a conflict then `lightningd` will report +an error and exit. ### The `init` method