github.com/vchain-us/vcn@v0.9.11-0.20210921212052-a2484d23c0b3/pkg/api/swagger.json (about)

     1  {
     2    "swagger": "2.0",
     3    "info": {
     4      "version": "1.0",
     5      "title": "VCN server",
     6      "contact": {}
     7    },
     8    "host": "127.0.0.1:8080",
     9    "basePath": "/",
    10    "securityDefinitions": {
    11      "auth": {
    12        "type": "basic"
    13      }
    14    },
    15    "schemes": [
    16      "http"
    17    ],
    18    "consumes": [
    19      "application/json"
    20    ],
    21    "produces": [
    22      "application/json"
    23    ],
    24    "paths": {
    25      "/": {
    26        "get": {
    27          "summary": "health check",
    28          "tags": [
    29            "Misc"
    30          ],
    31          "operationId": "healthcheck",
    32          "deprecated": false,
    33          "produces": [
    34            "application/json"
    35          ],
    36          "parameters": [],
    37          "responses": {
    38            "200": {
    39              "description": "",
    40              "headers": {}
    41            }
    42          }
    43        }
    44      },
    45      "/notarize": {
    46        "post": {
    47          "description": "This method is invoked to notarize an artifact\nIf successful a BlockchainVerification is returned.\nBy default, the artifact is notarized using status = meta.StatusTrusted, visibility meta.VisibilityPrivate.\nAt least the key (secret) must be provided.",
    48          "summary": "notarize",
    49          "tags": [
    50            "Misc"
    51          ],
    52          "operationId": "notarize",
    53          "deprecated": false,
    54          "produces": [
    55            "application/json"
    56          ],
    57          "parameters": [
    58            {
    59              "name": "x-notarization-password",
    60              "in": "header",
    61              "required": true,
    62              "type": "string",
    63              "description": ""
    64            },
    65            {
    66              "name": "Body",
    67              "in": "body",
    68              "required": true,
    69              "description": "",
    70              "schema": {
    71                "$ref": "#/definitions/notarizerequest"
    72              }
    73            }
    74          ],
    75          "responses": {
    76            "200": {
    77              "description": "",
    78              "headers": {}
    79            }
    80          }
    81        }
    82      },
    83      "/untrusted": {
    84        "post": {
    85          "description": "“untrust” an asset (meaning the user deems this file unsafe)",
    86          "summary": "untrust",
    87          "tags": [
    88            "Misc"
    89          ],
    90          "operationId": "untrust",
    91          "deprecated": false,
    92          "produces": [
    93            "application/json"
    94          ],
    95          "parameters": [
    96            {
    97              "name": "x-notarization-password",
    98              "in": "header",
    99              "required": true,
   100              "type": "string",
   101              "description": ""
   102            },
   103            {
   104              "name": "Body",
   105              "in": "body",
   106              "required": true,
   107              "description": "",
   108              "schema": {
   109                "$ref": "#/definitions/untrustrequest"
   110              }
   111            }
   112          ],
   113          "responses": {
   114            "200": {
   115              "description": "",
   116              "headers": {}
   117            }
   118          }
   119        }
   120      },
   121      "/unsupport": {
   122        "post": {
   123          "description": "“unsupport” an asset (meaning this file may no longer work)",
   124          "summary": "unsupport",
   125          "tags": [
   126            "Misc"
   127          ],
   128          "operationId": "unsupport",
   129          "deprecated": false,
   130          "produces": [
   131            "application/json"
   132          ],
   133          "parameters": [
   134            {
   135              "name": "x-notarization-password",
   136              "in": "header",
   137              "required": true,
   138              "type": "string",
   139              "description": ""
   140            },
   141            {
   142              "name": "Body",
   143              "in": "body",
   144              "required": true,
   145              "description": "",
   146              "schema": {
   147                "$ref": "#/definitions/unsupportrequest"
   148              }
   149            }
   150          ],
   151          "responses": {
   152            "200": {
   153              "description": "",
   154              "headers": {}
   155            }
   156          }
   157        }
   158      },
   159      "/authenticate/{hash}": {
   160        "get": {
   161          "description": "Authenticating (verifying) an asset is the same as was done previously and can be performed on any kind of supported asset.",
   162          "summary": "authenticate",
   163          "tags": [
   164            "Misc"
   165          ],
   166          "operationId": "authenticate",
   167          "deprecated": false,
   168          "produces": [
   169            "application/json"
   170          ],
   171          "parameters": [
   172            {
   173              "name": "hash",
   174              "in": "path",
   175              "required": true,
   176              "type": "string",
   177              "description": ""
   178            },
   179            {
   180              "name": "x-notarization-password",
   181              "in": "header",
   182              "required": true,
   183              "type": "string",
   184              "description": ""
   185            }
   186          ],
   187          "responses": {
   188            "200": {
   189              "description": "",
   190              "headers": {}
   191            }
   192          }
   193        }
   194      },
   195      "/inspect/{hash}": {
   196        "get": {
   197          "description": "Return the asset history with low-level information",
   198          "summary": "inspect",
   199          "tags": [
   200            "Misc"
   201          ],
   202          "operationId": "inspect",
   203          "deprecated": false,
   204          "produces": [
   205            "application/json"
   206          ],
   207          "parameters": [
   208            {
   209              "name": "hash",
   210              "in": "path",
   211              "required": true,
   212              "type": "string",
   213              "description": ""
   214            },
   215            {
   216              "name": "x-notarization-password",
   217              "in": "header",
   218              "required": true,
   219              "type": "string",
   220              "description": ""
   221            }
   222          ],
   223          "responses": {
   224            "200": {
   225              "description": "",
   226              "headers": {}
   227            }
   228          }
   229        }
   230      }
   231    },
   232    "definitions": {
   233      "notarizerequest": {
   234        "title": "notarizerequest",
   235        "example": {
   236          "Kind": "file",
   237          "Name": "CONTRIBUTING.md",
   238          "Hash": "e2b58ab102dbadb3b1fd5139c8d2a937dc622b1b0d0907075edea163fe2cd093",
   239          "Size": 1400,
   240          "ContentType": "text/plain; charset=utf-8"
   241        },
   242        "type": "object",
   243        "properties": {
   244          "Kind": {
   245            "type": "string"
   246          },
   247          "Name": {
   248            "type": "string"
   249          },
   250          "Hash": {
   251            "type": "string"
   252          },
   253          "Size": {
   254            "type": "integer",
   255            "format": "int32"
   256          },
   257          "ContentType": {
   258            "type": "string"
   259          }
   260        },
   261        "required": [
   262          "Kind",
   263          "Name",
   264          "Hash",
   265          "Size",
   266          "ContentType"
   267        ]
   268      },
   269      "untrustrequest": {
   270        "title": "untrustrequest",
   271        "example": {
   272          "Kind": "file",
   273          "Name": "CONTRIBUTING.md",
   274          "Hash": "e2b58ab102dbadb3b1fd5139c8d2a937dc622b1b0d0907075edea163fe2cd093",
   275          "Size": 1400,
   276          "ContentType": "text/plain; charset=utf-8"
   277        },
   278        "type": "object",
   279        "properties": {
   280          "Kind": {
   281            "type": "string"
   282          },
   283          "Name": {
   284            "type": "string"
   285          },
   286          "Hash": {
   287            "type": "string"
   288          },
   289          "Size": {
   290            "type": "integer",
   291            "format": "int32"
   292          },
   293          "ContentType": {
   294            "type": "string"
   295          }
   296        },
   297        "required": [
   298          "Kind",
   299          "Name",
   300          "Hash",
   301          "Size",
   302          "ContentType"
   303        ]
   304      },
   305      "unsupportrequest": {
   306        "title": "unsupportrequest",
   307        "example": {
   308          "Name": "CONTRIBUTING.md",
   309          "Hash": "e2b58ab102dbadb3b1fd5139c8d2a937dc622b1b0d0907075edea163fe2cd093"
   310        },
   311        "type": "object",
   312        "properties": {
   313          "Name": {
   314            "type": "string"
   315          },
   316          "Hash": {
   317            "type": "string"
   318          }
   319        },
   320        "required": [
   321          "Name",
   322          "Hash"
   323        ]
   324      }
   325    },
   326    "security": [
   327      {
   328        "auth": []
   329      }
   330    ],
   331    "tags": [
   332      {
   333        "name": "Misc",
   334        "description": ""
   335      }
   336    ]
   337  }