From e5365b712337b428aa82f4b63d21c798f65a2d35 Mon Sep 17 00:00:00 2001 From: Se7enZ Date: Sun, 25 Feb 2024 16:12:28 +0100 Subject: [PATCH] doc: Including docs references for addpsbtoutput where it seems to be missing --- doc/Makefile | 2 +- doc/lightning-addpsbtoutput.7.md | 8 ++++---- doc/schemas/addpsbtoutput.request.json | 11 +++++++---- doc/schemas/addpsbtoutput.schema.json | 6 +++--- mkdocs.yml | 1 + 5 files changed, 16 insertions(+), 12 deletions(-) diff --git a/doc/Makefile b/doc/Makefile index 647efff13d49..06c79dab906f 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -9,6 +9,7 @@ MANPAGES := doc/lightning-cli.1 \ doc/lightningd-config.5 \ doc/lightningd-rpc.7 \ doc/lightning-addgossip.7 \ + doc/lightning-addpsbtoutput.7 \ doc/lightning-autoclean-once.7 \ doc/lightning-autoclean-status.7 \ doc/lightning-batching.7 \ @@ -52,7 +53,6 @@ MANPAGES := doc/lightning-cli.1 \ doc/lightning-fundchannel_complete.7 \ doc/lightning-fundchannel_cancel.7 \ doc/lightning-funderupdate.7 \ - doc/lightning-addpsbtoutput.7 \ doc/lightning-fundpsbt.7 \ doc/lightning-getroute.7 \ doc/lightning-hsmtool.8 \ diff --git a/doc/lightning-addpsbtoutput.7.md b/doc/lightning-addpsbtoutput.7.md index 780c4f5d718d..b7710665f712 100644 --- a/doc/lightning-addpsbtoutput.7.md +++ b/doc/lightning-addpsbtoutput.7.md @@ -44,9 +44,9 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **psbt** (string): Unsigned PSBT which fulfills the parameters given -- **estimated\_added\_weight** (u32): The estimated weight of the added output -- **outnum** (u32): The 0-based number where the output was placed +- **psbt** (string): The unsigned PSBT which fulfills the parameters given. +- **estimated\_added\_weight** (u32): The estimated weight of the added output. +- **outnum** (u32): The 0-based number where the output was placed. [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -65,4 +65,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:6a31cc1575f9112d0582b5b9db560a5217d6e1a7bd33d399958e3aff7b022ac3) +[comment]: # ( SHA256STAMP:0f2b1c781862eb37a4b7a1b30bfc58cbb82987ff8e03e6f54f82f8d5e1b233cf) diff --git a/doc/schemas/addpsbtoutput.request.json b/doc/schemas/addpsbtoutput.request.json index 5f63a7a5df54..c6a0116672db 100644 --- a/doc/schemas/addpsbtoutput.request.json +++ b/doc/schemas/addpsbtoutput.request.json @@ -8,17 +8,20 @@ "added": "v23.11", "properties": { "satoshi": { - "type": "msat" + "type": "msat", + "description": "The satoshi value of the output. It can be a whole number, a whole number ending in sat, a whole number ending in 000msat, or a number with 1 to 8 decimal places ending in btc." }, "locktime": { - "type": "u32" + "type": "u32", + "description": "An optional locktime: if not set, it is set to a recent block height (if no initial psbt is specified)." }, "initialpsbt": { "type": "string", - "description": "the (optional) base 64 encoded PSBT to begin with. If not specified, one will be generated automatically" + "description": "The (optional) base 64 encoded PSBT to begin with. If not specified, one will be generated automatically." }, "destination": { - "type": "string" + "type": "string", + "description": "If not set, an internal address is generated." } } } diff --git a/doc/schemas/addpsbtoutput.schema.json b/doc/schemas/addpsbtoutput.schema.json index 7c2a7aaae4c8..367884c76cd5 100644 --- a/doc/schemas/addpsbtoutput.schema.json +++ b/doc/schemas/addpsbtoutput.schema.json @@ -11,15 +11,15 @@ "properties": { "psbt": { "type": "string", - "description": "Unsigned PSBT which fulfills the parameters given" + "description": "The unsigned PSBT which fulfills the parameters given." }, "estimated_added_weight": { "type": "u32", - "description": "The estimated weight of the added output" + "description": "The estimated weight of the added output." }, "outnum": { "type": "u32", - "description": "The 0-based number where the output was placed" + "description": "The 0-based number where the output was placed." } } } diff --git a/mkdocs.yml b/mkdocs.yml index 5871c758755d..d6554a2cc1ec 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -61,6 +61,7 @@ nav: - "Man Pages": # block_start manpages - "lightning-addgossip": "lightning-addgossip.7.md" + - "lightning-addpsbtoutput": "lightning-addpsbtoutput.7.md" - "lightning-autoclean-once": "lightning-autoclean-once.7.md" - "lightning-autoclean-status": "lightning-autoclean-status.7.md" - "lightning-batching": "lightning-batching.7.md"