mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 02:27:51 +01:00
2ddecdc95a
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
37 lines
967 B
JSON
37 lines
967 B
JSON
{
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [ "offer_id", "active", "single_use", "bolt12", "used" ],
|
|
"properties": {
|
|
"offer_id": {
|
|
"type": "hex",
|
|
"description": "the id of this offer (merkle hash of non-signature fields)",
|
|
"maxLength": 64,
|
|
"minLength": 64
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"enum": [ true ],
|
|
"description": "whether this can still be used"
|
|
},
|
|
"single_use": {
|
|
"type": "boolean",
|
|
"description": "whether this expires as soon as it's paid (reflects the *single_use* parameter)"
|
|
},
|
|
"bolt12": {
|
|
"type": "string",
|
|
"description": "the bolt12 encoding of the offer"
|
|
},
|
|
"used": {
|
|
"type": "boolean",
|
|
"enum": [ false ],
|
|
"description": "True if an associated invoice has been paid"
|
|
},
|
|
"label": {
|
|
"type": "string",
|
|
"description": "the (optional) user-specified label"
|
|
}
|
|
}
|
|
}
|