X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fswagger%2Fswagger.json;h=30155353c3d8bfd7cff43d47e71a8332a4501bab;hb=580141f7cf72d4a120722fc7b870dfc5c3017ced;hp=5307c1545f2e51fb00adaf6dfea43af46e2c4eda;hpb=e0d0fdb5484d2c02669358160a11d6751ada4f3a;p=clamp.git diff --git a/docs/swagger/swagger.json b/docs/swagger/swagger.json index 5307c154..30155353 100644 --- a/docs/swagger/swagger.json +++ b/docs/swagger/swagger.json @@ -1,16 +1,32 @@ { "swagger" : "2.0", "info" : { - "version" : "5.0.0-SNAPSHOT", + "version" : "5.0.2-SNAPSHOT", "title" : "Clamp Rest API" }, - "host" : "localhost:32977", + "host" : "localhost:34889", "basePath" : "/restservices/clds/", "schemes" : [ "http" ], "paths" : { + "/v2/clampInformation" : { + "get" : { + "operationId" : "route74", + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "Output type", + "schema" : { + "$ref" : "#/definitions/ClampInformation" + } + } + }, + "x-camelContextId" : "camel-2", + "x-routeId" : "route74" + } + }, "/v2/dictionary" : { "get" : { - "operationId" : "route111", + "operationId" : "route58", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -20,11 +36,11 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route111" + "x-camelContextId" : "camel-2", + "x-routeId" : "route58" }, "put" : { - "operationId" : "route113", + "operationId" : "route61", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -43,12 +59,13 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route113" + "x-camelContextId" : "camel-2", + "x-routeId" : "route61" } }, "/v2/dictionary/{dictionaryName}" : { "get" : { + "operationId" : "route60", "produces" : [ "application/json" ], "parameters" : [ { "name" : "dictionaryName", @@ -64,12 +81,13 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : null + "x-camelContextId" : "camel-2", + "x-routeId" : "route60" } }, "/v2/dictionary/{name}" : { "put" : { + "operationId" : "route62", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -93,11 +111,11 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : null + "x-camelContextId" : "camel-2", + "x-routeId" : "route62" }, "delete" : { - "operationId" : "route115", + "operationId" : "route63", "produces" : [ "application/json" ], "parameters" : [ { "name" : "name", @@ -108,12 +126,13 @@ "responses" : { "200" : { } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route115" + "x-camelContextId" : "camel-2", + "x-routeId" : "route63" } }, "/v2/dictionary/{name}/elements/{shortName}" : { "delete" : { + "operationId" : "route64", "produces" : [ "application/json" ], "parameters" : [ { "name" : "name", @@ -129,12 +148,13 @@ "responses" : { "200" : { } }, - "x-camelContextId" : "camel-4", - "x-routeId" : null + "x-camelContextId" : "camel-2", + "x-routeId" : "route64" } }, "/v2/dictionary/secondary/names" : { "get" : { + "operationId" : "route59", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -147,13 +167,13 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : null + "x-camelContextId" : "camel-2", + "x-routeId" : "route59" } }, "/v2/loop/{loopName}" : { "get" : { - "operationId" : "route96", + "operationId" : "route41", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -169,13 +189,68 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route96" + "x-camelContextId" : "camel-2", + "x-routeId" : "route41" + } + }, + "/v2/loop/addOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}" : { + "put" : { + "operationId" : "route55", + "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-2", + "x-routeId" : "route55" + } + }, + "/v2/loop/create/{loopName}?templateName={templateName}" : { + "post" : { + "operationId" : "route57", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "loopName}?templateName={templateName", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "Output type", + "schema" : { + "$ref" : "#/definitions/Loop" + } + } + }, + "x-camelContextId" : "camel-2", + "x-routeId" : "route57" } }, "/v2/loop/delete/{loopName}" : { "put" : { - "operationId" : "route107", + "operationId" : "route53", "parameters" : [ { "name" : "loopName", "in" : "path", @@ -185,13 +260,13 @@ "responses" : { "200" : { } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route107" + "x-camelContextId" : "camel-2", + "x-routeId" : "route53" } }, "/v2/loop/deploy/{loopName}" : { "put" : { - "operationId" : "route101", + "operationId" : "route46", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -207,13 +282,13 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route101" + "x-camelContextId" : "camel-2", + "x-routeId" : "route46" } }, "/v2/loop/getAllNames" : { "get" : { - "operationId" : "route95", + "operationId" : "route40", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -226,13 +301,13 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route95" + "x-camelContextId" : "camel-2", + "x-routeId" : "route40" } }, "/v2/loop/getstatus/{loopName}" : { "get" : { - "operationId" : "route108", + "operationId" : "route54", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -248,19 +323,24 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route108" + "x-camelContextId" : "camel-2", + "x-routeId" : "route54" } }, - "/v2/loop/refreshOpPolicyJsonSchema/{loopName}" : { + "/v2/loop/refreshMicroServicePolicyJsonSchema/{loopName}/{microServicePolicyName}" : { "put" : { - "operationId" : "route102", + "operationId" : "route47", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" + }, { + "name" : "microServicePolicyName", + "in" : "path", + "required" : true, + "type" : "string" } ], "responses" : { "200" : { @@ -270,13 +350,72 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route102" + "x-camelContextId" : "camel-2", + "x-routeId" : "route47" + } + }, + "/v2/loop/refreshOperationalPolicyJsonSchema/{loopName}/{operationalPolicyName}" : { + "put" : { + "operationId" : "route48", + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "loopName", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "operationalPolicyName", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "Output type", + "schema" : { + "$ref" : "#/definitions/Loop" + } + } + }, + "x-camelContextId" : "camel-2", + "x-routeId" : "route48" + } + }, + "/v2/loop/removeOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}" : { + "put" : { + "operationId" : "route56", + "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-2", + "x-routeId" : "route56" } }, "/v2/loop/restart/{loopName}" : { "put" : { - "operationId" : "route105", + "operationId" : "route51", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -292,13 +431,13 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route105" + "x-camelContextId" : "camel-2", + "x-routeId" : "route51" } }, "/v2/loop/stop/{loopName}" : { "put" : { - "operationId" : "route104", + "operationId" : "route50", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -314,13 +453,13 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route104" + "x-camelContextId" : "camel-2", + "x-routeId" : "route50" } }, "/v2/loop/submit/{loopName}" : { "put" : { - "operationId" : "route106", + "operationId" : "route52", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -336,13 +475,13 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route106" + "x-camelContextId" : "camel-2", + "x-routeId" : "route52" } }, "/v2/loop/svgRepresentation/{loopName}" : { "get" : { - "operationId" : "route97", + "operationId" : "route42", "produces" : [ "application/xml" ], "parameters" : [ { "name" : "loopName", @@ -358,13 +497,13 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route97" + "x-camelContextId" : "camel-2", + "x-routeId" : "route42" } }, "/v2/loop/undeploy/{loopName}" : { "put" : { - "operationId" : "route103", + "operationId" : "route49", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -380,13 +519,13 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route103" + "x-camelContextId" : "camel-2", + "x-routeId" : "route49" } }, "/v2/loop/updateGlobalProperties/{loopName}" : { "post" : { - "operationId" : "route98", + "operationId" : "route43", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -410,13 +549,13 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route98" + "x-camelContextId" : "camel-2", + "x-routeId" : "route43" } }, "/v2/loop/updateMicroservicePolicy/{loopName}" : { "post" : { - "operationId" : "route100", + "operationId" : "route45", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -440,13 +579,13 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route100" + "x-camelContextId" : "camel-2", + "x-routeId" : "route45" } }, "/v2/loop/updateOperationalPolicies/{loopName}" : { "post" : { - "operationId" : "route99", + "operationId" : "route44", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -470,13 +609,13 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route99" + "x-camelContextId" : "camel-2", + "x-routeId" : "route44" } }, "/v2/policyToscaModels" : { "get" : { - "operationId" : "route118", + "operationId" : "route65", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -486,18 +625,47 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route118" + "x-camelContextId" : "camel-2", + "x-routeId" : "route65" + }, + "post" : { + "operationId" : "route68", + "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-2", + "x-routeId" : "route68" } }, - "/v2/policyToscaModels/{policyModelType}" : { + "/v2/policyToscaModels/{policyModelType}/{policyModelVersion}" : { "get" : { + "operationId" : "route66", "produces" : [ "application/json" ], "parameters" : [ { "name" : "policyModelType", "in" : "path", "required" : true, "type" : "string" + }, { + "name" : "policyModelVersion", + "in" : "path", + "required" : true, + "type" : "string" } ], "responses" : { "200" : { @@ -507,11 +675,11 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : null + "x-camelContextId" : "camel-2", + "x-routeId" : "route66" }, "put" : { - "operationId" : "route119", + "operationId" : "route69", "consumes" : [ "plain/text" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -519,6 +687,11 @@ "in" : "path", "required" : true, "type" : "string" + }, { + "name" : "policyModelVersion", + "in" : "path", + "required" : true, + "type" : "string" }, { "in" : "body", "name" : "body", @@ -535,18 +708,24 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route119" + "x-camelContextId" : "camel-2", + "x-routeId" : "route69" } }, - "/v2/policyToscaModels/yaml/{policyModelType}" : { + "/v2/policyToscaModels/yaml/{policyModelType}/{policyModelVersion}" : { "get" : { + "operationId" : "route67", "produces" : [ "application/json" ], "parameters" : [ { "name" : "policyModelType", "in" : "path", "required" : true, "type" : "string" + }, { + "name" : "policyModelVersion", + "in" : "path", + "required" : true, + "type" : "string" } ], "responses" : { "200" : { @@ -556,13 +735,13 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : null + "x-camelContextId" : "camel-2", + "x-routeId" : "route67" } }, "/v2/templates" : { "get" : { - "operationId" : "route122", + "operationId" : "route70", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -572,12 +751,13 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route122" + "x-camelContextId" : "camel-2", + "x-routeId" : "route70" } }, "/v2/templates/{templateName}" : { "get" : { + "operationId" : "route71", "produces" : [ "application/json" ], "parameters" : [ { "name" : "templateName", @@ -593,12 +773,35 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : null + "x-camelContextId" : "camel-2", + "x-routeId" : "route71" + } + }, + "/v2/templates/{templateName}/svgRepresentation" : { + "get" : { + "operationId" : "route73", + "produces" : [ "application/xml" ], + "parameters" : [ { + "name" : "templateName", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "Output type", + "schema" : { + "type" : "string" + } + } + }, + "x-camelContextId" : "camel-2", + "x-routeId" : "route73" } }, "/v2/templates/names" : { "get" : { + "operationId" : "route72", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -611,13 +814,13 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : null + "x-camelContextId" : "camel-2", + "x-routeId" : "route72" } }, "/v1/healthcheck" : { "get" : { - "operationId" : "route123", + "operationId" : "route75", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -627,23 +830,44 @@ } } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route123" + "x-camelContextId" : "camel-2", + "x-routeId" : "route75" } }, "/v1/user/getUser" : { "get" : { - "operationId" : "route124", + "operationId" : "route76", "produces" : [ "text/plain" ], "responses" : { "200" : { } }, - "x-camelContextId" : "camel-4", - "x-routeId" : "route124" + "x-camelContextId" : "camel-2", + "x-routeId" : "route76" } } }, "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,18 +1027,21 @@ "JsonPrimitive" : { "type" : "object", "properties" : { + "boolean" : { + "type" : "boolean" + }, "asBoolean" : { "type" : "boolean" }, "number" : { "type" : "boolean" }, - "asString" : { - "type" : "string" - }, "asNumber" : { "$ref" : "#/definitions/Number" }, + "asString" : { + "type" : "string" + }, "asDouble" : { "type" : "number", "format" : "double" @@ -848,21 +1075,9 @@ "type" : "integer", "format" : "int32" }, - "boolean" : { - "type" : "boolean" - }, "string" : { "type" : "boolean" }, - "asJsonPrimitive" : { - "$ref" : "#/definitions/JsonPrimitive" - }, - "asJsonObject" : { - "$ref" : "#/definitions/JsonObject" - }, - "asJsonArray" : { - "$ref" : "#/definitions/JsonArray" - }, "jsonArray" : { "type" : "boolean" }, @@ -875,6 +1090,15 @@ "jsonNull" : { "type" : "boolean" }, + "asJsonObject" : { + "$ref" : "#/definitions/JsonObject" + }, + "asJsonArray" : { + "$ref" : "#/definitions/JsonArray" + }, + "asJsonPrimitive" : { + "$ref" : "#/definitions/JsonPrimitive" + }, "asJsonNull" : { "$ref" : "#/definitions/JsonNull" } @@ -909,6 +1133,12 @@ "pdpGroup" : { "type" : "string" }, + "pdpSubgroup" : { + "type" : "string" + }, + "policyModel" : { + "$ref" : "#/definitions/PolicyModel" + }, "name" : { "type" : "string" }, @@ -936,9 +1166,6 @@ }, "dcaeBlueprintId" : { "type" : "string" - }, - "policyModel" : { - "$ref" : "#/definitions/PolicyModel" } }, "x-className" : { @@ -952,18 +1179,6 @@ "asBoolean" : { "type" : "boolean" }, - "asJsonPrimitive" : { - "$ref" : "#/definitions/JsonPrimitive" - }, - "asString" : { - "type" : "string" - }, - "asJsonObject" : { - "$ref" : "#/definitions/JsonObject" - }, - "asJsonArray" : { - "$ref" : "#/definitions/JsonArray" - }, "jsonArray" : { "type" : "boolean" }, @@ -976,12 +1191,24 @@ "jsonNull" : { "type" : "boolean" }, + "asJsonObject" : { + "$ref" : "#/definitions/JsonObject" + }, + "asJsonArray" : { + "$ref" : "#/definitions/JsonArray" + }, + "asJsonPrimitive" : { + "$ref" : "#/definitions/JsonPrimitive" + }, "asJsonNull" : { "$ref" : "#/definitions/JsonNull" }, "asNumber" : { "$ref" : "#/definitions/Number" }, + "asString" : { + "type" : "string" + }, "asDouble" : { "type" : "number", "format" : "double" @@ -1056,6 +1283,9 @@ "items" : { "$ref" : "#/definitions/LoopElementModel" } + }, + "policyPdpGroup" : { + "$ref" : "#/definitions/JsonObject" } }, "x-className" : { @@ -1127,14 +1357,20 @@ "pdpGroup" : { "type" : "string" }, + "pdpSubgroup" : { + "type" : "string" + }, + "policyModel" : { + "$ref" : "#/definitions/PolicyModel" + }, "name" : { "type" : "string" }, "loop" : { "$ref" : "#/definitions/Loop" }, - "policyModel" : { - "$ref" : "#/definitions/PolicyModel" + "legacy" : { + "type" : "boolean" } } }, @@ -1144,18 +1380,6 @@ "asBoolean" : { "type" : "boolean" }, - "asJsonPrimitive" : { - "$ref" : "#/definitions/JsonPrimitive" - }, - "asString" : { - "type" : "string" - }, - "asJsonObject" : { - "$ref" : "#/definitions/JsonObject" - }, - "asJsonArray" : { - "$ref" : "#/definitions/JsonArray" - }, "jsonArray" : { "type" : "boolean" }, @@ -1168,12 +1392,24 @@ "jsonNull" : { "type" : "boolean" }, + "asJsonObject" : { + "$ref" : "#/definitions/JsonObject" + }, + "asJsonArray" : { + "$ref" : "#/definitions/JsonArray" + }, + "asJsonPrimitive" : { + "$ref" : "#/definitions/JsonPrimitive" + }, "asJsonNull" : { "$ref" : "#/definitions/JsonNull" }, "asNumber" : { "$ref" : "#/definitions/Number" }, + "asString" : { + "type" : "string" + }, "asDouble" : { "type" : "number", "format" : "double" @@ -1215,12 +1451,12 @@ "asBoolean" : { "type" : "boolean" }, - "asString" : { - "type" : "string" - }, "asNumber" : { "$ref" : "#/definitions/Number" }, + "asString" : { + "type" : "string" + }, "asDouble" : { "type" : "number", "format" : "double" @@ -1254,15 +1490,6 @@ "type" : "integer", "format" : "int32" }, - "asJsonPrimitive" : { - "$ref" : "#/definitions/JsonPrimitive" - }, - "asJsonObject" : { - "$ref" : "#/definitions/JsonObject" - }, - "asJsonArray" : { - "$ref" : "#/definitions/JsonArray" - }, "jsonArray" : { "type" : "boolean" }, @@ -1275,6 +1502,15 @@ "jsonNull" : { "type" : "boolean" }, + "asJsonObject" : { + "$ref" : "#/definitions/JsonObject" + }, + "asJsonArray" : { + "$ref" : "#/definitions/JsonArray" + }, + "asJsonPrimitive" : { + "$ref" : "#/definitions/JsonPrimitive" + }, "asJsonNull" : { "$ref" : "#/definitions/JsonNull" }