Skip to content

Commit 57dfd34

Browse files
ShahanaFarooquiShahanaFarooqui
committed
doc: Added doc schemas with description and update proto
1 parent 21f53d5 commit 57dfd34

File tree

11 files changed

+841
-759
lines changed

11 files changed

+841
-759
lines changed

‎.msggen.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1625,6 +1625,7 @@
16251625
"DisableofferResponse": {
16261626
"DisableOffer.active": 2,
16271627
"DisableOffer.bolt12": 4,
1628+
"DisableOffer.description": 7,
16281629
"DisableOffer.label": 6,
16291630
"DisableOffer.offer_id": 1,
16301631
"DisableOffer.single_use": 3,
@@ -1643,6 +1644,7 @@
16431644
"EnableofferResponse": {
16441645
"EnableOffer.active": 2,
16451646
"EnableOffer.bolt12": 4,
1647+
"EnableOffer.description": 7,
16461648
"EnableOffer.label": 6,
16471649
"EnableOffer.offer_id": 1,
16481650
"EnableOffer.single_use": 3,
@@ -2859,6 +2861,7 @@
28592861
"ListoffersOffers": {
28602862
"ListOffers.offers[].active": 2,
28612863
"ListOffers.offers[].bolt12": 4,
2864+
"ListOffers.offers[].description": 7,
28622865
"ListOffers.offers[].label": 6,
28632866
"ListOffers.offers[].offer_id": 1,
28642867
"ListOffers.offers[].single_use": 3,
@@ -7060,6 +7063,10 @@
70607063
"added": "pre-v0.10.1",
70617064
"deprecated": null
70627065
},
7066+
"DisableOffer.description": {
7067+
"added": "v26.04",
7068+
"deprecated": null
7069+
},
70637070
"DisableOffer.label": {
70647071
"added": "pre-v0.10.1",
70657072
"deprecated": null
@@ -7108,6 +7115,10 @@
71087115
"added": "v24.11",
71097116
"deprecated": null
71107117
},
7118+
"EnableOffer.description": {
7119+
"added": "v26.04",
7120+
"deprecated": null
7121+
},
71117122
"EnableOffer.label": {
71127123
"added": "v24.11",
71137124
"deprecated": null
@@ -10568,6 +10579,10 @@
1056810579
"added": "pre-v0.10.1",
1056910580
"deprecated": null
1057010581
},
10582+
"ListOffers.offers[].description": {
10583+
"added": "v26.04",
10584+
"deprecated": null
10585+
},
1057110586
"ListOffers.offers[].label": {
1057210587
"added": "pre-v0.10.1",
1057310588
"deprecated": null

‎cln-grpc/proto/node.proto‎

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎cln-grpc/src/convert.rs‎

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎cln-rpc/src/model.rs‎

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎contrib/msggen/msggen/schema.json‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11922,6 +11922,13 @@
1192211922
"The bolt12 string representing this offer."
1192311923
]
1192411924
},
11925+
"description": {
11926+
"added": "v26.04",
11927+
"type": "string",
11928+
"description": [
11929+
"The user-specified bolt 12 description."
11930+
]
11931+
},
1192511932
"used": {
1192611933
"type": "boolean",
1192711934
"description": [
@@ -11964,6 +11971,7 @@
1196411971
"active": false,
1196511972
"single_use": false,
1196611973
"bolt12": "lno1qgsq000bolt230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000",
11974+
"description": "Movie ticket",
1196711975
"used": false
1196811976
}
1196911977
}
@@ -12169,6 +12177,13 @@
1216912177
"The bolt12 string representing this offer."
1217012178
]
1217112179
},
12180+
"description": {
12181+
"added": "v26.04",
12182+
"type": "string",
12183+
"description": [
12184+
"The user-specified bolt 12 description."
12185+
]
12186+
},
1217212187
"used": {
1217312188
"type": "boolean",
1217412189
"description": [
@@ -12217,6 +12232,7 @@
1221712232
"active": true,
1221812233
"single_use": false,
1221912234
"bolt12": "lno1qgsq000bolt230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000",
12235+
"description": "Movie ticket",
1222012236
"used": false
1222112237
}
1222212238
}
@@ -23462,6 +23478,13 @@
2346223478
"The bolt12 encoding of the offer."
2346323479
]
2346423480
},
23481+
"description": {
23482+
"added": "v26.04",
23483+
"type": "string",
23484+
"description": [
23485+
"The user-specified bolt 12 description."
23486+
]
23487+
},
2346523488
"used": {
2346623489
"type": "boolean",
2346723490
"description": [
@@ -23505,20 +23528,23 @@
2350523528
"active": true,
2350623529
"single_use": false,
2350723530
"bolt12": "lno1qgsq000bolt210002100021000210002100021000210002100021000210002100021000210002100021000210002100021000210002100021000210002100021000",
23531+
"description": "Fish sale!",
2350823532
"used": false
2350923533
},
2351023534
{
2351123535
"offer_id": "offeridl22000002200000220000022000002200000220000022000002200000",
2351223536
"active": true,
2351323537
"single_use": false,
2351423538
"bolt12": "lno1qgsq000bolt220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000",
23539+
"description": "Coffee",
2351523540
"used": false
2351623541
},
2351723542
{
2351823543
"offer_id": "offeridl23000002300000230000023000002300000230000023000002300000",
2351923544
"active": true,
2352023545
"single_use": false,
2352123546
"bolt12": "lno1qgsq000bolt230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000",
23547+
"description": "Movie ticket",
2352223548
"used": false
2352323549
}
2352423550
]

‎contrib/pyln-grpc-proto/pyln/grpc/node_pb2.py‎

Lines changed: 758 additions & 758 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎contrib/pyln-testing/pyln/testing/grpc2py.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1423,6 +1423,7 @@ def disableoffer2py(m):
14231423
return remove_default({
14241424
"active": m.active, # PrimitiveField in generate_composite
14251425
"bolt12": m.bolt12, # PrimitiveField in generate_composite
1426+
"description": m.description, # PrimitiveField in generate_composite
14261427
"label": m.label, # PrimitiveField in generate_composite
14271428
"offer_id": hexlify(m.offer_id), # PrimitiveField in generate_composite
14281429
"single_use": m.single_use, # PrimitiveField in generate_composite
@@ -1434,6 +1435,7 @@ def enableoffer2py(m):
14341435
return remove_default({
14351436
"active": m.active, # PrimitiveField in generate_composite
14361437
"bolt12": m.bolt12, # PrimitiveField in generate_composite
1438+
"description": m.description, # PrimitiveField in generate_composite
14371439
"label": m.label, # PrimitiveField in generate_composite
14381440
"offer_id": hexlify(m.offer_id), # PrimitiveField in generate_composite
14391441
"single_use": m.single_use, # PrimitiveField in generate_composite
@@ -1712,6 +1714,7 @@ def listoffers_offers2py(m):
17121714
return remove_default({
17131715
"active": m.active, # PrimitiveField in generate_composite
17141716
"bolt12": m.bolt12, # PrimitiveField in generate_composite
1717+
"description": m.description, # PrimitiveField in generate_composite
17151718
"label": m.label, # PrimitiveField in generate_composite
17161719
"offer_id": hexlify(m.offer_id), # PrimitiveField in generate_composite
17171720
"single_use": m.single_use, # PrimitiveField in generate_composite

‎doc/schemas/disableoffer.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,13 @@
5959
"The bolt12 string representing this offer."
6060
]
6161
},
62+
"description": {
63+
"added": "v26.04",
64+
"type": "string",
65+
"description": [
66+
"The user-specified bolt 12 description."
67+
]
68+
},
6269
"used": {
6370
"type": "boolean",
6471
"description": [
@@ -101,6 +108,7 @@
101108
"active": false,
102109
"single_use": false,
103110
"bolt12": "lno1qgsq000bolt230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000",
111+
"description": "Movie ticket",
104112
"used": false
105113
}
106114
}

‎doc/schemas/enableoffer.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,13 @@
5757
"The bolt12 string representing this offer."
5858
]
5959
},
60+
"description": {
61+
"added": "v26.04",
62+
"type": "string",
63+
"description": [
64+
"The user-specified bolt 12 description."
65+
]
66+
},
6067
"used": {
6168
"type": "boolean",
6269
"description": [
@@ -105,6 +112,7 @@
105112
"active": true,
106113
"single_use": false,
107114
"bolt12": "lno1qgsq000bolt230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000",
115+
"description": "Movie ticket",
108116
"used": false
109117
}
110118
}

‎doc/schemas/listoffers.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,13 @@
7070
"The bolt12 encoding of the offer."
7171
]
7272
},
73+
"description": {
74+
"added": "v26.04",
75+
"type": "string",
76+
"description": [
77+
"The user-specified bolt 12 description."
78+
]
79+
},
7380
"used": {
7481
"type": "boolean",
7582
"description": [
@@ -113,20 +120,23 @@
113120
"active": true,
114121
"single_use": false,
115122
"bolt12": "lno1qgsq000bolt210002100021000210002100021000210002100021000210002100021000210002100021000210002100021000210002100021000210002100021000",
123+
"description": "Fish sale!",
116124
"used": false
117125
},
118126
{
119127
"offer_id": "offeridl22000002200000220000022000002200000220000022000002200000",
120128
"active": true,
121129
"single_use": false,
122130
"bolt12": "lno1qgsq000bolt220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000",
131+
"description": "Coffee",
123132
"used": false
124133
},
125134
{
126135
"offer_id": "offeridl23000002300000230000023000002300000230000023000002300000",
127136
"active": true,
128137
"single_use": false,
129138
"bolt12": "lno1qgsq000bolt230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000",
139+
"description": "Movie ticket",
130140
"used": false
131141
}
132142
]

0 commit comments

Comments
 (0)