lightning-terminal/litrpc/proxy.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "proxy.proto",
    "version": "version not set"
  },
  "tags": [
    {
      "name": "Proxy"
    }
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/v1/proxy/info": {
      "get": {
        "summary": "litcli: `getinfo`\nGetInfo returns general information concerning the LiTd node.",
        "operationId": "Proxy_GetInfo",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/litrpcGetInfoResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "tags": [
          "Proxy"
        ]
      }
    },
    "/v1/proxy/stop": {
      "post": {
        "summary": "litcli: `stop`\nStopDaemon will send a shutdown request to the interrupt handler,\ntriggering a graceful shutdown of the daemon.",
        "operationId": "Proxy_StopDaemon",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/litrpcStopDaemonResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/litrpcStopDaemonRequest"
            }
          }
        ],
        "tags": [
          "Proxy"
        ]
      }
    },
    "/v1/proxy/supermacaroon": {
      "post": {
        "summary": "litcli: `bakesupermacaroon`\nBakeSuperMacaroon bakes a new macaroon that includes permissions for\nall the active daemons that LiT is connected to.",
        "operationId": "Proxy_BakeSuperMacaroon",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/litrpcBakeSuperMacaroonResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/litrpcBakeSuperMacaroonRequest"
            }
          }
        ],
        "tags": [
          "Proxy"
        ]
      }
    }
  },
  "definitions": {
    "litrpcBakeSuperMacaroonRequest": {
      "type": "object",
      "properties": {
        "root_key_id_suffix": {
          "type": "integer",
          "format": "int64",
          "description": "The root key ID suffix is the 4-byte suffix of the root key ID that will\nbe used to create the macaroon."
        },
        "read_only": {
          "type": "boolean",
          "description": "Whether the macaroon should only contain read permissions."
        }
      }
    },
    "litrpcBakeSuperMacaroonResponse": {
      "type": "object",
      "properties": {
        "macaroon": {
          "type": "string",
          "description": "The hex encoded macaroon."
        }
      }
    },
    "litrpcGetInfoResponse": {
      "type": "object",
      "properties": {
        "version": {
          "type": "string",
          "description": "The application version of the LiTd software running on the node,\nfollowing the Semantic Versioning 2.0.0 specification\n(http://semver.org/)."
        },
        "commit_hash": {
          "type": "string",
          "description": "The Git commit hash the LiTd binary build was based on. If the build had\nuncommited changes, this field will contain the most recent commit hash,\nsuffixed by \"-dirty\"."
        }
      }
    },
    "litrpcStopDaemonRequest": {
      "type": "object"
    },
    "litrpcStopDaemonResponse": {
      "type": "object"
    },
    "protobufAny": {
      "type": "object",
      "properties": {
        "@type": {
          "type": "string"
        }
      },
      "additionalProperties": {}
    },
    "rpcStatus": {
      "type": "object",
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/protobufAny"
          }
        }
      }
    }
  }
}