X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fswagger%2Fswagger.json;h=1c6dde16b60052552f910b84147d125ef3047802;hb=88fd35f7b46041f723cff0eaaf4ea4ed46e9530f;hp=3b34182c1652e05a543665772dec50f10749d836;hpb=3af9347e47302e3f6754cba8ea2b63772980a5d9;p=clamp.git diff --git a/docs/swagger/swagger.json b/docs/swagger/swagger.json index 3b34182c..1c6dde16 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.1.3-SNAPSHOT", "title" : "Clamp Rest API" }, - "host" : "localhost:39237", + "host" : "localhost:8443", "basePath" : "/restservices/clds/", "schemes" : [ "http" ], "paths" : { + "/v2/clampInformation" : { + "get" : { + "operationId" : "route34", + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "Output type", + "schema" : { + "$ref" : "#/definitions/ClampInformation" + } + } + }, + "x-camelContextId" : "camel-1", + "x-routeId" : "route34" + } + }, "/v2/dictionary" : { "get" : { - "operationId" : "route49", + "operationId" : "route19", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -20,11 +36,11 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route49" + "x-camelContextId" : "camel-1", + "x-routeId" : "route19" }, "put" : { - "operationId" : "route51", + "operationId" : "route22", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -43,12 +59,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route51" + "x-camelContextId" : "camel-1", + "x-routeId" : "route22" } }, "/v2/dictionary/{dictionaryName}" : { "get" : { + "operationId" : "route21", "produces" : [ "application/json" ], "parameters" : [ { "name" : "dictionaryName", @@ -64,12 +81,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : null + "x-camelContextId" : "camel-1", + "x-routeId" : "route21" } }, "/v2/dictionary/{name}" : { "put" : { + "operationId" : "route23", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -93,11 +111,11 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : null + "x-camelContextId" : "camel-1", + "x-routeId" : "route23" }, "delete" : { - "operationId" : "route53", + "operationId" : "route24", "produces" : [ "application/json" ], "parameters" : [ { "name" : "name", @@ -108,12 +126,13 @@ "responses" : { "200" : { } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route53" + "x-camelContextId" : "camel-1", + "x-routeId" : "route24" } }, "/v2/dictionary/{name}/elements/{shortName}" : { "delete" : { + "operationId" : "route25", "produces" : [ "application/json" ], "parameters" : [ { "name" : "name", @@ -129,12 +148,13 @@ "responses" : { "200" : { } }, - "x-camelContextId" : "camel-2", - "x-routeId" : null + "x-camelContextId" : "camel-1", + "x-routeId" : "route25" } }, "/v2/dictionary/secondary/names" : { "get" : { + "operationId" : "route20", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -147,13 +167,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : null + "x-camelContextId" : "camel-1", + "x-routeId" : "route20" } }, "/v2/loop/{loopName}" : { "get" : { - "operationId" : "route34", + "operationId" : "route3", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -169,13 +189,68 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route34" + "x-camelContextId" : "camel-1", + "x-routeId" : "route3" + } + }, + "/v2/loop/addOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}" : { + "put" : { + "operationId" : "route16", + "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-1", + "x-routeId" : "route16" + } + }, + "/v2/loop/create/{loopName}?templateName={templateName}" : { + "post" : { + "operationId" : "route18", + "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-1", + "x-routeId" : "route18" } }, "/v2/loop/delete/{loopName}" : { "put" : { - "operationId" : "route45", + "operationId" : "route14", "parameters" : [ { "name" : "loopName", "in" : "path", @@ -185,13 +260,13 @@ "responses" : { "200" : { } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route45" + "x-camelContextId" : "camel-1", + "x-routeId" : "route14" } }, "/v2/loop/deploy/{loopName}" : { "put" : { - "operationId" : "route39", + "operationId" : "route7", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -207,13 +282,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route39" + "x-camelContextId" : "camel-1", + "x-routeId" : "route7" } }, "/v2/loop/getAllNames" : { "get" : { - "operationId" : "route33", + "operationId" : "route2", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -226,13 +301,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route33" + "x-camelContextId" : "camel-1", + "x-routeId" : "route2" } }, "/v2/loop/getstatus/{loopName}" : { "get" : { - "operationId" : "route46", + "operationId" : "route15", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -248,19 +323,24 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route46" + "x-camelContextId" : "camel-1", + "x-routeId" : "route15" } }, - "/v2/loop/refreshOpPolicyJsonSchema/{loopName}" : { + "/v2/loop/refreshMicroServicePolicyJsonSchema/{loopName}/{microServicePolicyName}" : { "put" : { - "operationId" : "route40", + "operationId" : "route8", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" + }, { + "name" : "microServicePolicyName", + "in" : "path", + "required" : true, + "type" : "string" } ], "responses" : { "200" : { @@ -270,19 +350,24 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route40" + "x-camelContextId" : "camel-1", + "x-routeId" : "route8" } }, - "/v2/loop/restart/{loopName}" : { + "/v2/loop/refreshOperationalPolicyJsonSchema/{loopName}/{operationalPolicyName}" : { "put" : { - "operationId" : "route43", + "operationId" : "route9", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", "in" : "path", "required" : true, "type" : "string" + }, { + "name" : "operationalPolicyName", + "in" : "path", + "required" : true, + "type" : "string" } ], "responses" : { "200" : { @@ -292,19 +377,34 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route43" + "x-camelContextId" : "camel-1", + "x-routeId" : "route9" } }, - "/v2/loop/stop/{loopName}" : { + "/v2/loop/removeOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}/{policyName}" : { "put" : { - "operationId" : "route42", + "operationId" : "route17", "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" + }, { + "name" : "policyName", + "in" : "path", + "required" : true, + "type" : "string" } ], "responses" : { "200" : { @@ -314,13 +414,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route42" + "x-camelContextId" : "camel-1", + "x-routeId" : "route17" } }, - "/v2/loop/submit/{loopName}" : { + "/v2/loop/restart/{loopName}" : { "put" : { - "operationId" : "route44", + "operationId" : "route12", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -336,14 +436,14 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route44" + "x-camelContextId" : "camel-1", + "x-routeId" : "route12" } }, - "/v2/loop/svgRepresentation/{loopName}" : { - "get" : { - "operationId" : "route35", - "produces" : [ "application/xml" ], + "/v2/loop/stop/{loopName}" : { + "put" : { + "operationId" : "route11", + "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", "in" : "path", @@ -354,17 +454,39 @@ "200" : { "description" : "Output type", "schema" : { - "type" : "string" + "$ref" : "#/definitions/Loop" } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route35" + "x-camelContextId" : "camel-1", + "x-routeId" : "route11" + } + }, + "/v2/loop/submit/{loopName}" : { + "put" : { + "operationId" : "route13", + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "loopName", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "Output type", + "schema" : { + "$ref" : "#/definitions/Loop" + } + } + }, + "x-camelContextId" : "camel-1", + "x-routeId" : "route13" } }, "/v2/loop/undeploy/{loopName}" : { "put" : { - "operationId" : "route41", + "operationId" : "route10", "produces" : [ "application/json" ], "parameters" : [ { "name" : "loopName", @@ -380,13 +502,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route41" + "x-camelContextId" : "camel-1", + "x-routeId" : "route10" } }, "/v2/loop/updateGlobalProperties/{loopName}" : { "post" : { - "operationId" : "route36", + "operationId" : "route4", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -410,13 +532,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route36" + "x-camelContextId" : "camel-1", + "x-routeId" : "route4" } }, "/v2/loop/updateMicroservicePolicy/{loopName}" : { "post" : { - "operationId" : "route38", + "operationId" : "route6", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -440,13 +562,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route38" + "x-camelContextId" : "camel-1", + "x-routeId" : "route6" } }, "/v2/loop/updateOperationalPolicies/{loopName}" : { "post" : { - "operationId" : "route37", + "operationId" : "route5", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -470,13 +592,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route37" + "x-camelContextId" : "camel-1", + "x-routeId" : "route5" } }, "/v2/policyToscaModels" : { "get" : { - "operationId" : "route56", + "operationId" : "route26", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -486,18 +608,47 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route56" + "x-camelContextId" : "camel-1", + "x-routeId" : "route26" + }, + "post" : { + "operationId" : "route29", + "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-1", + "x-routeId" : "route29" } }, - "/v2/policyToscaModels/{policyModelType}" : { + "/v2/policyToscaModels/{policyModelType}/{policyModelVersion}" : { "get" : { + "operationId" : "route27", "produces" : [ "application/json" ], "parameters" : [ { "name" : "policyModelType", "in" : "path", "required" : true, "type" : "string" + }, { + "name" : "policyModelVersion", + "in" : "path", + "required" : true, + "type" : "string" } ], "responses" : { "200" : { @@ -507,11 +658,11 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : null + "x-camelContextId" : "camel-1", + "x-routeId" : "route27" }, "put" : { - "operationId" : "route57", + "operationId" : "route30", "consumes" : [ "plain/text" ], "produces" : [ "application/json" ], "parameters" : [ { @@ -519,6 +670,11 @@ "in" : "path", "required" : true, "type" : "string" + }, { + "name" : "policyModelVersion", + "in" : "path", + "required" : true, + "type" : "string" }, { "in" : "body", "name" : "body", @@ -535,18 +691,24 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route57" + "x-camelContextId" : "camel-1", + "x-routeId" : "route30" } }, - "/v2/policyToscaModels/yaml/{policyModelType}" : { + "/v2/policyToscaModels/yaml/{policyModelType}/{policyModelVersion}" : { "get" : { + "operationId" : "route28", "produces" : [ "application/json" ], "parameters" : [ { "name" : "policyModelType", "in" : "path", "required" : true, "type" : "string" + }, { + "name" : "policyModelVersion", + "in" : "path", + "required" : true, + "type" : "string" } ], "responses" : { "200" : { @@ -556,13 +718,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : null + "x-camelContextId" : "camel-1", + "x-routeId" : "route28" } }, "/v2/templates" : { "get" : { - "operationId" : "route60", + "operationId" : "route31", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -572,12 +734,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route60" + "x-camelContextId" : "camel-1", + "x-routeId" : "route31" } }, "/v2/templates/{templateName}" : { "get" : { + "operationId" : "route32", "produces" : [ "application/json" ], "parameters" : [ { "name" : "templateName", @@ -593,12 +756,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : null + "x-camelContextId" : "camel-1", + "x-routeId" : "route32" } }, "/v2/templates/names" : { "get" : { + "operationId" : "route33", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -611,13 +775,13 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : null + "x-camelContextId" : "camel-1", + "x-routeId" : "route33" } }, "/v1/healthcheck" : { "get" : { - "operationId" : "route61", + "operationId" : "route35", "produces" : [ "application/json" ], "responses" : { "200" : { @@ -627,23 +791,44 @@ } } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route61" + "x-camelContextId" : "camel-1", + "x-routeId" : "route35" } }, "/v1/user/getUser" : { "get" : { - "operationId" : "route62", + "operationId" : "route36", "produces" : [ "text/plain" ], "responses" : { "200" : { } }, - "x-camelContextId" : "camel-2", - "x-routeId" : "route62" + "x-camelContextId" : "camel-1", + "x-routeId" : "route36" } } }, "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" : { @@ -751,9 +936,6 @@ "dcaeDeploymentStatusUrl" : { "type" : "string" }, - "svgRepresentation" : { - "type" : "string" - }, "globalPropertiesJson" : { "$ref" : "#/definitions/JsonObject" }, @@ -803,6 +985,9 @@ "JsonPrimitive" : { "type" : "object", "properties" : { + "asBoolean" : { + "type" : "boolean" + }, "asInt" : { "type" : "integer", "format" : "int32" @@ -818,15 +1003,22 @@ "boolean" : { "type" : "boolean" }, - "asBoolean" : { - "type" : "boolean" - }, "number" : { "type" : "boolean" }, "asString" : { "type" : "string" }, + "asBigDecimal" : { + "type" : "number" + }, + "asBigInteger" : { + "type" : "integer" + }, + "asShort" : { + "type" : "integer", + "format" : "int32" + }, "asNumber" : { "$ref" : "#/definitions/Number" }, @@ -841,32 +1033,19 @@ "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" - }, "jsonObject" : { "type" : "boolean" }, - "jsonArray" : { - "type" : "boolean" + "asJsonArray" : { + "$ref" : "#/definitions/JsonArray" }, - "jsonPrimitive" : { + "jsonArray" : { "type" : "boolean" }, "jsonNull" : { @@ -877,6 +1056,9 @@ }, "asJsonNull" : { "$ref" : "#/definitions/JsonNull" + }, + "jsonPrimitive" : { + "type" : "boolean" } } }, @@ -952,6 +1134,9 @@ "JsonObject" : { "type" : "object", "properties" : { + "asBoolean" : { + "type" : "boolean" + }, "asInt" : { "type" : "integer", "format" : "int32" @@ -964,35 +1149,27 @@ "type" : "integer", "format" : "int64" }, - "asBoolean" : { - "type" : "boolean" - }, "asJsonObject" : { "$ref" : "#/definitions/JsonObject" }, "asString" : { "type" : "string" }, - "asJsonArray" : { - "$ref" : "#/definitions/JsonArray" - }, "jsonObject" : { "type" : "boolean" }, - "jsonArray" : { - "type" : "boolean" - }, - "jsonPrimitive" : { - "type" : "boolean" + "asJsonArray" : { + "$ref" : "#/definitions/JsonArray" }, - "jsonNull" : { - "type" : "boolean" + "asBigDecimal" : { + "type" : "number" }, - "asJsonPrimitive" : { - "$ref" : "#/definitions/JsonPrimitive" + "asBigInteger" : { + "type" : "integer" }, - "asJsonNull" : { - "$ref" : "#/definitions/JsonNull" + "asShort" : { + "type" : "integer", + "format" : "int32" }, "asNumber" : { "$ref" : "#/definitions/Number" @@ -1008,15 +1185,20 @@ "asCharacter" : { "type" : "string" }, - "asBigDecimal" : { - "type" : "number" + "jsonArray" : { + "type" : "boolean" }, - "asBigInteger" : { - "type" : "integer" + "jsonNull" : { + "type" : "boolean" }, - "asShort" : { - "type" : "integer", - "format" : "int32" + "asJsonPrimitive" : { + "$ref" : "#/definitions/JsonPrimitive" + }, + "asJsonNull" : { + "$ref" : "#/definitions/JsonNull" + }, + "jsonPrimitive" : { + "type" : "boolean" } }, "x-className" : { @@ -1144,15 +1326,15 @@ }, "loop" : { "$ref" : "#/definitions/Loop" - }, - "legacy" : { - "type" : "boolean" } } }, "JsonNull" : { "type" : "object", "properties" : { + "asBoolean" : { + "type" : "boolean" + }, "asInt" : { "type" : "integer", "format" : "int32" @@ -1165,35 +1347,27 @@ "type" : "integer", "format" : "int64" }, - "asBoolean" : { - "type" : "boolean" - }, "asJsonObject" : { "$ref" : "#/definitions/JsonObject" }, "asString" : { "type" : "string" }, - "asJsonArray" : { - "$ref" : "#/definitions/JsonArray" - }, "jsonObject" : { "type" : "boolean" }, - "jsonArray" : { - "type" : "boolean" - }, - "jsonPrimitive" : { - "type" : "boolean" + "asJsonArray" : { + "$ref" : "#/definitions/JsonArray" }, - "jsonNull" : { - "type" : "boolean" + "asBigDecimal" : { + "type" : "number" }, - "asJsonPrimitive" : { - "$ref" : "#/definitions/JsonPrimitive" + "asBigInteger" : { + "type" : "integer" }, - "asJsonNull" : { - "$ref" : "#/definitions/JsonNull" + "asShort" : { + "type" : "integer", + "format" : "int32" }, "asNumber" : { "$ref" : "#/definitions/Number" @@ -1209,21 +1383,29 @@ "asCharacter" : { "type" : "string" }, - "asBigDecimal" : { - "type" : "number" + "jsonArray" : { + "type" : "boolean" }, - "asBigInteger" : { - "type" : "integer" + "jsonNull" : { + "type" : "boolean" }, - "asShort" : { - "type" : "integer", - "format" : "int32" + "asJsonPrimitive" : { + "$ref" : "#/definitions/JsonPrimitive" + }, + "asJsonNull" : { + "$ref" : "#/definitions/JsonNull" + }, + "jsonPrimitive" : { + "type" : "boolean" } } }, "JsonArray" : { "type" : "object", "properties" : { + "asBoolean" : { + "type" : "boolean" + }, "asInt" : { "type" : "integer", "format" : "int32" @@ -1236,12 +1418,19 @@ "type" : "integer", "format" : "int64" }, - "asBoolean" : { - "type" : "boolean" - }, "asString" : { "type" : "string" }, + "asBigDecimal" : { + "type" : "number" + }, + "asBigInteger" : { + "type" : "integer" + }, + "asShort" : { + "type" : "integer", + "format" : "int32" + }, "asNumber" : { "$ref" : "#/definitions/Number" }, @@ -1256,29 +1445,16 @@ "asCharacter" : { "type" : "string" }, - "asBigDecimal" : { - "type" : "number" - }, - "asBigInteger" : { - "type" : "integer" - }, - "asShort" : { - "type" : "integer", - "format" : "int32" - }, "asJsonObject" : { "$ref" : "#/definitions/JsonObject" }, - "asJsonArray" : { - "$ref" : "#/definitions/JsonArray" - }, "jsonObject" : { "type" : "boolean" }, - "jsonArray" : { - "type" : "boolean" + "asJsonArray" : { + "$ref" : "#/definitions/JsonArray" }, - "jsonPrimitive" : { + "jsonArray" : { "type" : "boolean" }, "jsonNull" : { @@ -1289,6 +1465,9 @@ }, "asJsonNull" : { "$ref" : "#/definitions/JsonNull" + }, + "jsonPrimitive" : { + "type" : "boolean" } }, "x-className" : { @@ -1362,9 +1541,6 @@ "blueprint" : { "type" : "string" }, - "svgRepresentation" : { - "type" : "string" - }, "loopElementModelsUsed" : { "type" : "array", "uniqueItems" : true,