doc: Fix schema for offer.amount, it can be a non-BTC unit too

The `amount` field is intended to be either a native unit (`msat`, `sat` or `btc`) or it can also be a non-native unit that needs to be converted into native when creating the invoice. As such limiting the `amount` to only be native is very restrictive.
rustyrussell · Feb 7, 2024 · 09d32ec · 09d32ec
1 parent 317cf4d
commit 09d32ec
Show file tree

Hide file tree

Showing 5 changed files with 76 additions and 76 deletions.
diff --git a/cln-grpc/proto/node.proto b/cln-grpc/proto/node.proto
diff --git a/cln-grpc/src/convert.rs b/cln-grpc/src/convert.rs
diff --git a/cln-rpc/src/model.rs b/cln-rpc/src/model.rs
diff --git a/contrib/pyln-grpc-proto/pyln/grpc/node_pb2.py b/contrib/pyln-grpc-proto/pyln/grpc/node_pb2.py
diff --git a/doc/schemas/offer.request.json b/doc/schemas/offer.request.json
@@ -7,8 +7,8 @@
   ],
   "properties": {
     "amount": {
-      "type": "msat_or_any",
-      "description": "either the string \"any\" (e.g. for donations) or a positive value in millisatoshi precision"
+      "type": "string",
+      "description": "The amount parameter can be the string \"any\", which creates an offer that can be paid with any amount (e.g. a donation). Otherwise it can be a positive value in millisatoshi precision; it can be a whole number, or a whole number ending in msat or sat, or a number with three decimal places ending in sat, or a number with 1 to 11 decimal places ending in btc. `amount` can also have an ISO 4217 postfix (i.e. USD), in which case currency conversion will need to be done for the invoice itself. A plugin is needed which provides the \"currencyconvert\" API for this currency, otherwise the offer creation will fail."
     },
     "description": {
       "type": "string",