X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fswagger%2Fswagger.json;h=d8a9ddca597476e73a8713bccd6bb4d0a6659e89;hb=afac3121bfacc4d81903b1d8492613b0b77d3298;hp=d9a0b82795a398ba509d46e2b2577d41d0dbe218;hpb=897a3e004a858ef68d989dad15dde91a69e151a5;p=clamp.git diff --git a/docs/swagger/swagger.json b/docs/swagger/swagger.json index d9a0b827..d8a9ddca 100644 --- a/docs/swagger/swagger.json +++ b/docs/swagger/swagger.json @@ -4,13 +4,29 @@ "version" : "5.0.0-SNAPSHOT", "title" : "Clamp Rest API" }, - "host" : "localhost:39099", + "host" : "localhost:42393", "basePath" : "/restservices/clds/", "schemes" : [ "http" ], "paths" : { + "/v2/clampInformation" : { + "get" : { + "operationId" : "route112", + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "Output type", + "schema" : { + "$ref" : "#/definitions/ClampInformation" + } + } + }, + "x-camelContextId" : "camel-3", + "x-routeId" : "route112" + } + }, "/v2/dictionary" : { "get" : { - "operationId" : "route49", + "operationId" : "route98", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -20,11 +36,11 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route49" + "x-camelContextId" : "camel-3", + "x-routeId" : "route98" }, "put" : { - "operationId" : "route51", + "operationId" : "route100", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -43,8 +59,8 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route51" + "x-camelContextId" : "camel-3", + "x-routeId" : "route100" } }, "/v2/dictionary/{dictionaryName}" : { @@ -64,7 +80,7 @@ } } }, - "x-camelContextId" : "camel-2", + "x-camelContextId" : "camel-3", "x-routeId" : null } }, @@ -93,11 +109,11 @@ } } }, - "x-camelContextId" : "camel-2", + "x-camelContextId" : "camel-3", "x-routeId" : null }, "delete" : { - "operationId" : "route53", + "operationId" : "route102", "produces" : [ "application/json" ], "parameters" : [ { "name" : "name", @@ -108,8 +124,8 @@ "responses" : { "200" : { } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route53" + "x-camelContextId" : "camel-3", + "x-routeId" : "route102" } }, "/v2/dictionary/{name}/elements/{shortName}" : { @@ -129,7 +145,7 @@ "responses" : { "200" : { } }, - "x-camelContextId" : "camel-2", + "x-camelContextId" : "camel-3", "x-routeId" : null } }, @@ -147,19 +163,74 @@ } } }, - "x-camelContextId" : "camel-2", + "x-camelContextId" : "camel-3", "x-routeId" : null } }, "/v2/loop/{loopName}" : { "get" : { - "operationId" : "route34", + "operationId" : "route79", + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "loopName", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "Output type", + "schema" : { + "$ref" : "#/definitions/Loop" + } + } + }, + "x-camelContextId" : "camel-3", + "x-routeId" : "route79" + } + }, + "/v2/loop/addOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}" : { + "put" : { + "operationId" : "route93", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" + }, { + "name" : "policyType", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "policyVersion", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "Output type", + "schema" : { + "$ref" : "#/definitions/Loop" + } + } + }, + "x-camelContextId" : "camel-3", + "x-routeId" : "route93" + } + }, + "/v2/loop/create/{loopName}?templateName={templateName}" : { + "post" : { + "operationId" : "route95", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "loopName}?templateName={templateName", + "in" : "path", + "required" : true, + "type" : "string" } ], "responses" : { "200" : { @@ -169,13 +240,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route34" + "x-camelContextId" : "camel-3", + "x-routeId" : "route95" } }, "/v2/loop/delete/{loopName}" : { "put" : { - "operationId" : "route45", + "operationId" : "route91", "parameters" : [ { "name" : "loopName", "in" : "path", @@ -185,13 +256,13 @@ "responses" : { "200" : { } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route45" + "x-camelContextId" : "camel-3", + "x-routeId" : "route91" } }, "/v2/loop/deploy/{loopName}" : { "put" : { - "operationId" : "route39", + "operationId" : "route84", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -207,13 +278,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route39" + "x-camelContextId" : "camel-3", + "x-routeId" : "route84" } }, "/v2/loop/getAllNames" : { "get" : { - "operationId" : "route33", + "operationId" : "route78", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -226,13 +297,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route33" + "x-camelContextId" : "camel-3", + "x-routeId" : "route78" } }, "/v2/loop/getstatus/{loopName}" : { "get" : { - "operationId" : "route46", + "operationId" : "route92", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -248,19 +319,51 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route46" + "x-camelContextId" : "camel-3", + "x-routeId" : "route92" + } + }, + "/v2/loop/refreshMicroServicePolicyJsonSchema/{loopName}/{microServicePolicyName}" : { + "put" : { + "operationId" : "route85", + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "loopName", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "microServicePolicyName", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "Output type", + "schema" : { + "$ref" : "#/definitions/Loop" + } + } + }, + "x-camelContextId" : "camel-3", + "x-routeId" : "route85" } }, - "/v2/loop/refreshOpPolicyJsonSchema/{loopName}" : { + "/v2/loop/refreshOperationalPolicyJsonSchema/{loopName}/{operationalPolicyName}" : { "put" : { - "operationId" : "route40", + "operationId" : "route86", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" + }, { + "name" : "operationalPolicyName", + "in" : "path", + "required" : true, + "type" : "string" } ], "responses" : { "200" : { @@ -270,13 +373,45 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route40" + "x-camelContextId" : "camel-3", + "x-routeId" : "route86" + } + }, + "/v2/loop/removeOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}" : { + "put" : { + "operationId" : "route94", + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "loopName", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "policyType", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "policyVersion", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "Output type", + "schema" : { + "$ref" : "#/definitions/Loop" + } + } + }, + "x-camelContextId" : "camel-3", + "x-routeId" : "route94" } }, "/v2/loop/restart/{loopName}" : { "put" : { - "operationId" : "route43", + "operationId" : "route89", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -292,13 +427,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route43" + "x-camelContextId" : "camel-3", + "x-routeId" : "route89" } }, "/v2/loop/stop/{loopName}" : { "put" : { - "operationId" : "route42", + "operationId" : "route88", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -314,13 +449,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route42" + "x-camelContextId" : "camel-3", + "x-routeId" : "route88" } }, "/v2/loop/submit/{loopName}" : { "put" : { - "operationId" : "route44", + "operationId" : "route90", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -336,13 +471,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route44" + "x-camelContextId" : "camel-3", + "x-routeId" : "route90" } }, "/v2/loop/svgRepresentation/{loopName}" : { "get" : { - "operationId" : "route35", + "operationId" : "route80", "produces" : [ "application/xml" ], "parameters" : [ { "name" : "loopName", @@ -358,13 +493,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route35" + "x-camelContextId" : "camel-3", + "x-routeId" : "route80" } }, "/v2/loop/undeploy/{loopName}" : { "put" : { - "operationId" : "route41", + "operationId" : "route87", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -380,13 +515,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route41" + "x-camelContextId" : "camel-3", + "x-routeId" : "route87" } }, "/v2/loop/updateGlobalProperties/{loopName}" : { "post" : { - "operationId" : "route36", + "operationId" : "route81", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -410,13 +545,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route36" + "x-camelContextId" : "camel-3", + "x-routeId" : "route81" } }, "/v2/loop/updateMicroservicePolicy/{loopName}" : { "post" : { - "operationId" : "route38", + "operationId" : "route83", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -440,13 +575,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route38" + "x-camelContextId" : "camel-3", + "x-routeId" : "route83" } }, "/v2/loop/updateOperationalPolicies/{loopName}" : { "post" : { - "operationId" : "route37", + "operationId" : "route82", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -470,13 +605,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route37" + "x-camelContextId" : "camel-3", + "x-routeId" : "route82" } }, "/v2/policyToscaModels" : { "get" : { - "operationId" : "route56", + "operationId" : "route105", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -486,11 +621,34 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route56" + "x-camelContextId" : "camel-3", + "x-routeId" : "route105" + }, + "post" : { + "operationId" : "route106", + "consumes" : [ "plain/text" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Output type", + "schema" : { + "$ref" : "#/definitions/PolicyModel" + } + } + }, + "x-camelContextId" : "camel-3", + "x-routeId" : "route106" } }, - "/v2/policyToscaModels/{policyModelType}" : { + "/v2/policyToscaModels/{policyModelType}/{policyModelVersion}" : { "get" : { "produces" : [ "application/json" ], "parameters" : [ { @@ -498,6 +656,11 @@ "in" : "path", "required" : true, "type" : "string" + }, { + "name" : "policyModelVersion", + "in" : "path", + "required" : true, + "type" : "string" } ], "responses" : { "200" : { @@ -507,11 +670,11 @@ } } }, - "x-camelContextId" : "camel-2", + "x-camelContextId" : "camel-3", "x-routeId" : null }, "put" : { - "operationId" : "route57", + "operationId" : "route107", "consumes" : [ "plain/text" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -519,6 +682,11 @@ "in" : "path", "required" : true, "type" : "string" + }, { + "name" : "policyModelVersion", + "in" : "path", + "required" : true, + "type" : "string" }, { "in" : "body", "name" : "body", @@ -535,11 +703,11 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route57" + "x-camelContextId" : "camel-3", + "x-routeId" : "route107" } }, - "/v2/policyToscaModels/yaml/{policyModelType}" : { + "/v2/policyToscaModels/yaml/{policyModelType}/{policyModelVersion}" : { "get" : { "produces" : [ "application/json" ], "parameters" : [ { @@ -547,6 +715,11 @@ "in" : "path", "required" : true, "type" : "string" + }, { + "name" : "policyModelVersion", + "in" : "path", + "required" : true, + "type" : "string" } ], "responses" : { "200" : { @@ -556,13 +729,13 @@ } } }, - "x-camelContextId" : "camel-2", + "x-camelContextId" : "camel-3", "x-routeId" : null } }, "/v2/templates" : { "get" : { - "operationId" : "route60", + "operationId" : "route111", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -572,8 +745,8 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route60" + "x-camelContextId" : "camel-3", + "x-routeId" : "route111" } }, "/v2/templates/{templateName}" : { @@ -593,7 +766,28 @@ } } }, - "x-camelContextId" : "camel-2", + "x-camelContextId" : "camel-3", + "x-routeId" : null + } + }, + "/v2/templates/{templateName}/svgRepresentation" : { + "get" : { + "produces" : [ "application/xml" ], + "parameters" : [ { + "name" : "templateName", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "Output type", + "schema" : { + "type" : "string" + } + } + }, + "x-camelContextId" : "camel-3", "x-routeId" : null } }, @@ -611,13 +805,13 @@ } } }, - "x-camelContextId" : "camel-2", + "x-camelContextId" : "camel-3", "x-routeId" : null } }, "/v1/healthcheck" : { "get" : { - "operationId" : "route61", + "operationId" : "route113", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -627,23 +821,44 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route61" + "x-camelContextId" : "camel-3", + "x-routeId" : "route113" } }, "/v1/user/getUser" : { "get" : { - "operationId" : "route62", + "operationId" : "route114", "produces" : [ "text/plain" ], "responses" : { "200" : { } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route62" + "x-camelContextId" : "camel-3", + "x-routeId" : "route114" } } }, "definitions" : { + "ClampInformation" : { + "type" : "object", + "properties" : { + "userName" : { + "type" : "string" + }, + "cldsVersion" : { + "type" : "string" + }, + "allPermissions" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, + "x-className" : { + "type" : "string", + "format" : "org.onap.clamp.clds.model.ClampInformation" + } + }, "Dictionary" : { "type" : "object", "properties" : { @@ -803,30 +1018,22 @@ "JsonPrimitive" : { "type" : "object", "properties" : { - "asInt" : { - "type" : "integer", - "format" : "int32" + "asBoolean" : { + "type" : "boolean" }, - "asDouble" : { - "type" : "number", - "format" : "double" + "number" : { + "type" : "boolean" + }, + "asString" : { + "type" : "string" }, "asLong" : { "type" : "integer", "format" : "int64" }, - "boolean" : { - "type" : "boolean" - }, - "asBoolean" : { - "type" : "boolean" - }, - "asNumber" : { - "$ref" : "#/definitions/Number" - }, - "asFloat" : { - "type" : "number", - "format" : "float" + "asInt" : { + "type" : "integer", + "format" : "int32" }, "asByte" : { "type" : "string", @@ -845,30 +1052,35 @@ "type" : "integer", "format" : "int32" }, - "number" : { - "type" : "boolean" - }, - "asString" : { - "type" : "string" + "asNumber" : { + "$ref" : "#/definitions/Number" }, - "string" : { - "type" : "boolean" + "asDouble" : { + "type" : "number", + "format" : "double" }, - "asJsonNull" : { - "$ref" : "#/definitions/JsonNull" + "asFloat" : { + "type" : "number", + "format" : "float" }, - "jsonObject" : { + "boolean" : { "type" : "boolean" }, - "asJsonObject" : { - "$ref" : "#/definitions/JsonObject" + "string" : { + "type" : "boolean" }, "asJsonArray" : { "$ref" : "#/definitions/JsonArray" }, + "asJsonObject" : { + "$ref" : "#/definitions/JsonObject" + }, "jsonArray" : { "type" : "boolean" }, + "jsonObject" : { + "type" : "boolean" + }, "jsonPrimitive" : { "type" : "boolean" }, @@ -877,6 +1089,9 @@ }, "asJsonPrimitive" : { "$ref" : "#/definitions/JsonPrimitive" + }, + "asJsonNull" : { + "$ref" : "#/definitions/JsonNull" } } }, @@ -909,7 +1124,7 @@ "pdpGroup" : { "type" : "string" }, - "pdpSubGroup" : { + "pdpSubgroup" : { "type" : "string" }, "policyModel" : { @@ -952,30 +1167,25 @@ "JsonObject" : { "type" : "object", "properties" : { - "asInt" : { - "type" : "integer", - "format" : "int32" + "asBoolean" : { + "type" : "boolean" }, - "asDouble" : { - "type" : "number", - "format" : "double" + "asJsonArray" : { + "$ref" : "#/definitions/JsonArray" + }, + "asJsonObject" : { + "$ref" : "#/definitions/JsonObject" + }, + "asString" : { + "type" : "string" }, "asLong" : { "type" : "integer", "format" : "int64" }, - "asBoolean" : { - "type" : "boolean" - }, - "asJsonNull" : { - "$ref" : "#/definitions/JsonNull" - }, - "asNumber" : { - "$ref" : "#/definitions/Number" - }, - "asFloat" : { - "type" : "number", - "format" : "float" + "asInt" : { + "type" : "integer", + "format" : "int32" }, "asByte" : { "type" : "string", @@ -994,19 +1204,10 @@ "type" : "integer", "format" : "int32" }, - "jsonObject" : { + "jsonArray" : { "type" : "boolean" }, - "asJsonObject" : { - "$ref" : "#/definitions/JsonObject" - }, - "asString" : { - "type" : "string" - }, - "asJsonArray" : { - "$ref" : "#/definitions/JsonArray" - }, - "jsonArray" : { + "jsonObject" : { "type" : "boolean" }, "jsonPrimitive" : { @@ -1017,6 +1218,20 @@ }, "asJsonPrimitive" : { "$ref" : "#/definitions/JsonPrimitive" + }, + "asJsonNull" : { + "$ref" : "#/definitions/JsonNull" + }, + "asNumber" : { + "$ref" : "#/definitions/Number" + }, + "asDouble" : { + "type" : "number", + "format" : "double" + }, + "asFloat" : { + "type" : "number", + "format" : "float" } }, "x-className" : { @@ -1133,7 +1348,7 @@ "pdpGroup" : { "type" : "string" }, - "pdpSubGroup" : { + "pdpSubgroup" : { "type" : "string" }, "policyModel" : { @@ -1153,30 +1368,25 @@ "JsonNull" : { "type" : "object", "properties" : { - "asInt" : { - "type" : "integer", - "format" : "int32" + "asBoolean" : { + "type" : "boolean" }, - "asDouble" : { - "type" : "number", - "format" : "double" + "asJsonArray" : { + "$ref" : "#/definitions/JsonArray" + }, + "asJsonObject" : { + "$ref" : "#/definitions/JsonObject" + }, + "asString" : { + "type" : "string" }, "asLong" : { "type" : "integer", "format" : "int64" }, - "asBoolean" : { - "type" : "boolean" - }, - "asJsonNull" : { - "$ref" : "#/definitions/JsonNull" - }, - "asNumber" : { - "$ref" : "#/definitions/Number" - }, - "asFloat" : { - "type" : "number", - "format" : "float" + "asInt" : { + "type" : "integer", + "format" : "int32" }, "asByte" : { "type" : "string", @@ -1195,19 +1405,10 @@ "type" : "integer", "format" : "int32" }, - "jsonObject" : { + "jsonArray" : { "type" : "boolean" }, - "asJsonObject" : { - "$ref" : "#/definitions/JsonObject" - }, - "asString" : { - "type" : "string" - }, - "asJsonArray" : { - "$ref" : "#/definitions/JsonArray" - }, - "jsonArray" : { + "jsonObject" : { "type" : "boolean" }, "jsonPrimitive" : { @@ -1218,33 +1419,39 @@ }, "asJsonPrimitive" : { "$ref" : "#/definitions/JsonPrimitive" + }, + "asJsonNull" : { + "$ref" : "#/definitions/JsonNull" + }, + "asNumber" : { + "$ref" : "#/definitions/Number" + }, + "asDouble" : { + "type" : "number", + "format" : "double" + }, + "asFloat" : { + "type" : "number", + "format" : "float" } } }, "JsonArray" : { "type" : "object", "properties" : { - "asInt" : { - "type" : "integer", - "format" : "int32" + "asBoolean" : { + "type" : "boolean" }, - "asDouble" : { - "type" : "number", - "format" : "double" + "asString" : { + "type" : "string" }, "asLong" : { "type" : "integer", "format" : "int64" }, - "asBoolean" : { - "type" : "boolean" - }, - "asNumber" : { - "$ref" : "#/definitions/Number" - }, - "asFloat" : { - "type" : "number", - "format" : "float" + "asInt" : { + "type" : "integer", + "format" : "int32" }, "asByte" : { "type" : "string", @@ -1263,24 +1470,29 @@ "type" : "integer", "format" : "int32" }, - "asString" : { - "type" : "string" - }, - "asJsonNull" : { - "$ref" : "#/definitions/JsonNull" + "asNumber" : { + "$ref" : "#/definitions/Number" }, - "jsonObject" : { - "type" : "boolean" + "asDouble" : { + "type" : "number", + "format" : "double" }, - "asJsonObject" : { - "$ref" : "#/definitions/JsonObject" + "asFloat" : { + "type" : "number", + "format" : "float" }, "asJsonArray" : { "$ref" : "#/definitions/JsonArray" }, + "asJsonObject" : { + "$ref" : "#/definitions/JsonObject" + }, "jsonArray" : { "type" : "boolean" }, + "jsonObject" : { + "type" : "boolean" + }, "jsonPrimitive" : { "type" : "boolean" }, @@ -1289,6 +1501,9 @@ }, "asJsonPrimitive" : { "$ref" : "#/definitions/JsonPrimitive" + }, + "asJsonNull" : { + "$ref" : "#/definitions/JsonNull" } }, "x-className" : {