diff options
author | 2021-09-10 20:23:19 +0100 | |
---|---|---|
committer | 2021-09-16 14:18:42 +0000 | |
commit | e3935f01aa5b412bbbe98d95678f4d9ac1b658ea (patch) | |
tree | a419763cbaf2bfa191271a179c408e20bf2710a0 /docs/swagger/swagger-sdce-2-sdce-5.json | |
parent | 22d62a85bd9be6315d9f26271b5ac976255356a3 (diff) |
Update docs for multi model support
Signed-off-by: MichaelMorris <michael.morris@est.tech>
Issue-ID: SDC-3726
Change-Id: I4ba36318fc8c7de60ccb9c3d01d5aadedc94bded
Diffstat (limited to 'docs/swagger/swagger-sdce-2-sdce-5.json')
-rw-r--r-- | docs/swagger/swagger-sdce-2-sdce-5.json | 1725 |
1 files changed, 1680 insertions, 45 deletions
diff --git a/docs/swagger/swagger-sdce-2-sdce-5.json b/docs/swagger/swagger-sdce-2-sdce-5.json index 6dc3918666..24f4486b90 100644 --- a/docs/swagger/swagger-sdce-2-sdce-5.json +++ b/docs/swagger/swagger-sdce-2-sdce-5.json @@ -615,6 +615,13 @@ "schema" : { "type" : "string" } + }, { + "description" : "model", + "in" : "query", + "name" : "model", + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { @@ -906,6 +913,13 @@ "schema" : { "type" : "string" } + }, { + "description" : "model", + "in" : "query", + "name" : "model", + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { @@ -1531,6 +1545,12 @@ "schema" : { "type" : "string" } + }, { + "in" : "query", + "name" : "componentModel", + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { @@ -1845,6 +1865,13 @@ "schema" : { "type" : "string" } + }, { + "description" : "model", + "in" : "query", + "name" : "model", + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { @@ -2126,6 +2153,961 @@ "tags" : [ "SDCE-2 APIs" ] } }, + "/v1/catalog/lock" : { + "post" : { + "description" : "Toggle disable locking", + "operationId" : "toggleDisableLocking", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "boolean" + } + } + }, + "description" : "Disable Locking" + }, + "responses" : { + "200" : { + "description" : "Disable locking successfully updated" + }, + "500" : { + "description" : "Update disable locking failed" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/model" : { + "get" : { + "description" : "List all the existing TOSCA models", + "operationId" : "listModels", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "modelType", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Listing successful" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Model" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "List TOSCA models", + "tags" : [ "SDCE-2 APIs" ] + }, + "post" : { + "description" : "Create a TOSCA model, along with its imports files", + "operationId" : "createModel", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object", + "properties" : { + "model" : { + "$ref" : "#/components/schemas/ModelCreateRequest" + }, + "modelImportsZip" : { + "type" : "object", + "description" : "the model TOSCA imports zipped" + } + }, + "required" : [ "model", "modelImportsZip" ] + } + } + } + }, + "responses" : { + "201" : { + "description" : "Model created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Model already exists" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Create a TOSCA model", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/model/imports" : { + "put" : { + "description" : "Update a model TOSCA imports", + "operationId" : "updateModelImports", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object", + "properties" : { + "modelImportsZip" : { + "type" : "object", + "description" : "the model TOSCA imports zipped" + }, + "modelName" : { + "type" : "string", + "description" : "model to be created" + } + }, + "required" : [ "modelImportsZip", "modelName" ] + } + } + } + }, + "responses" : { + "204" : { + "description" : "Model imports updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Model not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Update a model TOSCA imports", + "tags" : [ "SDCE-2 APIs" ] + } + }, "/v1/catalog/nodeTypes" : { "get" : { "description" : "Get node types", @@ -2517,6 +3499,12 @@ "type" : "string" } }, { + "in" : "query", + "name" : "componentModel", + "schema" : { + "type" : "string" + } + }, { "description" : "The user id", "in" : "header", "name" : "USER_ID", @@ -2566,6 +3554,13 @@ "schema" : { "type" : "string" } + }, { + "description" : "model", + "in" : "query", + "name" : "model", + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { @@ -21384,6 +22379,14 @@ "type" : "string", "format" : "binary", "description" : "FileInputStream" + }, + "includeToModelImport" : { + "type" : "boolean", + "description" : "includeToModelImport" + }, + "model" : { + "type" : "string", + "description" : "model" } } } @@ -21998,6 +23001,14 @@ "type" : "string", "format" : "binary", "description" : "FileInputStream" + }, + "includeToModelImport" : { + "type" : "boolean", + "description" : "includeToModelImport" + }, + "model" : { + "type" : "string", + "description" : "model" } } } @@ -22306,6 +23317,14 @@ "format" : "binary", "description" : "FileInputStream" }, + "includeToModelImport" : { + "type" : "boolean", + "description" : "includeToModelImport" + }, + "model" : { + "type" : "string", + "description" : "model" + }, "toscaTypeMetadata" : { "type" : "string", "description" : "toscaTypeMetadata" @@ -22612,10 +23631,18 @@ "schema" : { "type" : "object", "properties" : { + "includeToModelImport" : { + "type" : "boolean", + "description" : "includeToModelImport" + }, "interfaceLifecycleTypeZip" : { "type" : "string", "format" : "binary", "description" : "FileInputStream" + }, + "model" : { + "type" : "string", + "description" : "model" } } } @@ -22919,6 +23946,14 @@ "schema" : { "type" : "object", "properties" : { + "includeToModelImport" : { + "type" : "boolean", + "description" : "includeToModelImport" + }, + "model" : { + "type" : "string", + "description" : "model" + }, "policyTypesZip" : { "type" : "string", "format" : "binary", @@ -23230,6 +24265,14 @@ "schema" : { "type" : "object", "properties" : { + "includeToModelImport" : { + "type" : "boolean", + "description" : "includeToModelImport" + }, + "model" : { + "type" : "string", + "description" : "model" + }, "relationshipTypeZip" : { "type" : "string", "format" : "binary", @@ -23755,6 +24798,18 @@ "type" : "string" } }, { + "in" : "query", + "name" : "componentModel", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "includeNormativeExtensionModels", + "schema" : { + "type" : "boolean" + } + }, { "in" : "header", "name" : "USER_ID", "schema" : { @@ -35840,7 +36895,7 @@ "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/attribute" : { + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/attributes" : { "post" : { "description" : "Update resource instance attribute", "operationId" : "updateResourceInstanceAttribute", @@ -35877,6 +36932,17 @@ "type" : "string" } } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Component Instance Properties JSON Array", + "required" : true + }, "responses" : { "201" : { "description" : "Resource instance created" @@ -36150,7 +37216,7 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns updated resource instance attribute", + "summary" : "Returns updated resource instance property", "tags" : [ "SDCE-2 APIs" ] } }, @@ -39610,6 +40676,329 @@ "tags" : [ "SDCE-2 APIs" ] } }, + "/v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/capability" : { + "put" : { + "description" : "Update Component Instance Capability", + "operationId" : "updateInstanceRequirement", + "parameters" : [ { + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "containerComponentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceUniqueId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentInstanceCapabilityUpdateModel" + } + } + }, + "description" : "Component instance capability to update", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Resource instance capability successfully updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component/Component Instance/Capability not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated Component Instance Capability", + "tags" : [ "SDCE-2 APIs" ] + } + }, "/v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/capability/{capabilityType}/capabilityName/{capabilityName}/ownerId/{ownerId}/properties" : { "get" : { "description" : "Get component instance capability properties", @@ -40594,7 +41983,7 @@ "/v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/requirement/{capabilityType}/requirementName/{requirementName}" : { "put" : { "description" : "Update Instance Requirement", - "operationId" : "updateInstanceRequirement", + "operationId" : "updateInstanceRequirement_1", "parameters" : [ { "in" : "path", "name" : "containerComponentType", @@ -42715,6 +44104,57 @@ "tags" : [ "SDCE-2 APIs" ] } }, + "/v1/category/{componentType}/{categoryName}/baseTypes" : { + "get" : { + "description" : "Get base types for category", + "operationId" : "getCategoryBaseTypes", + "parameters" : [ { + "in" : "path", + "name" : "categoryName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "description" : "model", + "in" : "query", + "name" : "model", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Returns base types Ok" + }, + "404" : { + "description" : "No base types were found" + }, + "500" : { + "description" : "Internal Server Error" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Get base types for category", + "tags" : [ "SDCE-2 APIs" ] + } + }, "/v1/category/{componentType}/{categoryUniqueId}" : { "delete" : { "description" : "Delete component category", @@ -44541,6 +45981,9 @@ "instanceUniqueId" : { "type" : "string" }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -44713,6 +46156,12 @@ "empty" : { "type" : "boolean" }, + "external" : { + "type" : "boolean" + }, + "externalName" : { + "type" : "string" + }, "leftOccurrences" : { "type" : "string" }, @@ -44786,6 +46235,12 @@ "empty" : { "type" : "boolean" }, + "external" : { + "type" : "boolean" + }, + "externalName" : { + "type" : "string" + }, "leftOccurrences" : { "type" : "string" }, @@ -44974,6 +46429,9 @@ "lifecycleState" : { "type" : "string" }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -45312,6 +46770,9 @@ "instanceUniqueId" : { "type" : "string" }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -45366,6 +46827,40 @@ } } }, + "ComponentInstanceCapabilityUpdateModel" : { + "type" : "object", + "properties" : { + "external" : { + "type" : "boolean" + }, + "name" : { + "type" : "string", + "maxLength" : 2147483647, + "minLength" : 1 + }, + "ownerId" : { + "type" : "string", + "maxLength" : 2147483647, + "minLength" : 1 + }, + "ownerName" : { + "type" : "string", + "maxLength" : 2147483647, + "minLength" : 1 + }, + "type" : { + "type" : "string", + "maxLength" : 2147483647, + "minLength" : 1 + }, + "uniqueId" : { + "type" : "string", + "maxLength" : 2147483647, + "minLength" : 1 + } + }, + "required" : [ "external", "name", "ownerId", "ownerName", "type", "uniqueId" ] + }, "ComponentInstanceInput" : { "type" : "object", "properties" : { @@ -45442,12 +46937,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -45512,6 +47013,10 @@ "subPropertyInputPath" : { "type" : "string" }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -45564,6 +47069,9 @@ "type" : "integer", "format" : "int64" }, + "model" : { + "type" : "string" + }, "operations" : { "type" : "object", "additionalProperties" : { @@ -45636,6 +47144,9 @@ "instanceUniqueId" : { "type" : "string" }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -45759,12 +47270,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -45823,6 +47340,10 @@ "subPropertyInputPath" : { "type" : "string" }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -45924,9 +47445,6 @@ "consumerBusinessLogic" : { "type" : "boolean" }, - "dcae" : { - "$ref" : "#/components/schemas/DcaeConfig" - }, "defaultImports" : { "type" : "array", "items" : { @@ -46173,10 +47691,6 @@ "type" : "boolean" }, "skipUpgradeVSPs" : { - "type" : "boolean", - "writeOnly" : true - }, - "skipUpgradeVSPsFlag" : { "type" : "boolean" }, "startMigrationFrom" : { @@ -46184,10 +47698,6 @@ "format" : "int32" }, "supportAllottedResourcesAndProxy" : { - "type" : "boolean", - "writeOnly" : true - }, - "supportAllottedResourcesAndProxyFlag" : { "type" : "boolean" }, "switchoverDetector" : { @@ -46416,6 +47926,9 @@ "empty" : { "type" : "boolean" }, + "model" : { + "type" : "string" + }, "modificationTime" : { "type" : "integer", "format" : "int64" @@ -46453,24 +47966,6 @@ } } }, - "DcaeConfig" : { - "type" : "object", - "properties" : { - "healthCheckUri" : { - "type" : "string" - }, - "host" : { - "type" : "string" - }, - "port" : { - "type" : "integer", - "format" : "int32" - }, - "protocol" : { - "type" : "string" - } - } - }, "DistributionStatusInfo" : { "type" : "object", "properties" : { @@ -46946,6 +48441,9 @@ "inputName" : { "type" : "string" }, + "inputType" : { + "type" : "string" + }, "list" : { "type" : "boolean" }, @@ -47283,12 +48781,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -47335,6 +48839,10 @@ "subPropertyInputPath" : { "type" : "string" }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -47392,6 +48900,9 @@ "type" : "string" } }, + "model" : { + "type" : "string" + }, "modificationTime" : { "type" : "integer", "format" : "int64" @@ -47599,12 +49110,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -47651,6 +49168,10 @@ "subPropertyInputPath" : { "type" : "string" }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -47741,12 +49262,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -47799,6 +49326,10 @@ "subPropertyInputPath" : { "type" : "string" }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -47842,6 +49373,9 @@ "type" : "integer", "format" : "int64" }, + "model" : { + "type" : "string" + }, "operations" : { "type" : "object", "additionalProperties" : { @@ -48111,6 +49645,9 @@ "MetadataKeyDataDefinition" : { "type" : "object", "properties" : { + "defaultValue" : { + "type" : "string" + }, "empty" : { "type" : "boolean" }, @@ -48141,6 +49678,39 @@ } } }, + "Model" : { + "type" : "object", + "properties" : { + "derivedFrom" : { + "type" : "string" + }, + "modelType" : { + "type" : "string", + "enum" : [ "NORMATIVE", "NORMATIVE_EXTENSION" ] + }, + "name" : { + "type" : "string" + } + } + }, + "ModelCreateRequest" : { + "type" : "object", + "properties" : { + "derivedFrom" : { + "type" : "string" + }, + "modelType" : { + "type" : "string", + "enum" : [ "NORMATIVE", "NORMATIVE_EXTENSION" ] + }, + "name" : { + "type" : "string", + "maxLength" : 2147483647, + "minLength" : 2 + } + }, + "required" : [ "name" ] + }, "NameIdPair" : { "type" : "object", "additionalProperties" : { @@ -48218,7 +49788,13 @@ "OnboardingConfig" : { "type" : "object", "properties" : { - "downloadCsarUri" : { + "getLatestVspPackageUri" : { + "type" : "string" + }, + "getVspPackageUri" : { + "type" : "string" + }, + "getVspUri" : { "type" : "string" }, "healthCheckUri" : { @@ -48369,12 +49945,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -48430,6 +50012,10 @@ "toscaDefaultValue" : { "type" : "string" }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -48515,12 +50101,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -48567,6 +50159,10 @@ "subPropertyInputPath" : { "type" : "string" }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -48640,6 +50236,9 @@ "instanceUniqueId" : { "type" : "string" }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -48765,12 +50364,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -48844,6 +50449,10 @@ } } }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -48900,6 +50509,9 @@ "type" : "string" } }, + "model" : { + "type" : "string" + }, "modificationTime" : { "type" : "integer", "format" : "int64" @@ -49011,12 +50623,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -49063,6 +50681,10 @@ "subPropertyInputPath" : { "type" : "string" }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -49140,12 +50762,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -49192,6 +50820,10 @@ "subPropertyInputPath" : { "type" : "string" }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -49342,6 +50974,9 @@ "external" : { "type" : "boolean" }, + "externalName" : { + "type" : "string" + }, "leftOccurrences" : { "type" : "string" }, @@ -49408,6 +51043,9 @@ "external" : { "type" : "boolean" }, + "externalName" : { + "type" : "string" + }, "leftOccurrences" : { "type" : "string" }, @@ -49735,6 +51373,9 @@ "csarVersion" : { "type" : "string" }, + "csarVersionId" : { + "type" : "string" + }, "dataTypes" : { "type" : "array", "items" : { @@ -49827,6 +51468,9 @@ "type" : "string", "enum" : [ "CERTIFIED", "NOT_CERTIFIED_CHECKIN", "NOT_CERTIFIED_CHECKOUT" ] }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -49894,12 +51538,6 @@ "substitutionFilter" : { "$ref" : "#/components/schemas/SubstitutionFilterDataDefinition" }, - "substitutionFilterComponents" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/SubstitutionFilterDataDefinition" - } - }, "systemName" : { "type" : "string" }, @@ -50233,6 +51871,9 @@ "type" : "string", "enum" : [ "CERTIFIED", "NOT_CERTIFIED_CHECKIN", "NOT_CERTIFIED_CHECKOUT" ] }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -50315,12 +51956,6 @@ "substitutionFilter" : { "$ref" : "#/components/schemas/SubstitutionFilterDataDefinition" }, - "substitutionFilterComponents" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/SubstitutionFilterDataDefinition" - } - }, "systemName" : { "type" : "string" }, |