X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fswagger%2Fswagger.json;h=30155353c3d8bfd7cff43d47e71a8332a4501bab;hb=580141f7cf72d4a120722fc7b870dfc5c3017ced;hp=3b34182c1652e05a543665772dec50f10749d836;hpb=8063862aeed5341f32cb6d95e212ed99e43e57c7;p=clamp.git diff --git a/docs/swagger/swagger.json b/docs/swagger/swagger.json index 3b34182c..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:39237", + "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" : "route49", + "operationId" : "route58", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -21,10 +37,10 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route49" + "x-routeId" : "route58" }, "put" : { - "operationId" : "route51", + "operationId" : "route61", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -44,11 +60,12 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route51" + "x-routeId" : "route61" } }, "/v2/dictionary/{dictionaryName}" : { "get" : { + "operationId" : "route60", "produces" : [ "application/json" ], "parameters" : [ { "name" : "dictionaryName", @@ -65,11 +82,12 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : null + "x-routeId" : "route60" } }, "/v2/dictionary/{name}" : { "put" : { + "operationId" : "route62", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -94,10 +112,10 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : null + "x-routeId" : "route62" }, "delete" : { - "operationId" : "route53", + "operationId" : "route63", "produces" : [ "application/json" ], "parameters" : [ { "name" : "name", @@ -109,11 +127,12 @@ "200" : { } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route53" + "x-routeId" : "route63" } }, "/v2/dictionary/{name}/elements/{shortName}" : { "delete" : { + "operationId" : "route64", "produces" : [ "application/json" ], "parameters" : [ { "name" : "name", @@ -130,11 +149,12 @@ "200" : { } }, "x-camelContextId" : "camel-2", - "x-routeId" : null + "x-routeId" : "route64" } }, "/v2/dictionary/secondary/names" : { "get" : { + "operationId" : "route59", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -148,12 +168,12 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : null + "x-routeId" : "route59" } }, "/v2/loop/{loopName}" : { "get" : { - "operationId" : "route34", + "operationId" : "route41", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -170,12 +190,67 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route34" + "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" : "route45", + "operationId" : "route53", "parameters" : [ { "name" : "loopName", "in" : "path", @@ -186,12 +261,12 @@ "200" : { } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route45" + "x-routeId" : "route53" } }, "/v2/loop/deploy/{loopName}" : { "put" : { - "operationId" : "route39", + "operationId" : "route46", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -208,12 +283,12 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route39" + "x-routeId" : "route46" } }, "/v2/loop/getAllNames" : { "get" : { - "operationId" : "route33", + "operationId" : "route40", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -227,12 +302,12 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route33" + "x-routeId" : "route40" } }, "/v2/loop/getstatus/{loopName}" : { "get" : { - "operationId" : "route46", + "operationId" : "route54", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -249,18 +324,23 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route46" + "x-routeId" : "route54" } }, - "/v2/loop/refreshOpPolicyJsonSchema/{loopName}" : { + "/v2/loop/refreshMicroServicePolicyJsonSchema/{loopName}/{microServicePolicyName}" : { "put" : { - "operationId" : "route40", + "operationId" : "route47", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" + }, { + "name" : "microServicePolicyName", + "in" : "path", + "required" : true, + "type" : "string" } ], "responses" : { "200" : { @@ -271,12 +351,71 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route40" + "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" : "route43", + "operationId" : "route51", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -293,12 +432,12 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route43" + "x-routeId" : "route51" } }, "/v2/loop/stop/{loopName}" : { "put" : { - "operationId" : "route42", + "operationId" : "route50", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -315,12 +454,12 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route42" + "x-routeId" : "route50" } }, "/v2/loop/submit/{loopName}" : { "put" : { - "operationId" : "route44", + "operationId" : "route52", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -337,12 +476,12 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route44" + "x-routeId" : "route52" } }, "/v2/loop/svgRepresentation/{loopName}" : { "get" : { - "operationId" : "route35", + "operationId" : "route42", "produces" : [ "application/xml" ], "parameters" : [ { "name" : "loopName", @@ -359,12 +498,12 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route35" + "x-routeId" : "route42" } }, "/v2/loop/undeploy/{loopName}" : { "put" : { - "operationId" : "route41", + "operationId" : "route49", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -381,12 +520,12 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route41" + "x-routeId" : "route49" } }, "/v2/loop/updateGlobalProperties/{loopName}" : { "post" : { - "operationId" : "route36", + "operationId" : "route43", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -411,12 +550,12 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route36" + "x-routeId" : "route43" } }, "/v2/loop/updateMicroservicePolicy/{loopName}" : { "post" : { - "operationId" : "route38", + "operationId" : "route45", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -441,12 +580,12 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route38" + "x-routeId" : "route45" } }, "/v2/loop/updateOperationalPolicies/{loopName}" : { "post" : { - "operationId" : "route37", + "operationId" : "route44", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -471,12 +610,12 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route37" + "x-routeId" : "route44" } }, "/v2/policyToscaModels" : { "get" : { - "operationId" : "route56", + "operationId" : "route65", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -487,17 +626,46 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route56" + "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" : { @@ -508,10 +676,10 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : null + "x-routeId" : "route66" }, "put" : { - "operationId" : "route57", + "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", @@ -536,17 +709,23 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route57" + "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" : { @@ -557,12 +736,12 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : null + "x-routeId" : "route67" } }, "/v2/templates" : { "get" : { - "operationId" : "route60", + "operationId" : "route70", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -573,11 +752,12 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route60" + "x-routeId" : "route70" } }, "/v2/templates/{templateName}" : { "get" : { + "operationId" : "route71", "produces" : [ "application/json" ], "parameters" : [ { "name" : "templateName", @@ -594,11 +774,34 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : null + "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" : { @@ -612,12 +815,12 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : null + "x-routeId" : "route72" } }, "/v1/healthcheck" : { "get" : { - "operationId" : "route61", + "operationId" : "route75", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -628,22 +831,43 @@ } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route61" + "x-routeId" : "route75" } }, "/v1/user/getUser" : { "get" : { - "operationId" : "route62", + "operationId" : "route76", "produces" : [ "text/plain" ], "responses" : { "200" : { } }, "x-camelContextId" : "camel-2", - "x-routeId" : "route62" + "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,6 @@ "JsonPrimitive" : { "type" : "object", "properties" : { - "asInt" : { - "type" : "integer", - "format" : "int32" - }, - "asDouble" : { - "type" : "number", - "format" : "double" - }, - "asLong" : { - "type" : "integer", - "format" : "int64" - }, "boolean" : { "type" : "boolean" }, @@ -824,16 +1036,28 @@ "number" : { "type" : "boolean" }, + "asNumber" : { + "$ref" : "#/definitions/Number" + }, "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" @@ -854,16 +1078,10 @@ "string" : { "type" : "boolean" }, - "asJsonObject" : { - "$ref" : "#/definitions/JsonObject" - }, - "asJsonArray" : { - "$ref" : "#/definitions/JsonArray" - }, - "jsonObject" : { + "jsonArray" : { "type" : "boolean" }, - "jsonArray" : { + "jsonObject" : { "type" : "boolean" }, "jsonPrimitive" : { @@ -872,6 +1090,12 @@ "jsonNull" : { "type" : "boolean" }, + "asJsonObject" : { + "$ref" : "#/definitions/JsonObject" + }, + "asJsonArray" : { + "$ref" : "#/definitions/JsonArray" + }, "asJsonPrimitive" : { "$ref" : "#/definitions/JsonPrimitive" }, @@ -952,34 +1176,13 @@ "JsonObject" : { "type" : "object", "properties" : { - "asInt" : { - "type" : "integer", - "format" : "int32" - }, - "asDouble" : { - "type" : "number", - "format" : "double" - }, - "asLong" : { - "type" : "integer", - "format" : "int64" - }, "asBoolean" : { "type" : "boolean" }, - "asJsonObject" : { - "$ref" : "#/definitions/JsonObject" - }, - "asString" : { - "type" : "string" - }, - "asJsonArray" : { - "$ref" : "#/definitions/JsonArray" - }, - "jsonObject" : { + "jsonArray" : { "type" : "boolean" }, - "jsonArray" : { + "jsonObject" : { "type" : "boolean" }, "jsonPrimitive" : { @@ -988,6 +1191,12 @@ "jsonNull" : { "type" : "boolean" }, + "asJsonObject" : { + "$ref" : "#/definitions/JsonObject" + }, + "asJsonArray" : { + "$ref" : "#/definitions/JsonArray" + }, "asJsonPrimitive" : { "$ref" : "#/definitions/JsonPrimitive" }, @@ -997,10 +1206,25 @@ "asNumber" : { "$ref" : "#/definitions/Number" }, + "asString" : { + "type" : "string" + }, + "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" @@ -1153,34 +1377,13 @@ "JsonNull" : { "type" : "object", "properties" : { - "asInt" : { - "type" : "integer", - "format" : "int32" - }, - "asDouble" : { - "type" : "number", - "format" : "double" - }, - "asLong" : { - "type" : "integer", - "format" : "int64" - }, "asBoolean" : { "type" : "boolean" }, - "asJsonObject" : { - "$ref" : "#/definitions/JsonObject" - }, - "asString" : { - "type" : "string" - }, - "asJsonArray" : { - "$ref" : "#/definitions/JsonArray" - }, - "jsonObject" : { + "jsonArray" : { "type" : "boolean" }, - "jsonArray" : { + "jsonObject" : { "type" : "boolean" }, "jsonPrimitive" : { @@ -1189,6 +1392,12 @@ "jsonNull" : { "type" : "boolean" }, + "asJsonObject" : { + "$ref" : "#/definitions/JsonObject" + }, + "asJsonArray" : { + "$ref" : "#/definitions/JsonArray" + }, "asJsonPrimitive" : { "$ref" : "#/definitions/JsonPrimitive" }, @@ -1198,10 +1407,25 @@ "asNumber" : { "$ref" : "#/definitions/Number" }, + "asString" : { + "type" : "string" + }, + "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" @@ -1224,31 +1448,31 @@ "JsonArray" : { "type" : "object", "properties" : { - "asInt" : { - "type" : "integer", - "format" : "int32" - }, - "asDouble" : { - "type" : "number", - "format" : "double" - }, - "asLong" : { - "type" : "integer", - "format" : "int64" - }, "asBoolean" : { "type" : "boolean" }, + "asNumber" : { + "$ref" : "#/definitions/Number" + }, "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" @@ -1266,16 +1490,10 @@ "type" : "integer", "format" : "int32" }, - "asJsonObject" : { - "$ref" : "#/definitions/JsonObject" - }, - "asJsonArray" : { - "$ref" : "#/definitions/JsonArray" - }, - "jsonObject" : { + "jsonArray" : { "type" : "boolean" }, - "jsonArray" : { + "jsonObject" : { "type" : "boolean" }, "jsonPrimitive" : { @@ -1284,6 +1502,12 @@ "jsonNull" : { "type" : "boolean" }, + "asJsonObject" : { + "$ref" : "#/definitions/JsonObject" + }, + "asJsonArray" : { + "$ref" : "#/definitions/JsonArray" + }, "asJsonPrimitive" : { "$ref" : "#/definitions/JsonPrimitive" },