docs/swagger/swagger.json

{
  "swagger" : "2.0",
  "info" : {
    "version" : "4.0.0-SNAPSHOT",
    "title" : "Clamp Rest API"
  },
  "host" : "0.0.0.0",
  "basePath" : "/restservices/clds/v1/",
  "schemes" : [ "http" ],
  "paths" : {
    "/clds/action/{action}/{modelName}?test={test}" : {
      "put" : {
        "operationId" : "route66",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "action",
          "in" : "path",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "modelName}?test={test",
          "in" : "path",
          "required" : true,
          "type" : "string"
        }, {
          "in" : "body",
          "name" : "body",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/CldsModel"
          }
        } ],
        "responses" : {
          "200" : { }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route66"
      }
    },
    "/clds/cldsDetails" : {
      "get" : {
        "operationId" : "route58",
        "produces" : [ "application/json" ],
        "responses" : {
          "200" : {
            "description" : "Output type",
            "responseSchema" : {
              "$ref" : "#/definitions/CldsMonitoringDetails"
            },
            "schema" : {
              "$ref" : "#/definitions/CldsMonitoringDetails"
            }
          }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route58"
      }
    },
    "/clds/cldsInfo" : {
      "get" : {
        "operationId" : "route59",
        "produces" : [ "application/json" ],
        "responses" : {
          "200" : {
            "description" : "Output type",
            "responseSchema" : {
              "$ref" : "#/definitions/CldsInfo"
            },
            "schema" : {
              "$ref" : "#/definitions/CldsInfo"
            }
          }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route59"
      }
    },
    "/clds/dcae/event?test={test}" : {
      "post" : {
        "operationId" : "route67",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "body",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/DcaeEvent"
          }
        } ],
        "responses" : {
          "200" : { }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route67"
      }
    },
    "/clds/deploy/{modelName}" : {
      "put" : {
        "operationId" : "route69",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "modelName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        }, {
          "in" : "body",
          "name" : "body",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/CldsModel"
          }
        } ],
        "responses" : {
          "200" : { }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route69"
      }
    },
    "/clds/model-names" : {
      "get" : {
        "operationId" : "route65",
        "produces" : [ "application/json" ],
        "responses" : {
          "200" : {
            "description" : "Output type",
            "responseSchema" : {
              "$ref" : "#/definitions/ValueItem"
            },
            "schema" : {
              "$ref" : "#/definitions/ValueItem"
            }
          }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route65"
      }
    },
    "/clds/model/{modelName}" : {
      "get" : {
        "operationId" : "route63",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "modelName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "Output type",
            "responseSchema" : {
              "$ref" : "#/definitions/CldsModel"
            },
            "schema" : {
              "$ref" : "#/definitions/CldsModel"
            }
          }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route63"
      },
      "put" : {
        "operationId" : "route64",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "modelName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        }, {
          "in" : "body",
          "name" : "body",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/CldsModel"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Output type",
            "responseSchema" : {
              "$ref" : "#/definitions/CldsModel"
            },
            "schema" : {
              "$ref" : "#/definitions/CldsModel"
            }
          }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route64"
      }
    },
    "/clds/model/bpmn/{modelName}" : {
      "get" : {
        "operationId" : "route61",
        "produces" : [ "text/xml" ],
        "parameters" : [ {
          "name" : "modelName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : { }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route61"
      }
    },
    "/clds/model/image/{modelName}" : {
      "get" : {
        "operationId" : "route62",
        "produces" : [ "text/xml" ],
        "parameters" : [ {
          "name" : "modelName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : { }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route62"
      }
    },
    "/clds/properties" : {
      "get" : {
        "operationId" : "route68",
        "produces" : [ "application/json" ],
        "responses" : {
          "200" : { }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route68"
      }
    },
    "/clds/undeploy/{modelName}" : {
      "put" : {
        "operationId" : "route70",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "modelName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        }, {
          "in" : "body",
          "name" : "body",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/CldsModel"
          }
        } ],
        "responses" : {
          "200" : { }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route70"
      }
    },
    "/cldsTempate/template-names" : {
      "get" : {
        "operationId" : "route75",
        "produces" : [ "application/json" ],
        "responses" : {
          "200" : {
            "description" : "Output type",
            "responseSchema" : {
              "$ref" : "#/definitions/ValueItem"
            },
            "schema" : {
              "$ref" : "#/definitions/ValueItem"
            }
          }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route75"
      }
    },
    "/cldsTempate/template/{templateName}" : {
      "get" : {
        "operationId" : "route73",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "templateName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "Output type",
            "responseSchema" : {
              "$ref" : "#/definitions/CldsTemplate"
            },
            "schema" : {
              "$ref" : "#/definitions/CldsTemplate"
            }
          }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route73"
      },
      "put" : {
        "operationId" : "route74",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "templateName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        }, {
          "in" : "body",
          "name" : "body",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/CldsTemplate"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Output type",
            "responseSchema" : {
              "$ref" : "#/definitions/CldsTemplate"
            },
            "schema" : {
              "$ref" : "#/definitions/CldsTemplate"
            }
          }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route74"
      }
    },
    "/cldsTempate/template/bpmn/{templateName}" : {
      "get" : {
        "operationId" : "route71",
        "produces" : [ "text/xml" ],
        "parameters" : [ {
          "name" : "templateName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : { }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route71"
      }
    },
    "/cldsTempate/template/image/{templateName}" : {
      "get" : {
        "operationId" : "route72",
        "produces" : [ "text/xml" ],
        "parameters" : [ {
          "name" : "templateName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : { }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route72"
      }
    },
    "/dictionary" : {
      "get" : {
        "operationId" : "route81",
        "produces" : [ "application/json" ],
        "responses" : {
          "200" : {
            "description" : "Output type",
            "responseSchema" : {
              "$ref" : "#/definitions/CldsDictionary"
            },
            "schema" : {
              "$ref" : "#/definitions/CldsDictionary"
            }
          }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route81"
      }
    },
    "/dictionary/{dictionaryName}" : {
      "put" : {
        "operationId" : "route80",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "dictionaryName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        }, {
          "in" : "body",
          "name" : "body",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/CldsDictionary"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Output type",
            "responseSchema" : {
              "$ref" : "#/definitions/CldsDictionary"
            },
            "schema" : {
              "$ref" : "#/definitions/CldsDictionary"
            }
          }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route80"
      }
    },
    "/dictionary/{dictionaryName}/items" : {
      "get" : {
        "operationId" : "route83",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "dictionaryName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "Output type",
            "responseSchema" : {
              "$ref" : "#/definitions/CldsDictionary"
            },
            "schema" : {
              "$ref" : "#/definitions/CldsDictionary"
            }
          }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route83"
      },
      "put" : {
        "operationId" : "route82",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "dictionaryName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        }, {
          "in" : "body",
          "name" : "body",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/CldsDictionaryItem"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Output type",
            "responseSchema" : {
              "$ref" : "#/definitions/CldsDictionaryItem"
            },
            "schema" : {
              "$ref" : "#/definitions/CldsDictionaryItem"
            }
          }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route82"
      }
    },
    "/healthcheck" : {
      "get" : {
        "operationId" : "route60",
        "produces" : [ "application/json" ],
        "responses" : {
          "200" : { }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route60"
      }
    },
    "/tosca/models" : {
      "get" : {
        "operationId" : "route78",
        "produces" : [ "application/json" ],
        "responses" : {
          "200" : {
            "description" : "Output type",
            "responseSchema" : {
              "$ref" : "#/definitions/CldsToscaModel"
            },
            "schema" : {
              "$ref" : "#/definitions/CldsToscaModel"
            }
          }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route78"
      }
    },
    "/tosca/models/{toscaModelName}" : {
      "get" : {
        "operationId" : "route79",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "toscaModelName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "Output type",
            "responseSchema" : {
              "$ref" : "#/definitions/CldsToscaModel"
            },
            "schema" : {
              "$ref" : "#/definitions/CldsToscaModel"
            }
          }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route79"
      },
      "put" : {
        "operationId" : "route76",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "toscaModelName",
          "in" : "path",
          "required" : true,
          "type" : "string"
        }, {
          "in" : "body",
          "name" : "body",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/CldsToscaModel"
          }
        } ],
        "responses" : {
          "200" : { }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route76"
      }
    },
    "/tosca/models/policyType/{policyType}" : {
      "get" : {
        "operationId" : "route77",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "policyType",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : { }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route77"
      }
    },
    "/user/getUser" : {
      "get" : {
        "operationId" : "route84",
        "produces" : [ "text/plain" ],
        "responses" : {
          "200" : { }
        },
        "x-camelContextId" : "camel-3",
        "x-routeId" : "route84"
      }
    }
  },
  "definitions" : {
    "CldsModelInstance" : {
      "type" : "object",
      "properties" : {
        "modelInstanceId" : {
          "type" : "string"
        },
        "location" : {
          "type" : "string"
        },
        "vmName" : {
          "type" : "string"
        }
      }
    },
    "CldsModel" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "templateId" : {
          "type" : "string"
        },
        "templateName" : {
          "type" : "string"
        },
        "name" : {
          "type" : "string"
        },
        "controlNamePrefix" : {
          "type" : "string"
        },
        "controlNameUuid" : {
          "type" : "string"
        },
        "bpmnText" : {
          "type" : "string"
        },
        "propText" : {
          "type" : "string"
        },
        "imageText" : {
          "type" : "string"
        },
        "docText" : {
          "type" : "string"
        },
        "blueprintText" : {
          "type" : "string"
        },
        "event" : {
          "$ref" : "#/definitions/CldsEvent"
        },
        "status" : {
          "type" : "string"
        },
        "permittedActionCd" : {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        },
        "cldsModelInstanceList" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/CldsModelInstance"
          }
        },
        "errorMessageForUi" : {
          "type" : "string"
        },
        "typeId" : {
          "type" : "string"
        },
        "typeName" : {
          "type" : "string"
        },
        "deploymentId" : {
          "type" : "string"
        },
        "deploymentStatusUrl" : {
          "type" : "string"
        },
        "controlName" : {
          "type" : "string"
        }
      },
      "x-className" : {
        "type" : "string",
        "format" : "org.onap.clamp.clds.model.CldsModel"
      }
    },
    "CldsEvent" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "actionCd" : {
          "type" : "string"
        },
        "actionStateCd" : {
          "type" : "string"
        },
        "processInstanceId" : {
          "type" : "string"
        },
        "userid" : {
          "type" : "string"
        }
      }
    },
    "CldsMonitoringDetails" : {
      "type" : "object",
      "properties" : {
        "closeloopName" : {
          "type" : "string"
        },
        "modelId" : {
          "type" : "string"
        },
        "modelName" : {
          "type" : "string"
        },
        "serviceTypeId" : {
          "type" : "string"
        },
        "deploymentId" : {
          "type" : "string"
        },
        "templateName" : {
          "type" : "string"
        },
        "action" : {
          "type" : "string"
        },
        "userid" : {
          "type" : "string"
        },
        "timestamp" : {
          "type" : "string"
        }
      },
      "x-className" : {
        "type" : "string",
        "format" : "org.onap.clamp.clds.model.CldsMonitoringDetails"
      }
    },
    "CldsInfo" : {
      "type" : "object",
      "properties" : {
        "userName" : {
          "type" : "string"
        },
        "cldsVersion" : {
          "type" : "string"
        },
        "permissionReadCl" : {
          "type" : "boolean"
        },
        "permissionUpdateCl" : {
          "type" : "boolean"
        },
        "permissionReadTemplate" : {
          "type" : "boolean"
        },
        "permissionUpdateTemplate" : {
          "type" : "boolean"
        },
        "permissionReadTosca" : {
          "type" : "boolean"
        },
        "permissionUpdateTosca" : {
          "type" : "boolean"
        }
      },
      "x-className" : {
        "type" : "string",
        "format" : "org.onap.clamp.clds.model.CldsInfo"
      }
    },
    "DcaeEvent" : {
      "type" : "object",
      "properties" : {
        "event" : {
          "type" : "string"
        },
        "serviceUUID" : {
          "type" : "string"
        },
        "resourceUUID" : {
          "type" : "string"
        },
        "artifactName" : {
          "type" : "string"
        },
        "instances" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/CldsModelInstance"
          }
        },
        "controlName" : {
          "type" : "string"
        },
        "cldsActionCd" : {
          "type" : "string"
        }
      },
      "x-className" : {
        "type" : "string",
        "format" : "org.onap.clamp.clds.model.DcaeEvent"
      }
    },
    "ValueItem" : {
      "type" : "object",
      "properties" : {
        "value" : {
          "type" : "string"
        }
      },
      "x-className" : {
        "type" : "string",
        "format" : "org.onap.clamp.clds.model.ValueItem"
      }
    },
    "CldsTemplate" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "name" : {
          "type" : "string"
        },
        "controlNamePrefix" : {
          "type" : "string"
        },
        "controlNameUuid" : {
          "type" : "string"
        },
        "bpmnId" : {
          "type" : "string"
        },
        "bpmnUserid" : {
          "type" : "string"
        },
        "bpmnText" : {
          "type" : "string"
        },
        "imageId" : {
          "type" : "string"
        },
        "imageUserid" : {
          "type" : "string"
        },
        "imageText" : {
          "type" : "string"
        },
        "propId" : {
          "type" : "string"
        },
        "propUserid" : {
          "type" : "string"
        },
        "propText" : {
          "type" : "string"
        },
        "userAuthorizedToUpdate" : {
          "type" : "boolean"
        }
      },
      "x-className" : {
        "type" : "string",
        "format" : "org.onap.clamp.clds.model.CldsTemplate"
      }
    },
    "CldsDictionary" : {
      "type" : "object",
      "properties" : {
        "dictionaryId" : {
          "type" : "string"
        },
        "dictionaryName" : {
          "type" : "string"
        },
        "createdBy" : {
          "type" : "string"
        },
        "updatedBy" : {
          "type" : "string"
        },
        "lastUpdatedDate" : {
          "type" : "string"
        },
        "cldsDictionaryItems" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/CldsDictionaryItem"
          }
        }
      },
      "x-className" : {
        "type" : "string",
        "format" : "org.onap.clamp.clds.model.CldsDictionary"
      }
    },
    "CldsDictionaryItem" : {
      "type" : "object",
      "properties" : {
        "dictElementId" : {
          "type" : "string"
        },
        "dictionaryId" : {
          "type" : "string"
        },
        "dictElementName" : {
          "type" : "string"
        },
        "dictElementShortName" : {
          "type" : "string"
        },
        "dictElementDesc" : {
          "type" : "string"
        },
        "dictElementType" : {
          "type" : "string"
        },
        "createdBy" : {
          "type" : "string"
        },
        "updatedBy" : {
          "type" : "string"
        },
        "lastUpdatedDate" : {
          "type" : "string"
        }
      },
      "x-className" : {
        "type" : "string",
        "format" : "org.onap.clamp.clds.model.CldsDictionaryItem"
      }
    },
    "CldsToscaModel" : {
      "type" : "object",
      "properties" : {
        "revisionId" : {
          "type" : "string"
        },
        "toscaModelYaml" : {
          "type" : "string"
        },
        "version" : {
          "type" : "number",
          "format" : "double"
        },
        "toscaModelJson" : {
          "type" : "string"
        },
        "userId" : {
          "type" : "string"
        },
        "createdDate" : {
          "type" : "string"
        },
        "lastUpdatedDate" : {
          "type" : "string"
        },
        "id" : {
          "type" : "string"
        },
        "policyType" : {
          "type" : "string"
        },
        "toscaModelName" : {
          "type" : "string"
        }
      },
      "x-className" : {
        "type" : "string",
        "format" : "org.onap.clamp.clds.model.CldsToscaModel"
      }
    }
  }
}