Skip to content

Commit 1b02f8a

Browse files
committed
askrene: add autogenated schema and doc files
Signed-off-by: Lagrang3 <[email protected]>
1 parent b771fa7 commit 1b02f8a

File tree

2 files changed

+85
-0
lines changed

2 files changed

+85
-0
lines changed

contrib/msggen/msggen/schema.json

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -703,6 +703,88 @@
703703
"Main web site: <https://github.com/ElementsProject/lightning>"
704704
]
705705
},
706+
"lightning-askrene-query-reserve.json": {
707+
"$schema": "../rpc-schema-draft.json",
708+
"type": "object",
709+
"additionalProperties": false,
710+
"rpc": "askrene-query-reserve",
711+
"title": "Command to query the reserved liquidity in a channel (EXPERIMENTAL)",
712+
"description": [
713+
"WARNING: experimental, so API may change.",
714+
"",
715+
"The **askrene-query-reserve** RPC command provides information about the number of in-flight HTLCs in a channel and the sum of their respective amounts."
716+
],
717+
"request": {
718+
"required": [
719+
"short_channel_id",
720+
"direction"
721+
],
722+
"properties": {
723+
"short_channel_id": {
724+
"type": "short_channel_id",
725+
"description": [
726+
"The short channel id of the channel."
727+
]
728+
},
729+
"direction": {
730+
"type": "u32",
731+
"description": [
732+
"The direction of the channel."
733+
]
734+
}
735+
}
736+
},
737+
"response": {
738+
"required": [
739+
"short_channel_id",
740+
"direction",
741+
"num_htlcs",
742+
"amount_msat"
743+
],
744+
"properties": {
745+
"short_channel_id": {
746+
"type": "short_channel_id",
747+
"description": [
748+
"The *short_channel_id* specified."
749+
]
750+
},
751+
"direction": {
752+
"type": "u32",
753+
"description": [
754+
"The *direction* specified."
755+
]
756+
},
757+
"num_htlcs": {
758+
"type": "u32",
759+
"description": [
760+
"The number of HTLCs in-flight in the channel."
761+
]
762+
},
763+
"amount_msat": {
764+
"type": "msat",
765+
"description": [
766+
"The total amount reserved in the channel."
767+
]
768+
}
769+
}
770+
},
771+
"see_also": [
772+
"lightning-getroutes(7)",
773+
"lightning-askrene-reserve(7)",
774+
"lightning-askrene-unreserve(7)",
775+
"lightning-askrene-inform-channel(7)",
776+
"lightning-askrene-disable-node(7)",
777+
"lightning-askrene-create-channel(7)",
778+
"lightning-askrene-listlayers(7)",
779+
"lightning-askrene-age(7)"
780+
],
781+
"author": [
782+
"Lagrang3 <<[email protected]>> is mainly responsible."
783+
],
784+
"resources": [
785+
"Main web site: <https://github.com/ElementsProject/lightning>"
786+
]
787+
},
706788
"lightning-askrene-reserve.json": {
707789
"$schema": "../rpc-schema-draft.json",
708790
"type": "object",
@@ -762,6 +844,7 @@
762844
"see_also": [
763845
"lightning-getroutes(7)",
764846
"lightning-askrene-unreserve(7)",
847+
"lightning-askrene-query-reserve(7)",
765848
"lightning-askrene-disable-node(7)",
766849
"lightning-askrene-create-channel(7)",
767850
"lightning-askrene-inform-channel(7)",
@@ -834,6 +917,7 @@
834917
"see_also": [
835918
"lightning-getroutes(7)",
836919
"lightning-askrene-reserve(7)",
920+
"lightning-askrene-query-reserve(7)",
837921
"lightning-askrene-disable-node(7)",
838922
"lightning-askrene-create-channel(7)",
839923
"lightning-askrene-inform-channel(7)",

doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Core Lightning Documentation
1818
lightning-askrene-disable-node <lightning-askrene-disable-node.7.md>
1919
lightning-askrene-inform-channel <lightning-askrene-inform-channel.7.md>
2020
lightning-askrene-listlayers <lightning-askrene-listlayers.7.md>
21+
lightning-askrene-query-reserve <lightning-askrene-query-reserve.7.md>
2122
lightning-askrene-reserve <lightning-askrene-reserve.7.md>
2223
lightning-askrene-unreserve <lightning-askrene-unreserve.7.md>
2324
lightning-autoclean-once <lightning-autoclean-once.7.md>

0 commit comments

Comments
 (0)