{ "swagger" : "2.0", "info" : { "version" : "4.2.0-SNAPSHOT", "title" : "Clamp Rest API" }, "host" : "localhost:33953", "basePath" : "/restservices/clds/", "schemes" : [ "http" ], "paths" : { "/v2/loop/{loopName}" : { "get" : { "operationId" : "route20", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "Output type", "schema" : { "$ref" : "#/definitions/Loop" } } }, "x-camelContextId" : "camel-2", "x-routeId" : "route20" } }, "/v2/loop/delete/{loopName}" : { "put" : { "operationId" : "route30", "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { } }, "x-camelContextId" : "camel-2", "x-routeId" : "route30" } }, "/v2/loop/deploy/{loopName}" : { "put" : { "operationId" : "route25", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "Output type", "schema" : { "$ref" : "#/definitions/Loop" } } }, "x-camelContextId" : "camel-2", "x-routeId" : "route25" } }, "/v2/loop/getAllNames" : { "get" : { "operationId" : "route19", "produces" : [ "application/json" ], "responses" : { "200" : { "description" : "Output type", "schema" : { "type" : "array", "items" : { "type" : "string" } } } }, "x-camelContextId" : "camel-2", "x-routeId" : "route19" } }, "/v2/loop/getstatus/{loopName}" : { "get" : { "operationId" : "route31", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "Output type", "schema" : { "$ref" : "#/definitions/Loop" } } }, "x-camelContextId" : "camel-2", "x-routeId" : "route31" } }, "/v2/loop/restart/{loopName}" : { "put" : { "operationId" : "route28", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "Output type", "schema" : { "$ref" : "#/definitions/Loop" } } }, "x-camelContextId" : "camel-2", "x-routeId" : "route28" } }, "/v2/loop/stop/{loopName}" : { "put" : { "operationId" : "route27", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "Output type", "schema" : { "$ref" : "#/definitions/Loop" } } }, "x-camelContextId" : "camel-2", "x-routeId" : "route27" } }, "/v2/loop/submit/{loopName}" : { "put" : { "operationId" : "route29", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "Output type", "schema" : { "$ref" : "#/definitions/Loop" } } }, "x-camelContextId" : "camel-2", "x-routeId" : "route29" } }, "/v2/loop/svgRepresentation/{loopName}" : { "get" : { "operationId" : "route21", "produces" : [ "application/xml" ], "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "Output type", "schema" : { "type" : "string" } } }, "x-camelContextId" : "camel-2", "x-routeId" : "route21" } }, "/v2/loop/undeploy/{loopName}" : { "put" : { "operationId" : "route26", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "Output type", "schema" : { "$ref" : "#/definitions/Loop" } } }, "x-camelContextId" : "camel-2", "x-routeId" : "route26" } }, "/v2/loop/updateGlobalProperties/{loopName}" : { "post" : { "operationId" : "route22", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : true, "schema" : { "$ref" : "#/definitions/JsonObject" } } ], "responses" : { "200" : { "description" : "Output type", "schema" : { "$ref" : "#/definitions/Loop" } } }, "x-camelContextId" : "camel-2", "x-routeId" : "route22" } }, "/v2/loop/updateMicroservicePolicy/{loopName}" : { "post" : { "operationId" : "route24", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : true, "schema" : { "$ref" : "#/definitions/MicroServicePolicy" } } ], "responses" : { "200" : { "description" : "Output type", "schema" : { "$ref" : "#/definitions/MicroServicePolicy" } } }, "x-camelContextId" : "camel-2", "x-routeId" : "route24" } }, "/v2/loop/updateOperationalPolicies/{loopName}" : { "post" : { "operationId" : "route23", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : true, "schema" : { "$ref" : "#/definitions/JsonArray" } } ], "responses" : { "200" : { "description" : "Output type", "schema" : { "$ref" : "#/definitions/Loop" } } }, "x-camelContextId" : "camel-2", "x-routeId" : "route23" } }, "/v1/clds/cldsInfo" : { "get" : { "operationId" : "route32", "produces" : [ "application/json" ], "responses" : { "200" : { "description" : "Output type", "schema" : { "$ref" : "#/definitions/CldsInfo" } } }, "x-camelContextId" : "camel-2", "x-routeId" : "route32" } }, "/v1/healthcheck" : { "get" : { "operationId" : "route33", "produces" : [ "application/json" ], "responses" : { "200" : { "description" : "Output type", "schema" : { "$ref" : "#/definitions/CldsHealthCheck" } } }, "x-camelContextId" : "camel-2", "x-routeId" : "route33" } }, "/v1/user/getUser" : { "get" : { "operationId" : "route34", "produces" : [ "text/plain" ], "responses" : { "200" : { } }, "x-camelContextId" : "camel-2", "x-routeId" : "route34" } } }, "definitions" : { "Loop" : { "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "format" : "int64" }, "updatedDate" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "createdBy" : { "type" : "string" }, "name" : { "type" : "string" }, "dcaeDeploymentId" : { "type" : "string" }, "dcaeDeploymentStatusUrl" : { "type" : "string" }, "dcaeBlueprintId" : { "type" : "string" }, "svgRepresentation" : { "type" : "string" }, "globalPropertiesJson" : { "$ref" : "#/definitions/JsonObject" }, "modelService" : { "$ref" : "#/definitions/Service" }, "blueprint" : { "type" : "string" }, "lastComputedState" : { "type" : "string", "enum" : [ "DESIGN", "SUBMITTED", "DEPLOYED", "RUNNING", "STOPPED", "IN_ERROR", "WAITING" ] }, "components" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/ExternalComponent" } }, "operationalPolicies" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/OperationalPolicy" } }, "microServicePolicies" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/MicroServicePolicy" } }, "loopLogs" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/LoopLog" } }, "loopTemplate" : { "$ref" : "#/definitions/LoopTemplate" } }, "x-className" : { "type" : "string", "format" : "org.onap.clamp.loop.Loop" } }, "MicroServiceModel" : { "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "format" : "int64" }, "updatedDate" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "createdBy" : { "type" : "string" }, "name" : { "type" : "string" }, "policyType" : { "type" : "string" }, "blueprint" : { "type" : "string" }, "policyModel" : { "$ref" : "#/definitions/PolicyModel" }, "usedByLoopTemplates" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/TemplateMicroServiceModel" } } } }, "JsonPrimitive" : { "type" : "object", "properties" : { "asBoolean" : { "type" : "boolean" }, "boolean" : { "type" : "boolean" }, "number" : { "type" : "boolean" }, "asString" : { "type" : "string" }, "asNumber" : { "$ref" : "#/definitions/Number" }, "asDouble" : { "type" : "number", "format" : "double" }, "asFloat" : { "type" : "number", "format" : "float" }, "asLong" : { "type" : "integer", "format" : "int64" }, "asInt" : { "type" : "integer", "format" : "int32" }, "asByte" : { "type" : "string", "format" : "byte" }, "asCharacter" : { "type" : "string" }, "asBigDecimal" : { "type" : "number" }, "asBigInteger" : { "type" : "integer" }, "asShort" : { "type" : "integer", "format" : "int32" }, "string" : { "type" : "boolean" }, "asJsonObject" : { "$ref" : "#/definitions/JsonObject" }, "asJsonArray" : { "$ref" : "#/definitions/JsonArray" }, "asJsonPrimitive" : { "$ref" : "#/definitions/JsonPrimitive" }, "jsonArray" : { "type" : "boolean" }, "jsonObject" : { "type" : "boolean" }, "jsonPrimitive" : { "type" : "boolean" }, "jsonNull" : { "type" : "boolean" }, "asJsonNull" : { "$ref" : "#/definitions/JsonNull" } } }, "MicroServicePolicy" : { "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "format" : "int64" }, "updatedDate" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "createdBy" : { "type" : "string" }, "name" : { "type" : "string" }, "modelType" : { "type" : "string" }, "context" : { "type" : "string" }, "deviceTypeScope" : { "type" : "string" }, "properties" : { "$ref" : "#/definitions/JsonObject" }, "shared" : { "type" : "boolean" }, "policyTosca" : { "type" : "string" }, "jsonRepresentation" : { "$ref" : "#/definitions/JsonObject" }, "usedByLoops" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/Loop" } }, "microServiceModel" : { "$ref" : "#/definitions/MicroServiceModel" } }, "x-className" : { "type" : "string", "format" : "org.onap.clamp.policy.microservice.MicroServicePolicy" } }, "JsonObject" : { "type" : "object", "properties" : { "asBoolean" : { "type" : "boolean" }, "asJsonObject" : { "$ref" : "#/definitions/JsonObject" }, "asString" : { "type" : "string" }, "asJsonArray" : { "$ref" : "#/definitions/JsonArray" }, "asJsonPrimitive" : { "$ref" : "#/definitions/JsonPrimitive" }, "jsonArray" : { "type" : "boolean" }, "jsonObject" : { "type" : "boolean" }, "jsonPrimitive" : { "type" : "boolean" }, "jsonNull" : { "type" : "boolean" }, "asJsonNull" : { "$ref" : "#/definitions/JsonNull" }, "asNumber" : { "$ref" : "#/definitions/Number" }, "asDouble" : { "type" : "number", "format" : "double" }, "asFloat" : { "type" : "number", "format" : "float" }, "asLong" : { "type" : "integer", "format" : "int64" }, "asInt" : { "type" : "integer", "format" : "int32" }, "asByte" : { "type" : "string", "format" : "byte" }, "asCharacter" : { "type" : "string" }, "asBigDecimal" : { "type" : "number" }, "asBigInteger" : { "type" : "integer" }, "asShort" : { "type" : "integer", "format" : "int32" } }, "x-className" : { "type" : "string", "format" : "com.google.gson.JsonObject" } }, "PolicyModel" : { "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "format" : "int64" }, "updatedDate" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "createdBy" : { "type" : "string" }, "policyModelType" : { "type" : "string" }, "version" : { "type" : "string" }, "policyModelTosca" : { "type" : "string" }, "policyAcronym" : { "type" : "string" }, "policyVariant" : { "type" : "string" } } }, "Service" : { "type" : "object", "properties" : { "serviceUuid" : { "type" : "string" }, "serviceDetails" : { "$ref" : "#/definitions/JsonObject" }, "resourceDetails" : { "$ref" : "#/definitions/JsonObject" } } }, "OperationalPolicy" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "configurationsJson" : { "$ref" : "#/definitions/JsonObject" }, "loop" : { "$ref" : "#/definitions/Loop" }, "policyModel" : { "$ref" : "#/definitions/PolicyModel" }, "jsonRepresentation" : { "$ref" : "#/definitions/JsonObject" } } }, "JsonNull" : { "type" : "object", "properties" : { "asBoolean" : { "type" : "boolean" }, "asJsonObject" : { "$ref" : "#/definitions/JsonObject" }, "asString" : { "type" : "string" }, "asJsonArray" : { "$ref" : "#/definitions/JsonArray" }, "asJsonPrimitive" : { "$ref" : "#/definitions/JsonPrimitive" }, "jsonArray" : { "type" : "boolean" }, "jsonObject" : { "type" : "boolean" }, "jsonPrimitive" : { "type" : "boolean" }, "jsonNull" : { "type" : "boolean" }, "asJsonNull" : { "$ref" : "#/definitions/JsonNull" }, "asNumber" : { "$ref" : "#/definitions/Number" }, "asDouble" : { "type" : "number", "format" : "double" }, "asFloat" : { "type" : "number", "format" : "float" }, "asLong" : { "type" : "integer", "format" : "int64" }, "asInt" : { "type" : "integer", "format" : "int32" }, "asByte" : { "type" : "string", "format" : "byte" }, "asCharacter" : { "type" : "string" }, "asBigDecimal" : { "type" : "number" }, "asBigInteger" : { "type" : "integer" }, "asShort" : { "type" : "integer", "format" : "int32" } } }, "JsonArray" : { "type" : "object", "properties" : { "asBoolean" : { "type" : "boolean" }, "asString" : { "type" : "string" }, "asNumber" : { "$ref" : "#/definitions/Number" }, "asDouble" : { "type" : "number", "format" : "double" }, "asFloat" : { "type" : "number", "format" : "float" }, "asLong" : { "type" : "integer", "format" : "int64" }, "asInt" : { "type" : "integer", "format" : "int32" }, "asByte" : { "type" : "string", "format" : "byte" }, "asCharacter" : { "type" : "string" }, "asBigDecimal" : { "type" : "number" }, "asBigInteger" : { "type" : "integer" }, "asShort" : { "type" : "integer", "format" : "int32" }, "asJsonObject" : { "$ref" : "#/definitions/JsonObject" }, "asJsonArray" : { "$ref" : "#/definitions/JsonArray" }, "asJsonPrimitive" : { "$ref" : "#/definitions/JsonPrimitive" }, "jsonArray" : { "type" : "boolean" }, "jsonObject" : { "type" : "boolean" }, "jsonPrimitive" : { "type" : "boolean" }, "jsonNull" : { "type" : "boolean" }, "asJsonNull" : { "$ref" : "#/definitions/JsonNull" } }, "x-className" : { "type" : "string", "format" : "com.google.gson.JsonArray" } }, "LoopLog" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "logType" : { "type" : "string", "enum" : [ "INFO", "WARNING", "ERROR" ] }, "logComponent" : { "type" : "string" }, "message" : { "type" : "string" }, "loop" : { "$ref" : "#/definitions/Loop" }, "logInstant" : { "type" : "integer", "format" : "int64" } } }, "TemplateMicroServiceModel" : { "type" : "object", "properties" : { "loopTemplate" : { "$ref" : "#/definitions/LoopTemplate" }, "microServiceModel" : { "$ref" : "#/definitions/MicroServiceModel" }, "flowOrder" : { "type" : "integer", "format" : "int32" } } }, "Number" : { "type" : "object" }, "ExternalComponent" : { "type" : "object", "properties" : { "state" : { "$ref" : "#/definitions/ExternalComponentState" }, "componentName" : { "type" : "string" } } }, "LoopTemplate" : { "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "format" : "int64" }, "updatedDate" : { "type" : "integer", "format" : "int64" }, "updatedBy" : { "type" : "string" }, "createdBy" : { "type" : "string" }, "name" : { "type" : "string" }, "blueprint" : { "type" : "string" }, "svgRepresentation" : { "type" : "string" }, "microServiceModelUsed" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/TemplateMicroServiceModel" } }, "modelService" : { "$ref" : "#/definitions/Service" }, "maximumInstancesAllowed" : { "type" : "integer", "format" : "int32" } } }, "ExternalComponentState" : { "type" : "object", "properties" : { "stateName" : { "type" : "string" }, "description" : { "type" : "string" }, "level" : { "type" : "integer", "format" : "int32" } } }, "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" } }, "CldsHealthCheck" : { "type" : "object", "properties" : { "healthCheckComponent" : { "type" : "string" }, "healthCheckStatus" : { "type" : "string" }, "description" : { "type" : "string" } }, "x-className" : { "type" : "string", "format" : "org.onap.clamp.clds.model.CldsHealthCheck" } } } }