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

     1  {
     2    "swagger": "2.0",
     3    "info": {
     4      "title": "initchainsyncrpc/initchainsync.proto",
     5      "version": "version not set"
     6    },
     7    "tags": [
     8      {
     9        "name": "InitialChainSync"
    10      }
    11    ],
    12    "consumes": [
    13      "application/json"
    14    ],
    15    "produces": [
    16      "application/json"
    17    ],
    18    "paths": {
    19      "/v2/initchainsync/subscribe": {
    20        "get": {
    21          "summary": "SubscribeChainSync is a streaming call that registers a client to receive\nupdates about the progress of the sync procedure. If an update message is\nreceived with synced = true, then this will be the last update sent and\nthe server will be shutdown.",
    22          "operationId": "InitialChainSync_SubscribeChainSync",
    23          "responses": {
    24            "200": {
    25              "description": "A successful response.(streaming responses)",
    26              "schema": {
    27                "type": "object",
    28                "properties": {
    29                  "result": {
    30                    "$ref": "#/definitions/initialchainsyncrpcChainSyncUpdate"
    31                  },
    32                  "error": {
    33                    "$ref": "#/definitions/rpcStatus"
    34                  }
    35                },
    36                "title": "Stream result of initialchainsyncrpcChainSyncUpdate"
    37              }
    38            },
    39            "default": {
    40              "description": "An unexpected error response.",
    41              "schema": {
    42                "$ref": "#/definitions/rpcStatus"
    43              }
    44            }
    45          },
    46          "tags": [
    47            "InitialChainSync"
    48          ]
    49        }
    50      }
    51    },
    52    "definitions": {
    53      "initialchainsyncrpcChainSyncUpdate": {
    54        "type": "object",
    55        "properties": {
    56          "block_height": {
    57            "type": "string",
    58            "format": "int64"
    59          },
    60          "block_hash": {
    61            "type": "string",
    62            "format": "byte"
    63          },
    64          "block_timestamp": {
    65            "type": "string",
    66            "format": "int64"
    67          },
    68          "synced": {
    69            "type": "boolean"
    70          }
    71        }
    72      },
    73      "protobufAny": {
    74        "type": "object",
    75        "properties": {
    76          "type_url": {
    77            "type": "string"
    78          },
    79          "value": {
    80            "type": "string",
    81            "format": "byte"
    82          }
    83        }
    84      },
    85      "rpcStatus": {
    86        "type": "object",
    87        "properties": {
    88          "code": {
    89            "type": "integer",
    90            "format": "int32"
    91          },
    92          "message": {
    93            "type": "string"
    94          },
    95          "details": {
    96            "type": "array",
    97            "items": {
    98              "$ref": "#/definitions/protobufAny"
    99            }
   100          }
   101        }
   102      }
   103    }
   104  }