{
  "$schema": "../rpc-schema-draft.json",
  "type": "object",
  "rpc": "askrene-reserve",
  "title": "Command for informing askrene that you are trying a path (EXPERIMENTAL)",
  "description": [
    "WARNING: experimental, so API may change.",
    "",
    "The **askrene-reserve** RPC command tells askrene that a path is being attempted.  This allows it to take that into account when other *getroutes* calls are made.  You should call *askrene-unreserve* after the attempt has completed (and before calling *askrene-inform*).",
    "",
    "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-unreserve(7)",
    "lightning-askrene-listreservations(7)"
  ],
  "author": [
    "Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
  ],
  "resources": [
    "Main web site: <https://github.com/ElementsProject/lightning>"
  ]
}