Merge "Reestructuring the clamp doc tree"

1 files changed, 399 insertions, 0 deletions

diff --git a/docs/clamp/acm/design-impl/participants/swagger/k8s-participant-swagger.json b/docs/clamp/acm/design-impl/participants/swagger/k8s-participant-swagger.json
new file mode 100644
index 00000000..b2fca37a
--- /dev/null
+++ b/docs/clamp/acm/design-impl/participants/swagger/k8s-participant-swagger.json
@@ -0,0 +1,399 @@
+{
+   "swagger":"2.0",
+   "info":{
+      "description":"Api Documentation",
+      "version":"1.0",
+      "title":"Api Documentation",
+      "termsOfService":"urn:tos",
+      "contact":{},
+      "license":{
+         "name":"Apache 2.0",
+         "url":"http://www.apache.org/licenses/LICENSE-2.0"
+      }
+   },
+   "host":"localhost:8083",
+   "tags":[
+      {
+         "name":"k8s-participant",
+         "description":"Chart Controller"
+      }
+   ],
+   "paths":{
+      "/onap/k8sparticipant/helm/chart/{name}/{version}":{
+         "delete":{
+            "tags":[
+               "k8s-participant"
+            ],
+            "summary":"Delete the chart",
+            "operationId":"deleteChartUsingDELETE",
+            "produces":[
+               "*/*"
+            ],
+            "parameters":[
+               {
+                  "name":"name",
+                  "in":"path",
+                  "description":"name",
+                  "required":true,
+                  "type":"string"
+               },
+               {
+                  "name":"version",
+                  "in":"path",
+                  "description":"version",
+                  "required":true,
+                  "type":"string"
+               }
+            ],
+            "responses":{
+               "200":{
+                  "description":"OK",
+                  "schema":{
+                     "type":"object"
+                  }
+               },
+               "204":{
+                  "description":"Chart Deleted"
+               },
+               "401":{
+                  "description":"Unauthorized"
+               },
+               "403":{
+                  "description":"Forbidden"
+               }
+            }
+         }
+      },
+      "/onap/k8sparticipant/helm/charts":{
+         "get":{
+            "tags":[
+               "k8s-participant"
+            ],
+            "summary":"Return all Charts",
+            "operationId":"getAllChartsUsingGET",
+            "produces":[
+               "application/json"
+            ],
+            "responses":{
+               "200":{
+                  "description":"chart List",
+                  "schema":{
+                     "$ref":"#/definitions/ChartList",
+                     "originalRef":"ChartList"
+                  }
+               },
+               "401":{
+                  "description":"Unauthorized"
+               },
+               "403":{
+                  "description":"Forbidden"
+               },
+               "404":{
+                  "description":"Not Found"
+               }
+            }
+         }
+      },
+      "/onap/k8sparticipant/helm/install":{
+         "post":{
+            "tags":[
+               "k8s-participant"
+            ],
+            "summary":"Install the chart",
+            "operationId":"installChartUsingPOST",
+            "consumes":[
+               "application/json"
+            ],
+            "produces":[
+               "application/json"
+            ],
+            "parameters":[
+               {
+                  "in":"body",
+                  "name":"info",
+                  "description":"info",
+                  "required":true,
+                  "schema":{
+                     "$ref":"#/definitions/InstallationInfo",
+                     "originalRef":"InstallationInfo"
+                  }
+               }
+            ],
+            "responses":{
+               "200":{
+                  "description":"OK",
+                  "schema":{
+                     "type":"object"
+                  }
+               },
+               "201":{
+                  "description":"chart Installed",
+                  "schema":{
+                     "type":"object"
+                  }
+               },
+               "401":{
+                  "description":"Unauthorized"
+               },
+               "403":{
+                  "description":"Forbidden"
+               },
+               "404":{
+                  "description":"Not Found"
+               }
+            }
+         }
+      },
+      "/onap/k8sparticipant/helm/onboard/chart":{
+         "post":{
+            "tags":[
+               "k8s-participant"
+            ],
+            "summary":"Onboard the Chart",
+            "operationId":"onboardChartUsingPOST",
+            "consumes":[
+               "multipart/form-data"
+            ],
+            "produces":[
+               "application/json"
+            ],
+            "parameters":[
+               {
+                  "name":"chart",
+                  "in":"formData",
+                  "required":false,
+                  "type":"file"
+               },
+               {
+                  "name":"info",
+                  "in":"formData",
+                  "required":false,
+                  "type":"string"
+               },
+               {
+                  "in":"body",
+                  "name":"values",
+                  "description":"values",
+                  "required":false,
+                  "schema":{
+                     "type":"string",
+                     "format":"binary"
+                  }
+               }
+            ],
+            "responses":{
+               "200":{
+                  "description":"OK",
+                  "schema":{
+                     "type":"string"
+                  }
+               },
+               "201":{
+                  "description":"Chart Onboarded",
+                  "schema":{
+                     "type":"string"
+                  }
+               },
+               "401":{
+                  "description":"Unauthorized"
+               },
+               "403":{
+                  "description":"Forbidden"
+               },
+               "404":{
+                  "description":"Not Found"
+               }
+            }
+         }
+      },
+      "/onap/k8sparticipant/helm/repo":{
+         "post":{
+            "tags":[
+               "k8s-participant"
+            ],
+            "summary":"Configure helm repository",
+            "operationId":"configureRepoUsingPOST",
+            "consumes":[
+               "application/json"
+            ],
+            "produces":[
+               "application/json"
+            ],
+            "parameters":[
+               {
+                  "in":"body",
+                  "name":"repo",
+                  "description":"repo",
+                  "required":true,
+                  "schema":{
+                     "type":"string"
+                  }
+               }
+            ],
+            "responses":{
+               "200":{
+                  "description":"OK",
+                  "schema":{
+                     "type":"object"
+                  }
+               },
+               "201":{
+                  "description":"Repository added",
+                  "schema":{
+                     "type":"object"
+                  }
+               },
+               "401":{
+                  "description":"Unauthorized"
+               },
+               "403":{
+                  "description":"Forbidden"
+               },
+               "404":{
+                  "description":"Not Found"
+               }
+            }
+         }
+      },
+      "/onap/k8sparticipant/helm/uninstall/{name}/{version}":{
+         "delete":{
+            "tags":[
+               "k8s-participant"
+            ],
+            "summary":"Uninstall the Chart",
+            "operationId":"uninstallChartUsingDELETE",
+            "produces":[
+               "application/json"
+            ],
+            "parameters":[
+               {
+                  "name":"name",
+                  "in":"path",
+                  "description":"name",
+                  "required":true,
+                  "type":"string"
+               },
+               {
+                  "name":"version",
+                  "in":"path",
+                  "description":"version",
+                  "required":true,
+                  "type":"string"
+               }
+            ],
+            "responses":{
+               "200":{
+                  "description":"OK",
+                  "schema":{
+                     "type":"object"
+                  }
+               },
+               "201":{
+                  "description":"chart Uninstalled",
+                  "schema":{
+                     "type":"object"
+                  }
+               },
+               "204":{
+                  "description":"No Content"
+               },
+               "401":{
+                  "description":"Unauthorized"
+               },
+               "403":{
+                  "description":"Forbidden"
+               }
+            }
+         }
+      }
+   },
+   "definitions":{
+      "ChartInfo":{
+         "type":"object",
+         "properties":{
+            "chartId":{
+               "$ref":"#/definitions/ToscaConceptIdentifier",
+               "originalRef":"ToscaConceptIdentifier"
+            },
+            "namespace":{
+               "type":"string"
+            },
+            "overrideParams":{
+               "type":"object",
+               "additionalProperties":{
+                  "type":"string"
+               }
+            },
+            "releaseName":{
+               "type":"string"
+            },
+            "repository":{
+               "$ref":"#/definitions/HelmRepository",
+               "originalRef":"HelmRepository"
+            }
+         },
+         "title":"ChartInfo"
+      },
+      "ChartList":{
+         "type":"object",
+         "properties":{
+            "charts":{
+               "type":"array",
+               "items":{
+                  "$ref":"#/definitions/ChartInfo",
+                  "originalRef":"ChartInfo"
+               }
+            }
+         },
+         "title":"ChartList"
+      },
+      "HelmRepository":{
+         "type":"object",
+         "properties":{
+            "address":{
+               "type":"string"
+            },
+            "password":{
+               "type":"string"
+            },
+            "port":{
+               "type":"string"
+            },
+            "protocol":{
+               "type":"string"
+            },
+            "repoName":{
+               "type":"string"
+            },
+            "userName":{
+               "type":"string"
+            }
+         },
+         "title":"HelmRepository"
+      },
+      "InstallationInfo":{
+         "type":"object",
+         "properties":{
+            "name":{
+               "type":"string"
+            },
+            "version":{
+               "type":"string"
+            }
+         },
+         "title":"InstallationInfo"
+      },
+      "ToscaConceptIdentifier":{
+         "type":"object",
+         "properties":{
+            "name":{
+               "type":"string"
+            },
+            "version":{
+               "type":"string"
+            }
+         },
+         "title":"ToscaConceptIdentifier"
+      }
+   }
+}