core-lightning/doc/schemas/offer.schema.json
Rusty Russell 2c41c5d52d doc: use specific types in schema rather than "hex".
We have "secret" and "hash" types which are often more appropriate.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-30 15:15:41 -06:00

47 lines
1.1 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"additionalProperties": false,
"required": [
"offer_id",
"active",
"single_use",
"bolt12",
"used",
"created"
],
"properties": {
"offer_id": {
"type": "hash",
"description": "the id of this offer (merkle hash of non-signature fields)"
},
"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",
"description": "True if an associated invoice has been paid"
},
"created": {
"type": "boolean",
"description": "false if the offer already existed"
},
"label": {
"type": "string",
"description": "the (optional) user-specified label"
}
}
}