doc: add recent additions, fix annotation on listpeers to actually deprecate.

TODO: It would be great to similarly annotate new/deprecated commands and
their parameters.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Changelog-Added: doc: we now annotate what versions JSON field additions and deprecations happenened.
This commit is contained in:
Rusty Russell 2023-01-10 10:23:22 +10:30
parent b2148d0eab
commit 717cb03f51
5 changed files with 13 additions and 8 deletions

2
cln-rpc/src/model.rs generated
View file

@ -1613,8 +1613,10 @@ pub mod responses {
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct ListpeersPeersChannelsFunding {
#[deprecated]
#[serde(alias = "local_msat", skip_serializing_if = "Option::is_none")]
pub local_msat: Option<Amount>,
#[deprecated]
#[serde(alias = "remote_msat", skip_serializing_if = "Option::is_none")]
pub remote_msat: Option<Amount>,
#[serde(alias = "pushed_msat", skip_serializing_if = "Option::is_none")]

View file

@ -101,7 +101,7 @@ On success, an object is returned, containing:
- **accept-htlc-tlv-types** (string, optional): `accept-htlc-tlv-types` fields from config or cmdline, or not present
- **tor-service-password** (string, optional): `tor-service-password` field from config or cmdline, if any
- **dev-allowdustreserve** (boolean, optional): Whether we allow setting dust reserves
- **announce-addr-dns** (boolean, optional): Whether we put DNS entries into node\_announcement
- **announce-addr-dns** (boolean, optional): Whether we put DNS entries into node\_announcement *(added v22.11.1)*
[comment]: # (GENERATE-FROM-SCHEMA-END)
@ -220,4 +220,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:8e668233f6814cd1e64c735fba57d7fb6449636a17c48ed881b3eb1e66c19e7a)
[comment]: # ( SHA256STAMP:bc7c3374ba6609553f431deae62c1e5525e136086b39fffb6c674a58365c0740)

View file

@ -74,8 +74,8 @@ On success, an object containing **peers** is returned. It is an array of objec
- **funding** (object, optional):
- **local\_funds\_msat** (msat): Amount of channel we funded
- **remote\_funds\_msat** (msat): Amount of channel they funded
- **local\_msat** (msat, optional): Amount of channel we funded (deprecated)
- **remote\_msat** (msat, optional): Amount of channel they funded (deprecated)
- **local\_msat** (msat, optional): Amount of channel we funded **deprecated, removal in v23.05**
- **remote\_msat** (msat, optional): Amount of channel they funded **deprecated, removal in v23.05**
- **pushed\_msat** (msat, optional): Amount pushed from opener to peer
- **fee\_paid\_msat** (msat, optional): Amount we paid peer at open
- **fee\_rcvd\_msat** (msat, optional): Amount we were paid by peer at open
@ -399,4 +399,4 @@ Main web site: <https://github.com/ElementsProject/lightning> Lightning
RFC site (BOLT \#9):
<https://github.com/lightning/bolts/blob/master/09-features.md>
[comment]: # ( SHA256STAMP:6d080ab1b7a6c3577fb535a05539a91fbf7927518cbefaece4565212ea5b586e)
[comment]: # ( SHA256STAMP:c84136fcca3d0295cd1612873a54a074f3e8b6ae9cc643489cab6fb7376d66f6)

View file

@ -297,7 +297,8 @@
},
"announce-addr-dns": {
"type": "boolean",
"description": "Whether we put DNS entries into node_announcement"
"description": "Whether we put DNS entries into node_announcement",
"added": "v22.11.1"
}
}
}

View file

@ -343,11 +343,13 @@
"properties": {
"local_msat": {
"type": "msat",
"description": "Amount of channel we funded (deprecated)"
"deprecated": "v0.12.0",
"description": "Amount of channel we funded"
},
"remote_msat": {
"type": "msat",
"description": "Amount of channel they funded (deprecated)"
"deprecated": "v0.12.0",
"description": "Amount of channel they funded"
},
"pushed_msat": {
"type": "msat",