core-lightning/doc/schemas/lightning-askrene-unreserve.json

{
  "$schema": "../rpc-schema-draft.json",
  "type": "object",
  "rpc": "askrene-unreserve",
  "title": "Command for informing askrene that you are no longer trying a path",
  "added": "v24.11",
  "description": [
    "The **askrene-unreserve** RPC command tells askrene that a path attempt has finished: it should only be called after a successful **askrene-reserve** call.",
    "",
    "Note that additional properties inside the *path* elements are ignored, which is useful when used with the result of *getroutes*."
  ],
  "request": {
    "required": [
      "path"
    ],
    "additionalProperties": false,
    "properties": {
      "path": {
        "type": "array",
        "items": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "short_channel_id_dir",
            "amount_msat"
          ],
          "properties": {
            "short_channel_id_dir": {
              "type": "short_channel_id_dir",
              "description": [
                "The channel and direction joining these nodes."
              ]
            },
            "amount_msat": {
              "type": "msat",
              "description": [
                "The amount to send into this hop."
              ]
            }
          }
        }
      }
    }
  },
  "response": {
    "required": [],
    "additionalProperties": false,
    "properties": {}
  },
  "see_also": [
    "lightning-getroutes(7)",
    "lightning-askrene-reserve(7)",
    "lightning-askrene-listreservations(7)"
  ],
  "author": [
    "Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
  ],
  "resources": [
    "Main web site: <https://github.com/ElementsProject/lightning>"
  ]
}