github.com/decred/dcrlnd@v0.7.6/lnrpc/stateservice.swagger.json (about)

     1  {
     2    "swagger": "2.0",
     3    "info": {
     4      "title": "stateservice.proto",
     5      "version": "version not set"
     6    },
     7    "tags": [
     8      {
     9        "name": "State"
    10      }
    11    ],
    12    "consumes": [
    13      "application/json"
    14    ],
    15    "produces": [
    16      "application/json"
    17    ],
    18    "paths": {
    19      "/v1/state": {
    20        "get": {
    21          "summary": "GetState returns the current wallet state without streaming further\nchanges.",
    22          "operationId": "State_GetState",
    23          "responses": {
    24            "200": {
    25              "description": "A successful response.",
    26              "schema": {
    27                "$ref": "#/definitions/lnrpcGetStateResponse"
    28              }
    29            },
    30            "default": {
    31              "description": "An unexpected error response.",
    32              "schema": {
    33                "$ref": "#/definitions/rpcStatus"
    34              }
    35            }
    36          },
    37          "tags": [
    38            "State"
    39          ]
    40        }
    41      },
    42      "/v1/state/subscribe": {
    43        "get": {
    44          "summary": "SubscribeState subscribes to the state of the wallet. The current wallet\nstate will always be delivered immediately.",
    45          "operationId": "State_SubscribeState",
    46          "responses": {
    47            "200": {
    48              "description": "A successful response.(streaming responses)",
    49              "schema": {
    50                "type": "object",
    51                "properties": {
    52                  "result": {
    53                    "$ref": "#/definitions/lnrpcSubscribeStateResponse"
    54                  },
    55                  "error": {
    56                    "$ref": "#/definitions/rpcStatus"
    57                  }
    58                },
    59                "title": "Stream result of lnrpcSubscribeStateResponse"
    60              }
    61            },
    62            "default": {
    63              "description": "An unexpected error response.",
    64              "schema": {
    65                "$ref": "#/definitions/rpcStatus"
    66              }
    67            }
    68          },
    69          "tags": [
    70            "State"
    71          ]
    72        }
    73      }
    74    },
    75    "definitions": {
    76      "lnrpcGetStateResponse": {
    77        "type": "object",
    78        "properties": {
    79          "state": {
    80            "$ref": "#/definitions/lnrpcWalletState"
    81          }
    82        }
    83      },
    84      "lnrpcSubscribeStateResponse": {
    85        "type": "object",
    86        "properties": {
    87          "state": {
    88            "$ref": "#/definitions/lnrpcWalletState"
    89          }
    90        }
    91      },
    92      "lnrpcWalletState": {
    93        "type": "string",
    94        "enum": [
    95          "NON_EXISTING",
    96          "LOCKED",
    97          "UNLOCKED",
    98          "RPC_ACTIVE",
    99          "SERVER_ACTIVE",
   100          "WAITING_TO_START"
   101        ],
   102        "default": "NON_EXISTING",
   103        "description": " - SERVER_ACTIVE: SERVER_ACTIVE means that the lnd server is ready to accept calls."
   104      },
   105      "protobufAny": {
   106        "type": "object",
   107        "properties": {
   108          "type_url": {
   109            "type": "string"
   110          },
   111          "value": {
   112            "type": "string",
   113            "format": "byte"
   114          }
   115        }
   116      },
   117      "rpcStatus": {
   118        "type": "object",
   119        "properties": {
   120          "code": {
   121            "type": "integer",
   122            "format": "int32"
   123          },
   124          "message": {
   125            "type": "string"
   126          },
   127          "details": {
   128            "type": "array",
   129            "items": {
   130              "$ref": "#/definitions/protobufAny"
   131            }
   132          }
   133        }
   134      }
   135    }
   136  }