core-lightning/doc/schemas/pay.schema.json
Rusty Russell 40fe893172 doc/schemas: fix old deprecations.
`"deprecated": true` is obsolete; we don't document them anyway.

Where it would have otherwise changed the GRPC wrappers, I actually put the
version number in.

We allow "listchannels" to have "satoshis" since we have some tests
that run in deprecated-api mode.

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

58 lines
1.4 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"additionalProperties": false,
"required": [
"payment_preimage",
"payment_hash",
"created_at",
"parts",
"amount_msat",
"amount_sent_msat",
"status"
],
"properties": {
"payment_preimage": {
"type": "secret",
"description": "the proof of payment: SHA256 of this **payment_hash**"
},
"destination": {
"type": "pubkey",
"description": "the final destination of the payment"
},
"payment_hash": {
"type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment"
},
"created_at": {
"type": "number",
"description": "the UNIX timestamp showing when this payment was initiated"
},
"parts": {
"type": "u32",
"description": "how many attempts this took"
},
"amount_msat": {
"type": "msat",
"description": "Amount the recipient received"
},
"amount_sent_msat": {
"type": "msat",
"description": "Total amount we sent (including fees)"
},
"warning_partial_completion": {
"type": "string",
"description": "Not all parts of a multi-part payment have completed"
},
"status": {
"type": "string",
"enum": [
"complete",
"pending",
"failed"
],
"description": "status of payment"
}
}
}