docs/clamp/acm/api-protocol/swagger/k8sparticipant.json

   1 {
   2   "swagger": "2.0",
   3   "info": {
   4     "description": "Api Documentation",
   5     "version": "1.0",
   6     "title": "Api Documentation",
   7     "termsOfService": "urn:tos",
   8     "contact": {},
   9     "license": {
  10       "name": "Apache 2.0",
  11       "url": "http://www.apache.org/licenses/LICENSE-2.0"
  12     }
  13   },
  14   "paths": {
  15     "/onap/k8sparticipant/helm/chart/{name}/{version}": {
  16       "delete": {
  17         "tags": [
  18           "k8s-participant"
  19         ],
  20         "summary": "Delete the chart",
  21         "operationId": "deleteChartUsingDELETE",
  22         "produces": [
  23           "*/*"
  24         ],
  25         "parameters": [
  26           {
  27             "name": "name",
  28             "in": "path",
  29             "description": "name",
  30             "required": true,
  31             "type": "string"
  32           },
  33           {
  34             "name": "version",
  35             "in": "path",
  36             "description": "version",
  37             "required": true,
  38             "type": "string"
  39           }
  40         ],
  41         "responses": {
  42           "200": {
  43             "description": "OK",
  44             "schema": {
  45               "type": "object"
  46             }
  47           },
  48           "204": {
  49             "description": "Chart Deleted"
  50           },
  51           "401": {
  52             "description": "Unauthorized"
  53           },
  54           "403": {
  55             "description": "Forbidden"
  56           }
  57         }
  58       }
  59     },
  60     "/onap/k8sparticipant/helm/charts": {
  61       "get": {
  62         "tags": [
  63           "k8s-participant"
  64         ],
  65         "summary": "Return all Charts",
  66         "operationId": "getAllChartsUsingGET",
  67         "produces": [
  68           "application/json"
  69         ],
  70         "responses": {
  71           "200": {
  72             "description": "chart List",
  73             "schema": {
  74               "$ref": "#/definitions/ChartList",
  75               "originalRef": "ChartList"
  76             }
  77           },
  78           "401": {
  79             "description": "Unauthorized"
  80           },
  81           "403": {
  82             "description": "Forbidden"
  83           },
  84           "404": {
  85             "description": "Not Found"
  86           }
  87         }
  88       }
  89     },
  90     "/onap/k8sparticipant/helm/install": {
  91       "post": {
  92         "tags": [
  93           "k8s-participant"
  94         ],
  95         "summary": "Install the chart",
  96         "operationId": "installChartUsingPOST",
  97         "consumes": [
  98           "application/json"
  99         ],
 100         "produces": [
 101           "application/json"
 102         ],
 103         "parameters": [
 104           {
 105             "in": "body",
 106             "name": "info",
 107             "description": "info",
 108             "required": true,
 109             "schema": {
 110               "$ref": "#/definitions/InstallationInfo",
 111               "originalRef": "InstallationInfo"
 112             }
 113           }
 114         ],
 115         "responses": {
 116           "200": {
 117             "description": "OK",
 118             "schema": {
 119               "type": "object"
 120             }
 121           },
 122           "201": {
 123             "description": "chart Installed",
 124             "schema": {
 125               "type": "object"
 126             }
 127           },
 128           "401": {
 129             "description": "Unauthorized"
 130           },
 131           "403": {
 132             "description": "Forbidden"
 133           },
 134           "404": {
 135             "description": "Not Found"
 136           }
 137         }
 138       }
 139     },
 140     "/onap/k8sparticipant/helm/onboard/chart": {
 141       "post": {
 142         "tags": [
 143           "k8s-participant"
 144         ],
 145         "summary": "Onboard the Chart",
 146         "operationId": "onboardChartUsingPOST",
 147         "consumes": [
 148           "multipart/form-data"
 149         ],
 150         "produces": [
 151           "application/json"
 152         ],
 153         "parameters": [
 154           {
 155             "name": "chart",
 156             "in": "formData",
 157             "required": false,
 158             "type": "file"
 159           },
 160           {
 161             "name": "info",
 162             "in": "formData",
 163             "required": false,
 164             "type": "string"
 165           },
 166           {
 167             "in": "body",
 168             "name": "values",
 169             "description": "values",
 170             "required": false,
 171             "schema": {
 172               "type": "string",
 173               "format": "binary"
 174             }
 175           }
 176         ],
 177         "responses": {
 178           "200": {
 179             "description": "OK",
 180             "schema": {
 181               "type": "string"
 182             }
 183           },
 184           "201": {
 185             "description": "Chart Onboarded",
 186             "schema": {
 187               "type": "string"
 188             }
 189           },
 190           "401": {
 191             "description": "Unauthorized"
 192           },
 193           "403": {
 194             "description": "Forbidden"
 195           },
 196           "404": {
 197             "description": "Not Found"
 198           }
 199         }
 200       }
 201     },
 202     "/onap/k8sparticipant/helm/repo": {
 203       "post": {
 204         "tags": [
 205           "k8s-participant"
 206         ],
 207         "summary": "Configure helm repository",
 208         "operationId": "configureRepoUsingPOST",
 209         "consumes": [
 210           "application/json"
 211         ],
 212         "produces": [
 213           "application/json"
 214         ],
 215         "parameters": [
 216           {
 217             "in": "body",
 218             "name": "repo",
 219             "description": "repo",
 220             "required": true,
 221             "schema": {
 222               "type": "string"
 223             }
 224           }
 225         ],
 226         "responses": {
 227           "200": {
 228             "description": "OK",
 229             "schema": {
 230               "type": "object"
 231             }
 232           },
 233           "201": {
 234             "description": "Repository added",
 235             "schema": {
 236               "type": "object"
 237             }
 238           },
 239           "401": {
 240             "description": "Unauthorized"
 241           },
 242           "403": {
 243             "description": "Forbidden"
 244           },
 245           "404": {
 246             "description": "Not Found"
 247           }
 248         }
 249       }
 250     },
 251     "/onap/k8sparticipant/helm/uninstall/{name}/{version}": {
 252       "delete": {
 253         "tags": [
 254           "k8s-participant"
 255         ],
 256         "summary": "Uninstall the Chart",
 257         "operationId": "uninstallChartUsingDELETE",
 258         "produces": [
 259           "application/json"
 260         ],
 261         "parameters": [
 262           {
 263             "name": "name",
 264             "in": "path",
 265             "description": "name",
 266             "required": true,
 267             "type": "string"
 268           },
 269           {
 270             "name": "version",
 271             "in": "path",
 272             "description": "version",
 273             "required": true,
 274             "type": "string"
 275           }
 276         ],
 277         "responses": {
 278           "200": {
 279             "description": "OK",
 280             "schema": {
 281               "type": "object"
 282             }
 283           },
 284           "201": {
 285             "description": "chart Uninstalled",
 286             "schema": {
 287               "type": "object"
 288             }
 289           },
 290           "204": {
 291             "description": "No Content"
 292           },
 293           "401": {
 294             "description": "Unauthorized"
 295           },
 296           "403": {
 297             "description": "Forbidden"
 298           }
 299         }
 300       }
 301     }
 302   },
 303   "definitions": {
 304     "ChartInfo": {
 305       "type": "object",
 306       "properties": {
 307         "chartId": {
 308           "$ref": "#/definitions/ToscaConceptIdentifier",
 309           "originalRef": "ToscaConceptIdentifier"
 310         },
 311         "namespace": {
 312           "type": "string"
 313         },
 314         "overrideParams": {
 315           "type": "object",
 316           "additionalProperties": {
 317             "type": "string"
 318           }
 319         },
 320         "releaseName": {
 321           "type": "string"
 322         },
 323         "repository": {
 324           "$ref": "#/definitions/HelmRepository",
 325           "originalRef": "HelmRepository"
 326         }
 327       },
 328       "title": "ChartInfo"
 329     },
 330     "ChartList": {
 331       "type": "object",
 332       "properties": {
 333         "charts": {
 334           "type": "array",
 335           "items": {
 336             "$ref": "#/definitions/ChartInfo",
 337             "originalRef": "ChartInfo"
 338           }
 339         }
 340       },
 341       "title": "ChartList"
 342     },
 343     "HelmRepository": {
 344       "type": "object",
 345       "properties": {
 346         "address": {
 347           "type": "string"
 348         },
 349         "password": {
 350           "type": "string"
 351         },
 352         "port": {
 353           "type": "string"
 354         },
 355         "protocol": {
 356           "type": "string"
 357         },
 358         "repoName": {
 359           "type": "string"
 360         },
 361         "userName": {
 362           "type": "string"
 363         }
 364       },
 365       "title": "HelmRepository"
 366     },
 367     "InstallationInfo": {
 368       "type": "object",
 369       "properties": {
 370         "name": {
 371           "type": "string"
 372         },
 373         "version": {
 374           "type": "string"
 375         }
 376       },
 377       "title": "InstallationInfo"
 378     },
 379     "ToscaConceptIdentifier": {
 380       "type": "object",
 381       "properties": {
 382         "name": {
 383           "type": "string"
 384         },
 385         "version": {
 386           "type": "string"
 387         }
 388       },
 389       "title": "ToscaConceptIdentifier"
 390     }
 391   }
 392 }