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