From e3935f01aa5b412bbbe98d95678f4d9ac1b658ea Mon Sep 17 00:00:00 2001 From: MichaelMorris Date: Fri, 10 Sep 2021 20:23:19 +0100 Subject: Update docs for multi model support Signed-off-by: MichaelMorris Issue-ID: SDC-3726 Change-Id: I4ba36318fc8c7de60ccb9c3d01d5aadedc94bded --- docs/index.rst | 1 + docs/models.rst | 19 + docs/onboardingpackages.rst | 30 +- docs/swagger/swagger-sdce-2-sdce-5.json | 8751 ++++++++++++++++++------------- docs/swagger/swagger-sdce-7.json | 147 +- 5 files changed, 5381 insertions(+), 3567 deletions(-) create mode 100644 docs/models.rst (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index 0d1a6a3931..14a21503a8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,6 +12,7 @@ SDC Documentation configuration.rst consumedapis.rst offeredapis.rst + models.rst delivery.rst humaninterfaces.rst genericdesignerintegration.rst diff --git a/docs/models.rst b/docs/models.rst new file mode 100644 index 0000000000..9e41f5be2a --- /dev/null +++ b/docs/models.rst @@ -0,0 +1,19 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +======================== +Models +======================== + +SDC supports the onboarding and design of resources and services that adhere to one of a number of models. The following models are included in the default deployment: + +**SDC AID** + +The `ONAP SDC data model `_ supported widely by ONAP components. + +**ETSI SOL001 v2.5.1** + +The data model for NFV descriptors standardised by ETSI, `version 2.5.1 `_. Limited support exists in ONAP components, but some support is provided in SO SOL003 and SOL005 adapters and ETSI Catalog Manager. + +Further models can be added through the :ref:`Supported APIs ` at deployment or runtime. +Model inheritance is supported though it is expected that the names of the types be unique across the inheritance tree. Resources that are imported or designed to adhere to a particular model can only be used in a service that adheres to the same model. diff --git a/docs/onboardingpackages.rst b/docs/onboardingpackages.rst index 82e5334172..d48c2d6255 100644 --- a/docs/onboardingpackages.rst +++ b/docs/onboardingpackages.rst @@ -44,10 +44,27 @@ in `ONAP wiki page `_ ETSI SOL004 Tosca CSAR Package ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The ETSI SOL004 Tosca CSAR Package is a zip archive with a .csar extension. The structure of the supported CSAR package +The ETSI SOL004 Tosca CSAR Package is a zip archive with a .csar extension. The structure necessary for the supported CSAR package +depends on the model selected in onboarding as detailed below. + +**SDC AID** + +If the package is onboarded using the SDC AID model, the structure of the supported CSAR package is as described in `ETSI NFV-SOL 004v2.6.1`_ csar structure option 1 i.e. CSAR containing a TOSCA-Metadata directory. -The supported descriptor included in the package is aligned to `ETSI NFV-SOL 001v2.5.1 `_ +The supported descriptor included in the package is aligned to `ETSI NFV-SOL 001v2.5.1 `_. The descriptor is partially mapped into the SDC AID model. There is also limited support for v2.7.1 and 3.3.1 + +**ETSI SOL001 v2.5.1** + +If the package is onboarded using the ETSI SOL001 v2.5.1 model, the structure of the supported CSAR package +is as described in `ETSI NFV-SOL 004v2.5.1`_ csar structure option 1 i.e. CSAR containing a TOSCA-Metadata directory. + +The supported descriptor included in the package is aligned to `ETSI NFV-SOL 001v2.5.1`_. The tosca types defined in this version of the ETSI NFV-SOL 001 are used in the created VF (rather than the types defined in the SDC AID model). + +Note in relation to model selection: + +- More than one model can be selected during onboarding. In the subsequent VSP import one model from the list of models selected at onboarding time must be selected. +- For a package to be used in service design it must be imported with the same model as is selected during service creation. Other Points to note when onboarding this package are: @@ -55,6 +72,7 @@ Other Points to note when onboarding this package are: - The original input CSAR is maintained and stored as the SDC artifact *ETSI_PACKAGE* in the xNF internal model. For existing legacy xNF, it can be stored as *ONBOARDED_PACKAGE* instead. - The non-mano artifacts are mapped to the corresponding SDC Artifact Type in the xNF internal model. + Basic Helm package support for CNF ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -99,7 +117,11 @@ ONAP model. How does SDC determine which package type is being onboarded ------------------------------------------------------------ SDC onboarding processes each of the package types differently. SDC determines which package type is being onboarded, and -hence which logic to use, based on the following +hence which logic to use. + +If the ETSI SOL001 v2.5.1 model is selected during onboarding, SDC will always treat the package as an `ETSI SOL004 Tosca CSAR Package`_. + +If the SDC AID model is selected during onboarding, SDC will determine the package type based on the following. First SDC checks the extension of the package. If the package extension is *.zip* then the package is treated as a `Heat package`_ or `Basic Helm package support for CNF`_. @@ -145,3 +167,5 @@ SDC supports the signature in Cryptographic Message Syntax (CMS) format. needs to be pre-installed in SDC before onboarding is started. The details of this procedure are described :ref:`here `. .. _ETSI NFV-SOL 004v2.6.1: https://docbox.etsi.org/ISG/NFV/Open/Publications_pdf/Specs-Reports/NFV-SOL%20004v2.6.1%20-%20GS%20-%20VNF%20Package%20Stage%203%20-%20spec.pdf +.. _ETSI NFV-SOL 004v2.5.1: https://docbox.etsi.org/ISG/NFV/Open/Publications_pdf/Specs-Reports/NFV-SOL%20004v2.5.1%20-%20GS%20-%20VNF%20Package%20Stage%203%20spec.pdf +.. _ETSI NFV-SOL 001v2.5.1: https://docbox.etsi.org/ISG/NFV/Open/Publications_pdf/Specs-Reports/NFV-SOL%20001v2.5.1%20-%20GS%20-%20TOSCA-based%20NFV%20descriptors%20spec.pdf 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,301 +1865,17 @@ "schema" : { "type" : "string" } - } ], - "responses" : { - "200" : { - "description" : "Interface lifecycle types" - }, - "400" : { - "description" : "Invalid content / Missing content" - }, - "403" : { - "description" : "Restricted operation" - }, - "404" : { - "description" : "Interface lifecycle types 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 interface lifecycle types", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/nodeTypes" : { - "get" : { - "description" : "Get node types", - "operationId" : "getAllNodeTypesServlet", - "parameters" : [ { - "in" : "header", - "name" : "USER_ID", + }, { + "description" : "model", + "in" : "query", + "name" : "model", "schema" : { "type" : "string" } } ], "responses" : { "200" : { - "description" : "nodeTypes" + "description" : "Interface lifecycle types" }, "400" : { "description" : "Invalid content / Missing content" @@ -2148,7 +1884,7 @@ "description" : "Restricted operation" }, "404" : { - "description" : "Node types not found" + "description" : "Interface lifecycle types not found" }, "default" : { "content" : { @@ -2413,14 +2149,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns node types", + "summary" : "Returns interface lifecycle types", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/notif/vsp/archived" : { + "/v1/catalog/lock" : { "post" : { - "description" : "Notify about an archived VSP. All VFs with relation to the given CSAR IDs will be martked as vspArchived=true", - "operationId" : "onVspArchived", + "description" : "Toggle disable locking", + "operationId" : "toggleDisableLocking", "parameters" : [ { "in" : "header", "name" : "USER_ID", @@ -2432,72 +2168,275 @@ "content" : { "application/json" : { "schema" : { - "type" : "array", - "items" : { - "type" : "string" - } + "type" : "boolean" } } - } + }, + "description" : "Disable Locking" }, "responses" : { "200" : { - "description" : "Success" - }, - "400" : { - "description" : "Bad request" - }, - "403" : { - "description" : "Restricted operation" + "description" : "Disable locking successfully updated" }, "500" : { - "description" : "Internal Error. A list of the failed CSAR IDs may be returned." - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/notif/vsp/restored" : { - "post" : { - "description" : "Notify about a restored VSP. All VFs with relation to the given CSAR IDs will be martked as vspArchived=false", - "operationId" : "onVspRestored", - "parameters" : [ { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "type" : "string" + "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" + } + } + } + } } } } } }, - "responses" : { - "200" : { - "description" : "Success" - }, - "400" : { - "description" : "Bad request" - }, - "403" : { - "description" : "Restricted operation" - }, - "500" : { - "description" : "Internal Error. A list of the failed CSAR IDs may be returned." - } - }, "servers" : [ { "url" : "/sdc2/rest", "variables" : { } @@ -2505,43 +2444,37 @@ "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/policyTypes" : { + "/v1/catalog/model" : { "get" : { - "description" : "Get policy types ", - "operationId" : "getPolicyTypes", + "description" : "List all the existing TOSCA models", + "operationId" : "listModels", "parameters" : [ { - "description" : "An optional parameter to indicate the type of the container from where this call is executed", - "in" : "query", - "name" : "internalComponentType", + "in" : "header", + "name" : "USER_ID", "schema" : { "type" : "string" } }, { - "description" : "The user id", - "in" : "header", - "name" : "USER_ID", - "required" : true, + "in" : "query", + "name" : "modelType", "schema" : { "type" : "string" } } ], "responses" : { "200" : { - "description" : "policy types found" + "description" : "Listing successful" }, "403" : { "description" : "Restricted operation" }, - "500" : { - "description" : "The GET request failed due to internal SDC problem." - }, "default" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/PolicyTypeDefinition" + "$ref" : "#/components/schemas/Model" } } } @@ -2552,14 +2485,12 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns policy types", + "summary" : "List TOSCA models", "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/relationshipTypes" : { - "get" : { - "description" : "Get relationship types", - "operationId" : "getAllRelationshipTypesServlet", + }, + "post" : { + "description" : "Create a TOSCA model, along with its imports files", + "operationId" : "createModel", "parameters" : [ { "in" : "header", "name" : "USER_ID", @@ -2567,9 +2498,28 @@ "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" : { - "200" : { - "description" : "relationshipTypes" + "201" : { + "description" : "Model created" }, "400" : { "description" : "Invalid content / Missing content" @@ -2577,8 +2527,8 @@ "403" : { "description" : "Restricted operation" }, - "404" : { - "description" : "Relationship types not found" + "409" : { + "description" : "Model already exists" }, "default" : { "content" : { @@ -2843,14 +2793,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns relationship types", + "summary" : "Create a TOSCA model", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/resources" : { - "post" : { - "description" : "Create Resource", - "operationId" : "createResource", + "/v1/catalog/model/imports" : { + "put" : { + "description" : "Update a model TOSCA imports", + "operationId" : "updateModelImports", "parameters" : [ { "in" : "header", "name" : "USER_ID", @@ -2860,614 +2810,36 @@ } ], "requestBody" : { "content" : { - "application/json" : { + "multipart/form-data" : { "schema" : { - "type" : "string" - } - } - }, - "description" : "Resource object to be created", - "required" : true - }, - "responses" : { - "201" : { - "description" : "Resource created" - }, - "400" : { - "description" : "Invalid content / Missing content" - }, - "403" : { - "description" : "Restricted operation" - }, - "409" : { - "description" : "Resource already exist" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Resource" + "type" : "object", + "properties" : { + "modelImportsZip" : { + "type" : "object", + "description" : "the model TOSCA imports zipped" + }, + "modelName" : { + "type" : "string", + "description" : "model to be created" } - } + }, + "required" : [ "modelImportsZip", "modelName" ] } } } }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Returns created resource", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/resources/certified/abstract" : { - "get" : { - "operationId" : "getCertifiedAbstractResources", - "parameters" : [ { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "default" : { - "content" : { - "application/json" : { } - }, - "description" : "default response" - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/resources/certified/notabstract" : { - "get" : { - "operationId" : "getCertifiedNotAbstractResources", - "parameters" : [ { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "default" : { - "content" : { - "application/json" : { } - }, - "description" : "default response" - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/resources/csar/{csaruuid}" : { - "get" : { - "description" : "Create Resource", - "operationId" : "getResourceFromCsar", - "parameters" : [ { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - }, { - "in" : "path", - "name" : "csaruuid", - "required" : true, - "schema" : { - "type" : "string" - } - } ], "responses" : { - "201" : { - "description" : "Resource retrieced" + "204" : { + "description" : "Model imports updated" }, "400" : { "description" : "Invalid content / Missing content" }, "403" : { "description" : "Restricted operation" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Resource" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Returns resource created from csar uuid", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/resources/importReplaceResource" : { - "post" : { - "description" : "Import Resource", - "operationId" : "importReplaceResource", - "parameters" : [ { - "description" : "The user id", - "in" : "header", - "name" : "USER_ID", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "description" : "X-ECOMP-RequestID header", - "in" : "header", - "name" : "X-ECOMP-RequestID", - "schema" : { - "type" : "string" - } - }, { - "description" : "X-ECOMP-InstanceID header", - "in" : "header", - "name" : "X-ECOMP-InstanceID", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "description" : "Determines the format of the body of the response", - "in" : "header", - "name" : "Accept", - "schema" : { - "type" : "string" - } - }, { - "description" : "The username and password", - "in" : "header", - "name" : "Authorization", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "requestBody" : { - "content" : { - "*/*" : { - "schema" : { - "type" : "object", - "properties" : { - "resourceZip" : { - "$ref" : "#/components/schemas/FormDataContentDisposition" - }, - "resourceZipMetadata" : { - "type" : "string", - "description" : "resourceMetadata" - } - } - } - } - } - }, - "responses" : { - "201" : { - "description" : "Resource created" - }, - "400" : { - "description" : "Invalid content / Missing content" - }, - "403" : { - "description" : "Restricted operation" - }, - "409" : { - "description" : "Resource already exist" - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Returns imported resource", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/resources/resourceName/{resourceName}/resourceVersion/{resourceVersion}" : { - "get" : { - "description" : "Retrieve Resource by name and version", - "operationId" : "getResourceByNameAndVersion", - "parameters" : [ { - "in" : "path", - "name" : "resourceName", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "path", - "name" : "resourceVersion", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Resource found" - }, - "403" : { - "description" : "Restricted operation" - }, - "404" : { - "description" : "Resource not found" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Resource" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Returns resource according to resourceId", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/resources/validate-name/{resourceName}" : { - "get" : { - "description" : "validate resource name", - "operationId" : "validateResourceName", - "parameters" : [ { - "in" : "path", - "name" : "resourceName", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "query", - "name" : "subtype", - "schema" : { - "type" : "string" - } - }, { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Resource found" - }, - "403" : { - "description" : "Restricted operation" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Resource" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "checks if the chosen resource name is available ", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/resources/{componentId}/archive" : { - "post" : { - "description" : "Archive Resource", - "operationId" : "archiveResources", - "parameters" : [ { - "in" : "path", - "name" : "componentId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Archive successful" - }, - "400" : { - "description" : "Bad request" - }, - "403" : { - "description" : "Restricted operation" - }, - "404" : { - "description" : "Resource not found" - }, - "500" : { - "description" : "Internal Error" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Marks a resource as archived. Can be restored with restore action", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/resources/{componentId}/restore" : { - "post" : { - "description" : "Restore Resource", - "operationId" : "restoreResource", - "parameters" : [ { - "in" : "path", - "name" : "componentId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Restore successful" - }, - "400" : { - "description" : "Bad request" - }, - "403" : { - "description" : "Restricted operation" - }, - "404" : { - "description" : "Resource not found" - }, - "500" : { - "description" : "Internal Error" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Restores a resource from archive.", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/resources/{resourceId}" : { - "delete" : { - "operationId" : "deleteResource", - "parameters" : [ { - "in" : "path", - "name" : "resourceId", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "default" : { - "content" : { - "*/*" : { } - }, - "description" : "default response" - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "tags" : [ "SDCE-2 APIs" ] - }, - "get" : { - "description" : "Retrieve Resource", - "operationId" : "getResourceById", - "parameters" : [ { - "in" : "path", - "name" : "resourceId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Resource found" - }, - "403" : { - "description" : "Restricted operation" - }, - "404" : { - "description" : "Resource not found" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Resource" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Returns resource according to resourceId", - "tags" : [ "SDCE-2 APIs" ] - }, - "put" : { - "description" : "Update Resource", - "operationId" : "updateResource", - "parameters" : [ { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - }, { - "in" : "path", - "name" : "resourceId", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - }, - "description" : "Resource object to be updated", - "required" : true - }, - "responses" : { - "200" : { - "description" : "Resource updated" - }, - "400" : { - "description" : "Invalid content / Missing content" - }, - "403" : { - "description" : "Restricted operation" - }, - "409" : { - "description" : "Resource already exist" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Resource" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Returns updated resource", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/resources/{resourceId}/additionalinfo" : { - "get" : { - "description" : "Get all Additional Information under resource", - "operationId" : "getAllResourceAdditionalInformationLabel", - "parameters" : [ { - "description" : "resource id to update with new property", - "in" : "path", - "name" : "resourceId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "list of additional information" - }, - "400" : { - "description" : "Invalid content / Missing content" - }, - "403" : { - "description" : "Restricted operation" - }, - "409" : { - "description" : "Additional information key already exist" + }, + "404" : { + "description" : "Model not found" }, "default" : { "content" : { @@ -3732,41 +3104,24 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns Additional Inforamtion property", + "summary" : "Update a model TOSCA imports", "tags" : [ "SDCE-2 APIs" ] - }, - "post" : { - "description" : "Create Additional Information Label and Value", - "operationId" : "createResourceAdditionalInformationLabel", + } + }, + "/v1/catalog/nodeTypes" : { + "get" : { + "description" : "Get node types", + "operationId" : "getAllNodeTypesServlet", "parameters" : [ { - "description" : "resource id to update with new property", - "in" : "path", - "name" : "resourceId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { "in" : "header", "name" : "USER_ID", "schema" : { "type" : "string" } } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - }, - "description" : "Additional information key value to be created", - "required" : true - }, "responses" : { - "201" : { - "description" : "Additional information created" + "200" : { + "description" : "nodeTypes" }, "400" : { "description" : "Invalid content / Missing content" @@ -3774,8 +3129,8 @@ "403" : { "description" : "Restricted operation" }, - "409" : { - "description" : "Additional information key already exist" + "404" : { + "description" : "Node types not found" }, "default" : { "content" : { @@ -4040,49 +3395,133 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns created Additional Inforamtion property", + "summary" : "Returns node types", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/resources/{resourceId}/additionalinfo/{labelId}" : { - "delete" : { - "description" : "Create Additional Information Label and Value", - "operationId" : "updateResourceAdditionalInformationLabel", + "/v1/catalog/notif/vsp/archived" : { + "post" : { + "description" : "Notify about an archived VSP. All VFs with relation to the given CSAR IDs will be martked as vspArchived=true", + "operationId" : "onVspArchived", "parameters" : [ { - "description" : "resource id to update with new property", - "in" : "path", - "name" : "resourceId", - "required" : true, + "in" : "header", + "name" : "USER_ID", "schema" : { "type" : "string" } - }, { - "description" : "label id", - "in" : "path", - "name" : "labelId", - "required" : true, + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + }, + "responses" : { + "200" : { + "description" : "Success" + }, + "400" : { + "description" : "Bad request" + }, + "403" : { + "description" : "Restricted operation" + }, + "500" : { + "description" : "Internal Error. A list of the failed CSAR IDs may be returned." + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/notif/vsp/restored" : { + "post" : { + "description" : "Notify about a restored VSP. All VFs with relation to the given CSAR IDs will be martked as vspArchived=false", + "operationId" : "onVspRestored", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + }, + "responses" : { + "200" : { + "description" : "Success" + }, + "400" : { + "description" : "Bad request" + }, + "403" : { + "description" : "Restricted operation" + }, + "500" : { + "description" : "Internal Error. A list of the failed CSAR IDs may be returned." + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/policyTypes" : { + "get" : { + "description" : "Get policy types ", + "operationId" : "getPolicyTypes", + "parameters" : [ { + "description" : "An optional parameter to indicate the type of the container from where this call is executed", + "in" : "query", + "name" : "internalComponentType", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "componentModel", "schema" : { "type" : "string" } }, { + "description" : "The user id", "in" : "header", "name" : "USER_ID", + "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { - "description" : "Additional information deleted" - }, - "400" : { - "description" : "Invalid content / Missing content" + "description" : "policy types found" }, "403" : { "description" : "Restricted operation" }, - "409" : { - "description" : "Additional information key already exist" + "500" : { + "description" : "The GET request failed due to internal SDC problem." }, "default" : { "content" : { @@ -4090,253 +3529,7 @@ "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" - } - } - } - } + "$ref" : "#/components/schemas/PolicyTypeDefinition" } } } @@ -4347,38 +3540,31 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns deleted Additional Inforamtion property", + "summary" : "Returns policy types", "tags" : [ "SDCE-2 APIs" ] - }, + } + }, + "/v1/catalog/relationshipTypes" : { "get" : { - "description" : "Get Additional Information by id", - "operationId" : "getResourceAdditionalInformationLabel", + "description" : "Get relationship types", + "operationId" : "getAllRelationshipTypesServlet", "parameters" : [ { - "description" : "resource id to update with new property", - "in" : "path", - "name" : "resourceId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "description" : "label id", - "in" : "path", - "name" : "labelId", - "required" : true, + "in" : "header", + "name" : "USER_ID", "schema" : { "type" : "string" } }, { - "in" : "header", - "name" : "USER_ID", + "description" : "model", + "in" : "query", + "name" : "model", "schema" : { "type" : "string" } } ], "responses" : { "200" : { - "description" : "fetched additional information" + "description" : "relationshipTypes" }, "400" : { "description" : "Invalid content / Missing content" @@ -4386,8 +3572,8 @@ "403" : { "description" : "Restricted operation" }, - "409" : { - "description" : "Additional information key already exist" + "404" : { + "description" : "Relationship types not found" }, "default" : { "content" : { @@ -4652,29 +3838,15 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns Additional Inforamtion property", + "summary" : "Returns relationship types", "tags" : [ "SDCE-2 APIs" ] - }, - "put" : { - "description" : "Update Additional Information Label and Value", - "operationId" : "updateResourceAdditionalInformationLabel_1", + } + }, + "/v1/catalog/resources" : { + "post" : { + "description" : "Create Resource", + "operationId" : "createResource", "parameters" : [ { - "description" : "resource id to update with new property", - "in" : "path", - "name" : "resourceId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "description" : "label id", - "in" : "path", - "name" : "labelId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { "in" : "header", "name" : "USER_ID", "schema" : { @@ -4689,12 +3861,12 @@ } } }, - "description" : "Additional information key value to be created", + "description" : "Resource object to be created", "required" : true }, "responses" : { - "200" : { - "description" : "Additional information updated" + "201" : { + "description" : "Resource created" }, "400" : { "description" : "Invalid content / Missing content" @@ -4703,7 +3875,7 @@ "description" : "Restricted operation" }, "409" : { - "description" : "Additional information key already exist" + "description" : "Resource already exist" }, "default" : { "content" : { @@ -4711,95 +3883,1918 @@ "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" - }, + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns created resource", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/certified/abstract" : { + "get" : { + "operationId" : "getCertifiedAbstractResources", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/certified/notabstract" : { + "get" : { + "operationId" : "getCertifiedNotAbstractResources", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/csar/{csaruuid}" : { + "get" : { + "description" : "Create Resource", + "operationId" : "getResourceFromCsar", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "csaruuid", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Resource retrieced" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns resource created from csar uuid", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/importReplaceResource" : { + "post" : { + "description" : "Import Resource", + "operationId" : "importReplaceResource", + "parameters" : [ { + "description" : "The user id", + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "X-ECOMP-RequestID header", + "in" : "header", + "name" : "X-ECOMP-RequestID", + "schema" : { + "type" : "string" + } + }, { + "description" : "X-ECOMP-InstanceID header", + "in" : "header", + "name" : "X-ECOMP-InstanceID", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Determines the format of the body of the response", + "in" : "header", + "name" : "Accept", + "schema" : { + "type" : "string" + } + }, { + "description" : "The username and password", + "in" : "header", + "name" : "Authorization", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "object", + "properties" : { + "resourceZip" : { + "$ref" : "#/components/schemas/FormDataContentDisposition" + }, + "resourceZipMetadata" : { + "type" : "string", + "description" : "resourceMetadata" + } + } + } + } + } + }, + "responses" : { + "201" : { + "description" : "Resource created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Resource already exist" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns imported resource", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/resourceName/{resourceName}/resourceVersion/{resourceVersion}" : { + "get" : { + "description" : "Retrieve Resource by name and version", + "operationId" : "getResourceByNameAndVersion", + "parameters" : [ { + "in" : "path", + "name" : "resourceName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "resourceVersion", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Resource found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Resource not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns resource according to resourceId", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/validate-name/{resourceName}" : { + "get" : { + "description" : "validate resource name", + "operationId" : "validateResourceName", + "parameters" : [ { + "in" : "path", + "name" : "resourceName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "subtype", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Resource found" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "checks if the chosen resource name is available ", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{componentId}/archive" : { + "post" : { + "description" : "Archive Resource", + "operationId" : "archiveResources", + "parameters" : [ { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Archive successful" + }, + "400" : { + "description" : "Bad request" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Resource not found" + }, + "500" : { + "description" : "Internal Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Marks a resource as archived. Can be restored with restore action", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{componentId}/restore" : { + "post" : { + "description" : "Restore Resource", + "operationId" : "restoreResource", + "parameters" : [ { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Restore successful" + }, + "400" : { + "description" : "Bad request" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Resource not found" + }, + "500" : { + "description" : "Internal Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Restores a resource from archive.", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}" : { + "delete" : { + "operationId" : "deleteResource", + "parameters" : [ { + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "*/*" : { } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "Retrieve Resource", + "operationId" : "getResourceById", + "parameters" : [ { + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Resource found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Resource not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns resource according to resourceId", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update Resource", + "operationId" : "updateResource", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Resource object to be updated", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Resource updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Resource already exist" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated resource", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}/additionalinfo" : { + "get" : { + "description" : "Get all Additional Information under resource", + "operationId" : "getAllResourceAdditionalInformationLabel", + "parameters" : [ { + "description" : "resource id to update with new property", + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "list of additional information" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Additional information key already exist" + }, + "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 Additional Inforamtion property", + "tags" : [ "SDCE-2 APIs" ] + }, + "post" : { + "description" : "Create Additional Information Label and Value", + "operationId" : "createResourceAdditionalInformationLabel", + "parameters" : [ { + "description" : "resource id to update with new property", + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Additional information key value to be created", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Additional information created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Additional information key already exist" + }, + "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 created Additional Inforamtion property", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}/additionalinfo/{labelId}" : { + "delete" : { + "description" : "Create Additional Information Label and Value", + "operationId" : "updateResourceAdditionalInformationLabel", + "parameters" : [ { + "description" : "resource id to update with new property", + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "label id", + "in" : "path", + "name" : "labelId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Additional information deleted" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Additional information key already exist" + }, + "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 deleted Additional Inforamtion property", + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "Get Additional Information by id", + "operationId" : "getResourceAdditionalInformationLabel", + "parameters" : [ { + "description" : "resource id to update with new property", + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "label id", + "in" : "path", + "name" : "labelId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "fetched additional information" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Additional information key already exist" + }, + "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 Additional Inforamtion property", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update Additional Information Label and Value", + "operationId" : "updateResourceAdditionalInformationLabel_1", + "parameters" : [ { + "description" : "resource id to update with new property", + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "label id", + "in" : "path", + "name" : "labelId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Additional information key value to be created", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Additional information updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Additional information key already exist" + }, + "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" }, @@ -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", @@ -23754,6 +24797,18 @@ "schema" : { "type" : "string" } + }, { + "in" : "query", + "name" : "componentModel", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "includeNormativeExtensionModels", + "schema" : { + "type" : "boolean" + } }, { "in" : "header", "name" : "USER_ID", @@ -25435,12 +26490,423 @@ "schema" : { "type" : "string" } - }, { - "in" : "query", - "name" : "searchText", - "schema" : { - "type" : "string" - } + }, { + "in" : "query", + "name" : "searchText", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "uid list", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Component found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns component instances", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{inputId}/properties" : { + "get" : { + "description" : "Get properties", + "operationId" : "getInputPropertiesForComponentInstance", + "parameters" : [ { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "instanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "inputId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Component found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns properties list", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/inputs" : { + "get" : { + "description" : "Get Inputs only", + "operationId" : "getComponentInstanceInputs", + "parameters" : [ { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "instanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "originComponentUid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Component found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns Inputs list", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/outputs" : { + "get" : { + "description" : "Get Outputs only", + "operationId" : "getComponentInstanceOutputs", + "parameters" : [ { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "instanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "originComponentUid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Component found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns Outputs list", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/create/input" : { + "post" : { + "description" : "Create inputs on service", + "operationId" : "createInput", + "parameters" : [ { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "ComponentIns Inputs Object to be created", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Component found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Return inputs list", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/create/inputs" : { + "post" : { + "description" : "Create inputs on service", + "operationId" : "createMultipleInputs", + "parameters" : [ { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "ComponentIns Inputs Object to be created", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Component found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Return inputs list", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/create/listInput" : { + "post" : { + "description" : "Create a list input on service", + "operationId" : "createListInput", + "parameters" : [ { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } }, { "in" : "header", "name" : "USER_ID", @@ -25456,7 +26922,7 @@ } } }, - "description" : "uid list", + "description" : "ComponentIns Inputs Object to be created", "required" : true }, "responses" : { @@ -25486,14 +26952,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns component instances", + "summary" : "Return input", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{inputId}/properties" : { - "get" : { - "description" : "Get properties", - "operationId" : "getInputPropertiesForComponentInstance", + "/v1/catalog/{componentType}/{componentId}/create/outputs" : { + "post" : { + "description" : "Create outputs on service", + "operationId" : "createMultipleOutputs", "parameters" : [ { "in" : "path", "name" : "componentType", @@ -25509,15 +26975,68 @@ "type" : "string" } }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "ComponentIns Outputs Object to be created", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Component found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Return outputs list", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/create/policies" : { + "post" : { + "description" : "Create policies on service", + "operationId" : "declareProperties", + "parameters" : [ { "in" : "path", - "name" : "instanceId", + "name" : "componentType", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", - "name" : "inputId", + "name" : "componentId", "required" : true, "schema" : { "type" : "string" @@ -25529,6 +27048,17 @@ "type" : "string" } } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "ComponentIns policies Object to be created", + "required" : true + }, "responses" : { "200" : { "description" : "Component found" @@ -25556,14 +27086,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns properties list", + "summary" : "Return policies list", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/inputs" : { - "get" : { - "description" : "Get Inputs only", - "operationId" : "getComponentInstanceInputs", + "/v1/catalog/{componentType}/{componentId}/dataType/{dataTypeName}" : { + "delete" : { + "description" : "Delete data type from service", + "operationId" : "deleteDataType", "parameters" : [ { "in" : "path", "name" : "componentType", @@ -25580,34 +27110,76 @@ } }, { "in" : "path", - "name" : "instanceId", + "name" : "dataTypeName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Data type deleted" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Data type not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Delete service input", + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "Get data type in service", + "operationId" : "getDataType", + "parameters" : [ { + "in" : "path", + "name" : "componentType", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", - "name" : "originComponentUid", + "name" : "componentId", "required" : true, "schema" : { "type" : "string" } }, { - "in" : "header", - "name" : "USER_ID", + "in" : "path", + "name" : "dataTypeName", + "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { - "description" : "Component found" + "description" : "Data type found" }, "403" : { "description" : "Restricted operation" }, "404" : { - "description" : "Component not found" + "description" : "Data type not found" }, "default" : { "content" : { @@ -25615,7 +27187,7 @@ "schema" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/Resource" + "$ref" : "#/components/schemas/DataTypeDefinition" } } } @@ -25626,14 +27198,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns Inputs list", + "summary" : "Get data type in service", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/outputs" : { + "/v1/catalog/{componentType}/{componentId}/dataTypes" : { "get" : { - "description" : "Get Outputs only", - "operationId" : "getComponentInstanceOutputs", + "description" : "Get data types that service has", + "operationId" : "getDataTypes", "parameters" : [ { "in" : "path", "name" : "componentType", @@ -25648,16 +27220,59 @@ "schema" : { "type" : "string" } + } ], + "responses" : { + "200" : { + "description" : "Data type found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Get data types in service", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/delete/{inputId}/input" : { + "delete" : { + "description" : "Delete input from service", + "operationId" : "deleteInput", + "parameters" : [ { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } }, { "in" : "path", - "name" : "instanceId", + "name" : "componentId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", - "name" : "originComponentUid", + "name" : "inputId", "required" : true, "schema" : { "type" : "string" @@ -25669,15 +27284,26 @@ "type" : "string" } } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Service Input to be deleted", + "required" : true + }, "responses" : { "200" : { - "description" : "Component found" + "description" : "Input deleted" }, "403" : { "description" : "Restricted operation" }, "404" : { - "description" : "Component not found" + "description" : "Input not found" }, "default" : { "content" : { @@ -25696,14 +27322,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns Outputs list", + "summary" : "Delete service input", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{componentType}/{componentId}/create/input" : { - "post" : { - "description" : "Create inputs on service", - "operationId" : "createInput", + "/v1/catalog/{componentType}/{componentId}/delete/{outputId}/output" : { + "delete" : { + "description" : "Delete output from service", + "operationId" : "deleteOutput", "parameters" : [ { "in" : "path", "name" : "componentType", @@ -25718,6 +27344,13 @@ "schema" : { "type" : "string" } + }, { + "in" : "path", + "name" : "outputId", + "required" : true, + "schema" : { + "type" : "string" + } }, { "in" : "header", "name" : "USER_ID", @@ -25733,18 +27366,18 @@ } } }, - "description" : "ComponentIns Inputs Object to be created", + "description" : "Service Output to be deleted", "required" : true }, "responses" : { "200" : { - "description" : "Component found" + "description" : "Output deleted" }, "403" : { "description" : "Restricted operation" }, "404" : { - "description" : "Component not found" + "description" : "Output not found" }, "default" : { "content" : { @@ -25763,14 +27396,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Return inputs list", + "summary" : "Delete service output", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{componentType}/{componentId}/create/inputs" : { - "post" : { - "description" : "Create inputs on service", - "operationId" : "createMultipleInputs", + "/v1/catalog/{componentType}/{componentId}/dependencies" : { + "get" : { + "description" : "Autometed upgrade", + "operationId" : "getComponentDependencies", "parameters" : [ { "in" : "path", "name" : "componentType", @@ -25796,11 +27429,14 @@ "content" : { "application/json" : { "schema" : { - "type" : "string" + "type" : "array", + "items" : { + "type" : "string" + } } } }, - "description" : "ComponentIns Inputs Object to be created", + "description" : "Consumer Object to be created", "required" : true }, "responses" : { @@ -25819,7 +27455,253 @@ "schema" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/Resource" + "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" + } + } + } + } } } } @@ -25830,14 +27712,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Return inputs list", + "summary" : "....", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{componentType}/{componentId}/create/listInput" : { - "post" : { - "description" : "Create a list input on service", - "operationId" : "createListInput", + "/v1/catalog/{componentType}/{componentId}/filteredDataByParams" : { + "get" : { + "description" : "Retrieve Resource", + "operationId" : "getComponentDataFilteredByParams", "parameters" : [ { "in" : "path", "name" : "componentType", @@ -25852,6 +27734,15 @@ "schema" : { "type" : "string" } + }, { + "in" : "query", + "name" : "include", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } }, { "in" : "header", "name" : "USER_ID", @@ -25859,26 +27750,15 @@ "type" : "string" } } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - }, - "description" : "ComponentIns Inputs Object to be created", - "required" : true - }, "responses" : { "200" : { - "description" : "Component found" + "description" : "Resource found" }, "403" : { "description" : "Restricted operation" }, "404" : { - "description" : "Component not found" + "description" : "Resource not found" }, "default" : { "content" : { @@ -25897,14 +27777,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Return input", + "summary" : "Returns resource according to resourceId", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{componentType}/{componentId}/create/outputs" : { - "post" : { - "description" : "Create outputs on service", - "operationId" : "createMultipleOutputs", + "/v1/catalog/{componentType}/{componentId}/filteredproperties/{propertyNameFragment}" : { + "get" : { + "description" : "Retrieve properties belonging to component instances of specific component by name and optionally resource type", + "operationId" : "getFilteredComponentInstanceProperties", "parameters" : [ { "in" : "path", "name" : "componentType", @@ -25920,71 +27800,20 @@ "type" : "string" } }, { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - }, - "description" : "ComponentIns Outputs Object to be created", - "required" : true - }, - "responses" : { - "200" : { - "description" : "Component found" - }, - "403" : { - "description" : "Restricted operation" - }, - "404" : { - "description" : "Component not found" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Resource" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Return outputs list", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/{componentType}/{componentId}/create/policies" : { - "post" : { - "description" : "Create policies on service", - "operationId" : "declareProperties", - "parameters" : [ { "in" : "path", - "name" : "componentType", + "name" : "propertyNameFragment", "required" : true, "schema" : { "type" : "string" } }, { - "in" : "path", - "name" : "componentId", - "required" : true, + "in" : "query", + "name" : "resourceType", "schema" : { - "type" : "string" + "type" : "array", + "items" : { + "type" : "string" + } } }, { "in" : "header", @@ -25993,17 +27822,6 @@ "type" : "string" } } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - }, - "description" : "ComponentIns policies Object to be created", - "required" : true - }, "responses" : { "200" : { "description" : "Component found" @@ -26020,7 +27838,7 @@ "schema" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/Resource" + "type" : "string" } } } @@ -26031,14 +27849,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Return policies list", + "summary" : "Returns properties belonging to component instances of specific component by name and optionally resource type", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{componentType}/{componentId}/dataType/{dataTypeName}" : { - "delete" : { - "description" : "Delete data type from service", - "operationId" : "deleteDataType", + "/v1/catalog/{componentType}/{componentId}/inputs/{inputId}" : { + "get" : { + "description" : "Get inputs", + "operationId" : "getInputsAndPropertiesForComponentInput", "parameters" : [ { "in" : "path", "name" : "componentType", @@ -26055,21 +27873,27 @@ } }, { "in" : "path", - "name" : "dataTypeName", + "name" : "inputId", "required" : true, "schema" : { "type" : "string" } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "Data type deleted" + "description" : "Component found" }, "403" : { "description" : "Restricted operation" }, "404" : { - "description" : "Data type not found" + "description" : "Component not found" }, "default" : { "content" : { @@ -26088,12 +27912,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Delete service input", + "summary" : "Returns inputs list", "tags" : [ "SDCE-2 APIs" ] - }, + } + }, + "/v1/catalog/{componentType}/{componentId}/inputs/{inputId}/inputs" : { "get" : { - "description" : "Get data type in service", - "operationId" : "getDataType", + "description" : "Get inputs", + "operationId" : "getInputsForComponentInput", "parameters" : [ { "in" : "path", "name" : "componentType", @@ -26110,65 +27936,21 @@ } }, { "in" : "path", - "name" : "dataTypeName", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Data type found" - }, - "403" : { - "description" : "Restricted operation" - }, - "404" : { - "description" : "Data type not found" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DataTypeDefinition" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Get data type in service", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/{componentType}/{componentId}/dataTypes" : { - "get" : { - "description" : "Get data types that service has", - "operationId" : "getDataTypes", - "parameters" : [ { - "in" : "path", - "name" : "componentType", + "name" : "inputId", "required" : true, "schema" : { "type" : "string" } }, { - "in" : "path", - "name" : "componentId", - "required" : true, + "in" : "header", + "name" : "USER_ID", "schema" : { "type" : "string" } } ], "responses" : { "200" : { - "description" : "Data type found" + "description" : "Component found" }, "403" : { "description" : "Restricted operation" @@ -26193,14 +27975,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Get data types in service", + "summary" : "Returns inputs list", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{componentType}/{componentId}/delete/{inputId}/input" : { - "delete" : { - "description" : "Delete input from service", - "operationId" : "deleteInput", + "/v1/catalog/{componentType}/{componentId}/requirmentsCapabilities" : { + "get" : { + "description" : "Get Component Requirments And Capabilities", + "operationId" : "getRequirementAndCapabilities", "parameters" : [ { "in" : "path", "name" : "componentType", @@ -26215,13 +27997,6 @@ "schema" : { "type" : "string" } - }, { - "in" : "path", - "name" : "inputId", - "required" : true, - "schema" : { - "type" : "string" - } }, { "in" : "header", "name" : "USER_ID", @@ -26229,26 +28004,15 @@ "type" : "string" } } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - }, - "description" : "Service Input to be deleted", - "required" : true - }, "responses" : { "200" : { - "description" : "Input deleted" + "description" : "Component found" }, "403" : { "description" : "Restricted operation" }, "404" : { - "description" : "Input not found" + "description" : "Component not found" }, "default" : { "content" : { @@ -26267,34 +28031,39 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Delete service input", + "summary" : "Returns Requirements And Capabilities according to componentId", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{componentType}/{componentId}/delete/{outputId}/output" : { - "delete" : { - "description" : "Delete output from service", - "operationId" : "deleteOutput", + "/v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}" : { + "post" : { + "description" : "Add Component Substitution Filter Constraint", + "operationId" : "addSubstitutionFilter", "parameters" : [ { + "description" : "Component Id", "in" : "path", - "name" : "componentType", + "name" : "componentId", "required" : true, "schema" : { "type" : "string" } }, { + "description" : "valid value: resources / services", "in" : "path", - "name" : "componentId", + "name" : "componentType", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "enum" : [ "services", "services" ] } }, { + "description" : "Constraint type. Valid values: properties / capabilities", "in" : "path", - "name" : "outputId", + "name" : "constraintType", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "enum" : [ "properties", "capabilities" ] } }, { "in" : "header", @@ -26311,57 +28080,309 @@ } } }, - "description" : "Service Output to be deleted", + "description" : "UIConstraint data", "required" : true }, "responses" : { - "200" : { - "description" : "Output deleted" + "201" : { + "description" : "Add Substitution Filter Constraint" + }, + "400" : { + "description" : "Invalid content / Missing content" }, "403" : { "description" : "Restricted operation" }, - "404" : { - "description" : "Output not found" - }, "default" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/Resource" + "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" : "Delete service output", + "summary" : "Add Component Substitution Filter Constraint", "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/{componentType}/{componentId}/dependencies" : { - "get" : { - "description" : "Autometed upgrade", - "operationId" : "getComponentDependencies", + }, + "put" : { + "description" : "Update Component Substitution Filter Constraint", + "operationId" : "updateSubstitutionFilter", "parameters" : [ { + "description" : "Component Id", "in" : "path", - "name" : "componentType", + "name" : "componentId", "required" : true, "schema" : { "type" : "string" } }, { + "description" : "valid value: resources / services", "in" : "path", - "name" : "componentId", + "name" : "componentType", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "enum" : [ "services", "services" ] + } + }, { + "description" : "Constraint type. Valid values: properties / capabilities", + "in" : "path", + "name" : "constraintType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "properties", "capabilities" ] } }, { "in" : "header", @@ -26374,26 +28395,23 @@ "content" : { "application/json" : { "schema" : { - "type" : "array", - "items" : { - "type" : "string" - } + "type" : "string" } } }, - "description" : "Consumer Object to be created", + "description" : "UIConstraint data", "required" : true }, "responses" : { - "200" : { - "description" : "Component found" + "201" : { + "description" : "Update Substitution Filter Constraint" + }, + "400" : { + "description" : "Invalid content / Missing content" }, "403" : { "description" : "Restricted operation" }, - "404" : { - "description" : "Component not found" - }, "default" : { "content" : { "application/json" : { @@ -26653,289 +28671,16 @@ } } }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "....", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/{componentType}/{componentId}/filteredDataByParams" : { - "get" : { - "description" : "Retrieve Resource", - "operationId" : "getComponentDataFilteredByParams", - "parameters" : [ { - "in" : "path", - "name" : "componentType", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "path", - "name" : "componentId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "query", - "name" : "include", - "schema" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - }, { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Resource found" - }, - "403" : { - "description" : "Restricted operation" - }, - "404" : { - "description" : "Resource not found" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Resource" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Returns resource according to resourceId", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/{componentType}/{componentId}/filteredproperties/{propertyNameFragment}" : { - "get" : { - "description" : "Retrieve properties belonging to component instances of specific component by name and optionally resource type", - "operationId" : "getFilteredComponentInstanceProperties", - "parameters" : [ { - "in" : "path", - "name" : "componentType", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "path", - "name" : "componentId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "path", - "name" : "propertyNameFragment", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "query", - "name" : "resourceType", - "schema" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - }, { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Component found" - }, - "403" : { - "description" : "Restricted operation" - }, - "404" : { - "description" : "Component not found" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Returns properties belonging to component instances of specific component by name and optionally resource type", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/{componentType}/{componentId}/inputs/{inputId}" : { - "get" : { - "description" : "Get inputs", - "operationId" : "getInputsAndPropertiesForComponentInput", - "parameters" : [ { - "in" : "path", - "name" : "componentType", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "path", - "name" : "componentId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "path", - "name" : "inputId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Component found" - }, - "403" : { - "description" : "Restricted operation" - }, - "404" : { - "description" : "Component not found" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Resource" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Returns inputs list", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/{componentType}/{componentId}/inputs/{inputId}/inputs" : { - "get" : { - "description" : "Get inputs", - "operationId" : "getInputsForComponentInput", - "parameters" : [ { - "in" : "path", - "name" : "componentType", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "path", - "name" : "componentId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "path", - "name" : "inputId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Component found" - }, - "403" : { - "description" : "Restricted operation" - }, - "404" : { - "description" : "Component not found" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Resource" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Returns inputs list", + "summary" : "Update Component Substitution Filter Constraint", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{componentType}/{componentId}/requirmentsCapabilities" : { - "get" : { - "description" : "Get Component Requirments And Capabilities", - "operationId" : "getRequirementAndCapabilities", + "/v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}/{constraintIndex}" : { + "delete" : { + "description" : "Delete Component Substitution Filter Constraint", + "operationId" : "deleteSubstitutionFilterConstraint", "parameters" : [ { - "in" : "path", - "name" : "componentType", - "required" : true, - "schema" : { - "type" : "string" - } - }, { + "description" : "Component Id", "in" : "path", "name" : "componentId", "required" : true, @@ -26943,54 +28688,13 @@ "type" : "string" } }, { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Component found" - }, - "403" : { - "description" : "Restricted operation" - }, - "404" : { - "description" : "Component not found" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Resource" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Returns Requirements And Capabilities according to componentId", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}" : { - "post" : { - "description" : "Add Component Substitution Filter Constraint", - "operationId" : "addSubstitutionFilter", - "parameters" : [ { - "description" : "Component Id", + "description" : "Constraint Index", "in" : "path", - "name" : "componentId", + "name" : "constraintIndex", "required" : true, "schema" : { - "type" : "string" + "type" : "integer", + "format" : "int32" } }, { "description" : "valid value: resources / services", @@ -27017,20 +28721,9 @@ "type" : "string" } } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - }, - "description" : "UIConstraint data", - "required" : true - }, "responses" : { "201" : { - "description" : "Add Substitution Filter Constraint" + "description" : "Delete Substitution Filter Constraint" }, "400" : { "description" : "Invalid content / Missing content" @@ -27297,65 +28990,100 @@ } } }, - "summary" : "Add Component Substitution Filter Constraint", + "summary" : "Delete Component Substitution Filter Constraint", "tags" : [ "SDCE-2 APIs" ] - }, - "put" : { - "description" : "Update Component Substitution Filter Constraint", - "operationId" : "updateSubstitutionFilter", + } + }, + "/v1/catalog/{componentType}/{componentUuid}/conformanceLevelValidation" : { + "get" : { + "description" : "Validate Component Conformance Level", + "operationId" : "conformanceLevelValidation", "parameters" : [ { - "description" : "Component Id", "in" : "path", - "name" : "componentId", + "name" : "componentType", "required" : true, "schema" : { "type" : "string" } }, { - "description" : "valid value: resources / services", "in" : "path", - "name" : "componentType", + "name" : "componentUuid", "required" : true, "schema" : { - "type" : "string", - "enum" : [ "services", "services" ] + "type" : "string" } }, { - "description" : "Constraint type. Valid values: properties / capabilities", + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Component found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns the result according to conformance level in BE config", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/artifactsByType/{artifactGroupType}" : { + "get" : { + "description" : "Get component Artifacts", + "operationId" : "getComponentArtifacts", + "parameters" : [ { + "description" : "valid values: resources / services", "in" : "path", - "name" : "constraintType", + "name" : "containerComponentType", "required" : true, "schema" : { "type" : "string", - "enum" : [ "properties", "capabilities" ] + "enum" : [ "resources", "services" ] } }, { - "in" : "header", - "name" : "USER_ID", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactGroupType", + "required" : true, "schema" : { "type" : "string" } } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - }, - "description" : "UIConstraint data", - "required" : true - }, "responses" : { - "201" : { - "description" : "Update Substitution Filter Constraint" - }, - "400" : { - "description" : "Invalid content / Missing content" + "200" : { + "description" : "Component artifacts" }, - "403" : { - "description" : "Restricted operation" + "404" : { + "description" : "Resource/Artifact not found" }, "default" : { "content" : { @@ -27616,48 +29344,149 @@ } } }, - "summary" : "Update Component Substitution Filter Constraint", + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns artifacts", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}/{constraintIndex}" : { - "delete" : { - "description" : "Delete Component Substitution Filter Constraint", - "operationId" : "deleteSubstitutionFilterConstraint", + "/v1/catalog/{containerComponentType}/{componentId}/batchDeleteResourceInstances" : { + "post" : { + "description" : "Batch Delete ResourceInstances", + "operationId" : "batchDeleteResourceInstances", "parameters" : [ { - "description" : "Component Id", + "description" : "valid values: resources / services / products", + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services", "products" ] + } + }, { "in" : "path", "name" : "componentId", "required" : true, "schema" : { "type" : "string" } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Component Instance Id List", + "required" : true + }, + "responses" : { + "203" : { + "description" : "ResourceInstances deleted" + }, + "400" : { + "description" : "Invalid Content / Missing Content" + }, + "403" : { + "description" : "Restricted Operation" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupId}" : { + "get" : { + "description" : "Get group artifacts ", + "operationId" : "getGroupById", + "parameters" : [ { + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string" + } }, { - "description" : "Constraint Index", "in" : "path", - "name" : "constraintIndex", + "name" : "componentId", "required" : true, "schema" : { - "type" : "integer", - "format" : "int32" + "type" : "string" } }, { - "description" : "valid value: resources / services", "in" : "path", - "name" : "componentType", + "name" : "groupId", "required" : true, "schema" : { - "type" : "string", - "enum" : [ "services", "services" ] + "type" : "string" } }, { - "description" : "Constraint type. Valid values: properties / capabilities", + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "group found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Group not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns artifacts metadata according to groupId", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update Group metadata", + "operationId" : "updateGroup", + "parameters" : [ { "in" : "path", - "name" : "constraintType", + "name" : "containerComponentType", "required" : true, "schema" : { - "type" : "string", - "enum" : [ "properties", "capabilities" ] + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string" } }, { "in" : "header", @@ -27666,9 +29495,20 @@ "type" : "string" } } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupDefinition" + } + } + }, + "description" : "GroupDefinition", + "required" : true + }, "responses" : { - "201" : { - "description" : "Delete Substitution Filter Constraint" + "200" : { + "description" : "Group updated" }, "400" : { "description" : "Invalid content / Missing content" @@ -27676,6 +29516,9 @@ "403" : { "description" : "Restricted operation" }, + "404" : { + "description" : "component / group Not found" + }, "default" : { "content" : { "application/json" : { @@ -27935,24 +29778,35 @@ } } }, - "summary" : "Delete Component Substitution Filter Constraint", + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated Group", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{componentType}/{componentUuid}/conformanceLevelValidation" : { - "get" : { - "description" : "Validate Component Conformance Level", - "operationId" : "conformanceLevelValidation", + "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupType}" : { + "post" : { + "description" : "Create group ", + "operationId" : "createGroup", "parameters" : [ { "in" : "path", - "name" : "componentType", + "name" : "containerComponentType", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", - "name" : "componentUuid", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "groupType", "required" : true, "schema" : { "type" : "string" @@ -27965,8 +29819,11 @@ } } ], "responses" : { - "200" : { - "description" : "Component found" + "201" : { + "description" : "Group created" + }, + "400" : { + "description" : "field name invalid type/length, characters; mandatory field is absent, already exists (name)" }, "403" : { "description" : "Restricted operation" @@ -27974,13 +29831,16 @@ "404" : { "description" : "Component not found" }, + "500" : { + "description" : "Internal Error" + }, "default" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/Resource" + "$ref" : "#/components/schemas/GroupDefinition" } } } @@ -27991,22 +29851,20 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns the result according to conformance level in BE config", + "summary" : "Creates new group in component and returns it", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/artifactsByType/{artifactGroupType}" : { - "get" : { - "description" : "Get component Artifacts", - "operationId" : "getComponentArtifacts", + "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}" : { + "delete" : { + "description" : "Delete Group", + "operationId" : "deleteGroup", "parameters" : [ { - "description" : "valid values: resources / services", "in" : "path", "name" : "containerComponentType", "required" : true, "schema" : { - "type" : "string", - "enum" : [ "resources", "services" ] + "type" : "string" } }, { "in" : "path", @@ -28017,18 +29875,33 @@ } }, { "in" : "path", - "name" : "artifactGroupType", + "name" : "groupUniqueId", "required" : true, "schema" : { "type" : "string" } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } } ], "responses" : { - "200" : { - "description" : "Component artifacts" + "201" : { + "description" : "ResourceInstance deleted" + }, + "400" : { + "description" : "field name invalid type/length, characters; mandatory field is absent, already exists (name)" + }, + "403" : { + "description" : "Restricted operation" }, "404" : { - "description" : "Resource/Artifact not found" + "description" : "Component not found" + }, + "500" : { + "description" : "Internal Error" }, "default" : { "content" : { @@ -28293,22 +30166,20 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns artifacts", + "summary" : "Returns deleted group id", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/batchDeleteResourceInstances" : { + "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/members" : { "post" : { - "description" : "Batch Delete ResourceInstances", - "operationId" : "batchDeleteResourceInstances", + "description" : "Update group members ", + "operationId" : "updateGroupMembers", "parameters" : [ { - "description" : "valid values: resources / services / products", "in" : "path", "name" : "containerComponentType", "required" : true, "schema" : { - "type" : "string", - "enum" : [ "resources", "services", "products" ] + "type" : "string" } }, { "in" : "path", @@ -28317,6 +30188,102 @@ "schema" : { "type" : "string" } + }, { + "in" : "path", + "name" : "groupUniqueId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "description" : "List of members unique ids", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Group members updated" + }, + "400" : { + "description" : "field name invalid type/length, characters; mandatory field is absent, already exists (name)" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component not found" + }, + "500" : { + "description" : "Internal Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Updates list of members and returns it", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/metadata" : { + "put" : { + "description" : "Update Group Metadata", + "operationId" : "updateGroupMetadata", + "parameters" : [ { + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "groupUniqueId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } } ], "requestBody" : { "content" : { @@ -28326,31 +30293,44 @@ } } }, - "description" : "Component Instance Id List", + "description" : "Service object to be Updated", "required" : true }, "responses" : { - "203" : { - "description" : "ResourceInstances deleted" + "200" : { + "description" : "Group Updated" }, "400" : { - "description" : "Invalid Content / Missing Content" + "description" : "Invalid content / Missing content" }, "403" : { - "description" : "Restricted Operation" + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupDefinition" + } + } + } + } } }, "servers" : [ { "url" : "/sdc2/rest", "variables" : { } } ], + "summary" : "Returns updated group definition", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupId}" : { + "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/properties" : { "get" : { - "description" : "Get group artifacts ", - "operationId" : "getGroupById", + "description" : "Get List of properties on a group", + "operationId" : "getGroupProperties", "parameters" : [ { "in" : "path", "name" : "containerComponentType", @@ -28367,7 +30347,7 @@ } }, { "in" : "path", - "name" : "groupId", + "name" : "groupUniqueId", "required" : true, "schema" : { "type" : "string" @@ -28381,21 +30361,21 @@ } ], "responses" : { "200" : { - "description" : "group found" + "description" : "Group Updated" + }, + "400" : { + "description" : "Invalid content / Missing content" }, "403" : { "description" : "Restricted operation" }, - "404" : { - "description" : "Group not found" - }, "default" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/Resource" + "$ref" : "#/components/schemas/GroupProperty" } } } @@ -28406,12 +30386,12 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns artifacts metadata according to groupId", + "summary" : "Returns list of properties", "tags" : [ "SDCE-2 APIs" ] }, "put" : { - "description" : "Update Group metadata", - "operationId" : "updateGroup", + "description" : "Updates List of properties on a group (only values)", + "operationId" : "updateGroupProperties", "parameters" : [ { "in" : "path", "name" : "containerComponentType", @@ -28428,7 +30408,7 @@ } }, { "in" : "path", - "name" : "groupId", + "name" : "groupUniqueId", "required" : true, "schema" : { "type" : "string" @@ -28444,16 +30424,19 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/GroupDefinition" + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupProperty" + } } } }, - "description" : "GroupDefinition", + "description" : "Group Properties to be Updated", "required" : true }, "responses" : { "200" : { - "description" : "Group updated" + "description" : "Group Updated" }, "400" : { "description" : "Invalid content / Missing content" @@ -28461,9 +30444,61 @@ "403" : { "description" : "Restricted operation" }, - "404" : { - "description" : "component / group Not found" - }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupProperty" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated list of properties", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/paths-to-delete" : { + "get" : { + "description" : "Check if forwarding path to delete on version change", + "operationId" : "changeResourceInstanceVersion_1", + "parameters" : [ { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "componentInstanceId", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "newComponentInstanceId", + "schema" : { + "type" : "string" + } + }, { + "description" : "valid values: resources / services", + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + } ], + "responses" : { "default" : { "content" : { "application/json" : { @@ -28727,22 +30762,15 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns updated Group", + "summary" : "Returns forwarding paths to delete", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupType}" : { - "post" : { - "description" : "Create group ", - "operationId" : "createGroup", + "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}" : { + "delete" : { + "description" : "Delete Policy", + "operationId" : "deletePolicy", "parameters" : [ { - "in" : "path", - "name" : "containerComponentType", - "required" : true, - "schema" : { - "type" : "string" - } - }, { "in" : "path", "name" : "componentId", "required" : true, @@ -28750,103 +30778,42 @@ "type" : "string" } }, { - "in" : "path", - "name" : "groupType", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "201" : { - "description" : "Group created" - }, - "400" : { - "description" : "field name invalid type/length, characters; mandatory field is absent, already exists (name)" - }, - "403" : { - "description" : "Restricted operation" - }, - "404" : { - "description" : "Component not found" - }, - "500" : { - "description" : "Internal Error" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GroupDefinition" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Creates new group in component and returns it", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}" : { - "delete" : { - "description" : "Delete Group", - "operationId" : "deleteGroup", - "parameters" : [ { + "description" : "valid values: resources / services", "in" : "path", "name" : "containerComponentType", "required" : true, "schema" : { - "type" : "string" - } - }, { - "in" : "path", - "name" : "componentId", - "required" : true, - "schema" : { - "type" : "string" + "type" : "string", + "enum" : [ "resources", "services" ] } }, { "in" : "path", - "name" : "groupUniqueId", + "name" : "policyId", "required" : true, "schema" : { "type" : "string" } }, { + "description" : "USER_ID of modifier user", "in" : "header", "name" : "USER_ID", + "required" : true, "schema" : { "type" : "string" } } ], "responses" : { - "201" : { - "description" : "ResourceInstance deleted" + "204" : { + "description" : "Policy was deleted" }, "400" : { - "description" : "field name invalid type/length, characters; mandatory field is absent, already exists (name)" + "description" : "Invalid content / Missing content" }, "403" : { "description" : "Restricted operation" }, "404" : { - "description" : "Component not found" - }, - "500" : { - "description" : "Internal Error" + "description" : "component / policy Not found" }, "default" : { "content" : { @@ -29111,22 +31078,13 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns deleted group id", + "summary" : "No body", "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/members" : { - "post" : { - "description" : "Update group members ", - "operationId" : "updateGroupMembers", + }, + "get" : { + "description" : "Get Policy", + "operationId" : "getPolicy", "parameters" : [ { - "in" : "path", - "name" : "containerComponentType", - "required" : true, - "schema" : { - "type" : "string" - } - }, { "in" : "path", "name" : "componentId", "required" : true, @@ -29134,179 +31092,33 @@ "type" : "string" } }, { - "in" : "path", - "name" : "groupUniqueId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - }, - "description" : "List of members unique ids", - "required" : true - }, - "responses" : { - "200" : { - "description" : "Group members updated" - }, - "400" : { - "description" : "field name invalid type/length, characters; mandatory field is absent, already exists (name)" - }, - "403" : { - "description" : "Restricted operation" - }, - "404" : { - "description" : "Component not found" - }, - "500" : { - "description" : "Internal Error" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Updates list of members and returns it", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/metadata" : { - "put" : { - "description" : "Update Group Metadata", - "operationId" : "updateGroupMetadata", - "parameters" : [ { + "description" : "valid values: resources / services", "in" : "path", "name" : "containerComponentType", "required" : true, "schema" : { - "type" : "string" - } - }, { - "in" : "path", - "name" : "componentId", - "required" : true, - "schema" : { - "type" : "string" + "type" : "string", + "enum" : [ "resources", "services" ] } }, { "in" : "path", - "name" : "groupUniqueId", + "name" : "policyId", "required" : true, "schema" : { "type" : "string" } }, { + "description" : "USER_ID of modifier user", "in" : "header", "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - }, - "description" : "Service object to be Updated", - "required" : true - }, - "responses" : { - "200" : { - "description" : "Group Updated" - }, - "400" : { - "description" : "Invalid content / Missing content" - }, - "403" : { - "description" : "Restricted operation" - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GroupDefinition" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Returns updated group definition", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/properties" : { - "get" : { - "description" : "Get List of properties on a group", - "operationId" : "getGroupProperties", - "parameters" : [ { - "in" : "path", - "name" : "containerComponentType", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "path", - "name" : "componentId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "path", - "name" : "groupUniqueId", "required" : true, "schema" : { "type" : "string" } - }, { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } } ], "responses" : { "200" : { - "description" : "Group Updated" + "description" : "Policy was found" }, "400" : { "description" : "Invalid content / Missing content" @@ -29314,136 +31126,9 @@ "403" : { "description" : "Restricted operation" }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GroupProperty" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Returns list of properties", - "tags" : [ "SDCE-2 APIs" ] - }, - "put" : { - "description" : "Updates List of properties on a group (only values)", - "operationId" : "updateGroupProperties", - "parameters" : [ { - "in" : "path", - "name" : "containerComponentType", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "path", - "name" : "componentId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "path", - "name" : "groupUniqueId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GroupProperty" - } - } - } - }, - "description" : "Group Properties to be Updated", - "required" : true - }, - "responses" : { - "200" : { - "description" : "Group Updated" - }, - "400" : { - "description" : "Invalid content / Missing content" - }, - "403" : { - "description" : "Restricted operation" + "404" : { + "description" : "component / policy Not found" }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GroupProperty" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Returns updated list of properties", - "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/{containerComponentType}/{componentId}/paths-to-delete" : { - "get" : { - "description" : "Check if forwarding path to delete on version change", - "operationId" : "changeResourceInstanceVersion_1", - "parameters" : [ { - "in" : "path", - "name" : "componentId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "query", - "name" : "componentInstanceId", - "schema" : { - "type" : "string" - } - }, { - "in" : "query", - "name" : "newComponentInstanceId", - "schema" : { - "type" : "string" - } - }, { - "description" : "valid values: resources / services", - "in" : "path", - "name" : "containerComponentType", - "required" : true, - "schema" : { - "type" : "string", - "enum" : [ "resources", "services" ] - } - } ], - "responses" : { "default" : { "content" : { "application/json" : { @@ -29707,14 +31392,12 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns forwarding paths to delete", + "summary" : "Returns Policy", "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}" : { - "delete" : { - "description" : "Delete Policy", - "operationId" : "deletePolicy", + }, + "put" : { + "description" : "Update Policy metadata", + "operationId" : "updatePolicy", "parameters" : [ { "in" : "path", "name" : "componentId", @@ -29747,9 +31430,20 @@ "type" : "string" } } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "PolicyDefinition", + "required" : true + }, "responses" : { - "204" : { - "description" : "Policy was deleted" + "200" : { + "description" : "Policy updated" }, "400" : { "description" : "Invalid content / Missing content" @@ -30023,13 +31717,16 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "No body", + "summary" : "Returns updated Policy", "tags" : [ "SDCE-2 APIs" ] - }, + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/properties" : { "get" : { - "description" : "Get Policy", - "operationId" : "getPolicy", + "description" : "Get component policy properties", + "operationId" : "getPolicyProperties", "parameters" : [ { + "description" : "the id of the component which is the container of the policy", "in" : "path", "name" : "componentId", "required" : true, @@ -30046,6 +31743,7 @@ "enum" : [ "resources", "services" ] } }, { + "description" : "the id of the policy which its properties are to return", "in" : "path", "name" : "policyId", "required" : true, @@ -30053,7 +31751,7 @@ "type" : "string" } }, { - "description" : "USER_ID of modifier user", + "description" : "the userid", "in" : "header", "name" : "USER_ID", "required" : true, @@ -30063,16 +31761,19 @@ } ], "responses" : { "200" : { - "description" : "Policy was found" + "description" : "Properties found" }, "400" : { - "description" : "Invalid content / Missing content" + "description" : "invalid content - Error: containerComponentType is invalid" }, "403" : { "description" : "Restricted operation" }, "404" : { - "description" : "component / policy Not found" + "description" : "Componentorpolicy not found" + }, + "500" : { + "description" : "The GET request failed due to internal SDC problem." }, "default" : { "content" : { @@ -30080,253 +31781,7 @@ "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" - } - } - } - } + "$ref" : "#/components/schemas/PropertyDataDefinition" } } } @@ -30337,12 +31792,12 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns Policy", + "summary" : "Returns component policy properties", "tags" : [ "SDCE-2 APIs" ] }, "put" : { - "description" : "Update Policy metadata", - "operationId" : "updatePolicy", + "description" : "Update Policy properties", + "operationId" : "updatePolicyProperties", "parameters" : [ { "in" : "path", "name" : "componentId", @@ -30388,7 +31843,7 @@ }, "responses" : { "200" : { - "description" : "Policy updated" + "description" : "Policy properties updated" }, "400" : { "description" : "Invalid content / Missing content" @@ -30666,83 +32121,10 @@ "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/properties" : { - "get" : { - "description" : "Get component policy properties", - "operationId" : "getPolicyProperties", - "parameters" : [ { - "description" : "the id of the component which is the container of the policy", - "in" : "path", - "name" : "componentId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "description" : "valid values: resources / services", - "in" : "path", - "name" : "containerComponentType", - "required" : true, - "schema" : { - "type" : "string", - "enum" : [ "resources", "services" ] - } - }, { - "description" : "the id of the policy which its properties are to return", - "in" : "path", - "name" : "policyId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "description" : "the userid", - "in" : "header", - "name" : "USER_ID", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Properties found" - }, - "400" : { - "description" : "invalid content - Error: containerComponentType is invalid" - }, - "403" : { - "description" : "Restricted operation" - }, - "404" : { - "description" : "Componentorpolicy not found" - }, - "500" : { - "description" : "The GET request failed due to internal SDC problem." - }, - "default" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PropertyDataDefinition" - } - } - } - } - } - }, - "servers" : [ { - "url" : "/sdc2/rest", - "variables" : { } - } ], - "summary" : "Returns component policy properties", - "tags" : [ "SDCE-2 APIs" ] - }, - "put" : { - "description" : "Update Policy properties", - "operationId" : "updatePolicyProperties", + "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/targets" : { + "post" : { + "description" : "update policy targets", + "operationId" : "updatePolicyTargets", "parameters" : [ { "in" : "path", "name" : "componentId", @@ -30779,16 +32161,17 @@ "content" : { "application/json" : { "schema" : { - "type" : "string" + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PolicyTargetDTO" + } } } - }, - "description" : "PolicyDefinition", - "required" : true + } }, "responses" : { - "200" : { - "description" : "Policy properties updated" + "201" : { + "description" : "Policy target updated" }, "400" : { "description" : "Invalid content / Missing content" @@ -30796,9 +32179,6 @@ "403" : { "description" : "Restricted operation" }, - "404" : { - "description" : "component / policy Not found" - }, "default" : { "content" : { "application/json" : { @@ -31066,10 +32446,10 @@ "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/targets" : { - "post" : { - "description" : "update policy targets", - "operationId" : "updatePolicyTargets", + "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/undeclare" : { + "put" : { + "description" : "undeclare Policy", + "operationId" : "undeclarePolicy", "parameters" : [ { "in" : "path", "name" : "componentId", @@ -31102,21 +32482,9 @@ "type" : "string" } } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PolicyTargetDTO" - } - } - } - } - }, "responses" : { - "201" : { - "description" : "Policy target updated" + "204" : { + "description" : "Policy was undeclared" }, "400" : { "description" : "Invalid content / Missing content" @@ -31124,6 +32492,9 @@ "403" : { "description" : "Restricted operation" }, + "404" : { + "description" : "component / policy Not found" + }, "default" : { "content" : { "application/json" : { @@ -31387,14 +32758,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns updated Policy", + "summary" : "No body", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/undeclare" : { - "put" : { - "description" : "undeclare Policy", - "operationId" : "undeclarePolicy", + "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyTypeName}" : { + "post" : { + "description" : "Create Policy", + "operationId" : "createPolicy", "parameters" : [ { "in" : "path", "name" : "componentId", @@ -31413,7 +32784,7 @@ } }, { "in" : "path", - "name" : "policyId", + "name" : "policyTypeName", "required" : true, "schema" : { "type" : "string" @@ -31428,8 +32799,8 @@ } } ], "responses" : { - "204" : { - "description" : "Policy was undeclared" + "201" : { + "description" : "Policy created" }, "400" : { "description" : "Invalid content / Missing content" @@ -31438,7 +32809,10 @@ "description" : "Restricted operation" }, "404" : { - "description" : "component / policy Not found" + "description" : "Component not found" + }, + "409" : { + "description" : "Policy already exist" }, "default" : { "content" : { @@ -31703,61 +33077,51 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "No body", + "summary" : "Returns created Policy", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyTypeName}" : { - "post" : { - "description" : "Create Policy", - "operationId" : "createPolicy", + "/v1/catalog/{containerComponentType}/{componentId}/relationId/{relationId}" : { + "get" : { + "description" : "Get relation", + "operationId" : "getRelationById", "parameters" : [ { "in" : "path", - "name" : "componentId", + "name" : "containerComponentType", "required" : true, "schema" : { "type" : "string" } }, { - "description" : "valid values: resources / services", "in" : "path", - "name" : "containerComponentType", + "name" : "componentId", "required" : true, "schema" : { - "type" : "string", - "enum" : [ "resources", "services" ] + "type" : "string" } }, { "in" : "path", - "name" : "policyTypeName", + "name" : "relationId", "required" : true, "schema" : { "type" : "string" } }, { - "description" : "USER_ID of modifier user", "in" : "header", "name" : "USER_ID", - "required" : true, "schema" : { "type" : "string" } } ], "responses" : { - "201" : { - "description" : "Policy created" - }, - "400" : { - "description" : "Invalid content / Missing content" + "200" : { + "description" : "relation found" }, "403" : { "description" : "Restricted operation" }, "404" : { - "description" : "Component not found" - }, - "409" : { - "description" : "Policy already exist" + "description" : "Relation not found" }, "default" : { "content" : { @@ -32022,22 +33386,15 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns created Policy", + "summary" : "Returns relation metadata according to relationId", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/relationId/{relationId}" : { - "get" : { - "description" : "Get relation", - "operationId" : "getRelationById", + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance" : { + "post" : { + "description" : "Create ComponentInstance", + "operationId" : "createComponentInstance", "parameters" : [ { - "in" : "path", - "name" : "containerComponentType", - "required" : true, - "schema" : { - "type" : "string" - } - }, { "in" : "path", "name" : "componentId", "required" : true, @@ -32045,28 +33402,46 @@ "type" : "string" } }, { + "description" : "valid values: resources / services", "in" : "path", - "name" : "relationId", + "name" : "containerComponentType", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "enum" : [ "resources", "services" ] } }, { + "description" : "USER_ID of modifier user", "in" : "header", "name" : "USER_ID", + "required" : true, "schema" : { "type" : "string" } } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "RI object to be created", + "required" : true + }, "responses" : { - "200" : { - "description" : "relation found" + "201" : { + "description" : "Component created" + }, + "400" : { + "description" : "Invalid content / Missing content" }, "403" : { "description" : "Restricted operation" }, - "404" : { - "description" : "Relation not found" + "409" : { + "description" : "Component instance already exist" }, "default" : { "content" : { @@ -32331,15 +33706,16 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns relation metadata according to relationId", + "summary" : "Returns created ComponentInstance", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance" : { + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/associate" : { "post" : { - "description" : "Create ComponentInstance", - "operationId" : "createComponentInstance", + "description" : "Associate RI to RI", + "operationId" : "associateRIToRI", "parameters" : [ { + "description" : "unique id of the container component", "in" : "path", "name" : "componentId", "required" : true, @@ -32347,19 +33723,17 @@ "type" : "string" } }, { - "description" : "valid values: resources / services", + "description" : "allowed values are resources /services / products", "in" : "path", "name" : "containerComponentType", "required" : true, "schema" : { "type" : "string", - "enum" : [ "resources", "services" ] + "enum" : [ "resources", "services", "products" ] } }, { - "description" : "USER_ID of modifier user", "in" : "header", "name" : "USER_ID", - "required" : true, "schema" : { "type" : "string" } @@ -32372,21 +33746,21 @@ } } }, - "description" : "RI object to be created", + "description" : "RelationshipInfo", "required" : true }, "responses" : { "201" : { - "description" : "Component created" + "description" : "Relationship created" }, "400" : { "description" : "Invalid content / Missing content" }, "403" : { - "description" : "Restricted operation" + "description" : "Missing information" }, "409" : { - "description" : "Component instance already exist" + "description" : "Relationship already exist" }, "default" : { "content" : { @@ -32651,30 +34025,30 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns created ComponentInstance", + "summary" : "Returns created RelationshipInfo", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/associate" : { - "post" : { - "description" : "Associate RI to RI", - "operationId" : "associateRIToRI", + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/batchDissociate" : { + "put" : { + "description" : "Batch Dissociate RI from RI", + "operationId" : "batchDissociateRIFromRI", "parameters" : [ { - "description" : "unique id of the container component", + "description" : "allowed values are resources/services/products", "in" : "path", - "name" : "componentId", + "name" : "containerComponentType", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "enum" : [ "resources", "services", "products" ] } }, { - "description" : "allowed values are resources /services / products", + "description" : "unique id of the container component", "in" : "path", - "name" : "containerComponentType", + "name" : "componentId", "required" : true, "schema" : { - "type" : "string", - "enum" : [ "resources", "services", "products" ] + "type" : "string" } }, { "in" : "header", @@ -32696,16 +34070,13 @@ }, "responses" : { "201" : { - "description" : "Relationship created" + "description" : "Relationship deleted" }, "400" : { - "description" : "Invalid content / Missing content" + "description" : "Invalid Content / Missing Content" }, "403" : { - "description" : "Missing information" - }, - "409" : { - "description" : "Relationship already exist" + "description" : "Missing Information" }, "default" : { "content" : { @@ -32970,25 +34341,15 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns created RelationshipInfo", + "summary" : "Returns deleted RelationShip Info", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/batchDissociate" : { - "put" : { - "description" : "Batch Dissociate RI from RI", - "operationId" : "batchDissociateRIFromRI", + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/createAndAssociate" : { + "post" : { + "description" : "Create RI and associate RI to RI", + "operationId" : "createAndAssociateRIToRI", "parameters" : [ { - "description" : "allowed values are resources/services/products", - "in" : "path", - "name" : "containerComponentType", - "required" : true, - "schema" : { - "type" : "string", - "enum" : [ "resources", "services", "products" ] - } - }, { - "description" : "unique id of the container component", "in" : "path", "name" : "componentId", "required" : true, @@ -32996,32 +34357,27 @@ "type" : "string" } }, { - "in" : "header", - "name" : "USER_ID", + "description" : "valid values: resources / services", + "in" : "path", + "name" : "containerComponentType", + "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "enum" : [ "resources", "services", "products" ] } } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - }, - "description" : "RelationshipInfo", - "required" : true - }, "responses" : { "201" : { - "description" : "Relationship deleted" + "description" : "RI created" }, "400" : { - "description" : "Invalid Content / Missing Content" + "description" : "Invalid content / Missing content" }, "403" : { - "description" : "Missing Information" + "description" : "Restricted operation" + }, + "409" : { + "description" : "Relationship already exist" }, "default" : { "content" : { @@ -33286,43 +34642,58 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns deleted RelationShip Info", + "summary" : "Returns created RI and RelationshipInfo", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/createAndAssociate" : { - "post" : { - "description" : "Create RI and associate RI to RI", - "operationId" : "createAndAssociateRIToRI", + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/dissociate" : { + "put" : { + "description" : "Dissociate RI from RI", + "operationId" : "dissociateRIFromRI", "parameters" : [ { + "description" : "allowed values are resources /services / products", "in" : "path", - "name" : "componentId", + "name" : "containerComponentType", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "enum" : [ "resources", "services", "products" ] } }, { - "description" : "valid values: resources / services", + "description" : "unique id of the container component", "in" : "path", - "name" : "containerComponentType", + "name" : "componentId", "required" : true, "schema" : { - "type" : "string", - "enum" : [ "resources", "services", "products" ] + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" } } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "RelationshipInfo", + "required" : true + }, "responses" : { "201" : { - "description" : "RI created" + "description" : "Relationship deleted" }, "400" : { "description" : "Invalid content / Missing content" }, "403" : { - "description" : "Restricted operation" - }, - "409" : { - "description" : "Relationship already exist" + "description" : "Missing information" }, "default" : { "content" : { @@ -33587,25 +34958,15 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns created RI and RelationshipInfo", + "summary" : "Returns deleted RelationshipInfo", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/dissociate" : { - "put" : { - "description" : "Dissociate RI from RI", - "operationId" : "dissociateRIFromRI", + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/multipleComponentInstance" : { + "post" : { + "description" : "Update resource instance multiple component", + "operationId" : "updateMultipleComponentInstance", "parameters" : [ { - "description" : "allowed values are resources /services / products", - "in" : "path", - "name" : "containerComponentType", - "required" : true, - "schema" : { - "type" : "string", - "enum" : [ "resources", "services", "products" ] - } - }, { - "description" : "unique id of the container component", "in" : "path", "name" : "componentId", "required" : true, @@ -33613,10 +34974,13 @@ "type" : "string" } }, { - "in" : "header", - "name" : "USER_ID", + "description" : "valid values: resources / services / products", + "in" : "path", + "name" : "containerComponentType", + "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "enum" : [ "resources", "services", "products" ] } } ], "requestBody" : { @@ -33627,18 +34991,18 @@ } } }, - "description" : "RelationshipInfo", + "description" : "Component Instance JSON Array", "required" : true }, "responses" : { - "201" : { - "description" : "Relationship deleted" + "200" : { + "description" : "Resource instance updated" }, "400" : { "description" : "Invalid content / Missing content" }, "403" : { - "description" : "Missing information" + "description" : "Restricted operation" }, "default" : { "content" : { @@ -33903,14 +35267,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns deleted RelationshipInfo", + "summary" : "Returns updated resource instance", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/multipleComponentInstance" : { + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}" : { "post" : { - "description" : "Update resource instance multiple component", - "operationId" : "updateMultipleComponentInstance", + "description" : "Update resource instance", + "operationId" : "updateComponentInstanceMetadata", "parameters" : [ { "in" : "path", "name" : "componentId", @@ -33918,6 +35282,13 @@ "schema" : { "type" : "string" } + }, { + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } }, { "description" : "valid values: resources / services / products", "in" : "path", @@ -33928,17 +35299,6 @@ "enum" : [ "resources", "services", "products" ] } } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - }, - "description" : "Component Instance JSON Array", - "required" : true - }, "responses" : { "200" : { "description" : "Resource instance updated" @@ -34216,37 +35576,60 @@ "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}" : { + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts" : { "post" : { - "description" : "Update resource instance", - "operationId" : "updateComponentInstanceMetadata", + "description" : "Load Resource Instance artifact payload", + "operationId" : "loadComponentInstanceArtifact", "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "Content-MD5", + "schema" : { + "type" : "string" + } + }, { + "description" : "valid values: resources / services", "in" : "path", - "name" : "componentId", + "name" : "containerComponentType", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "enum" : [ "resources", "services" ] } }, { "in" : "path", - "name" : "componentInstanceId", + "name" : "componentId", "required" : true, "schema" : { "type" : "string" } }, { - "description" : "valid values: resources / services / products", "in" : "path", - "name" : "containerComponentType", + "name" : "componentInstanceId", "required" : true, "schema" : { - "type" : "string", - "enum" : [ "resources", "services", "products" ] + "type" : "string" } } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "json describe the artifact", + "required" : true + }, "responses" : { "200" : { - "description" : "Resource instance updated" + "description" : "Artifact updated" }, "400" : { "description" : "Invalid content / Missing content" @@ -34517,14 +35900,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns updated resource instance", + "summary" : "Returns updated artifact", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts" : { - "post" : { - "description" : "Load Resource Instance artifact payload", - "operationId" : "loadComponentInstanceArtifact", + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}" : { + "delete" : { + "description" : "Delete Resource Instance artifact", + "operationId" : "deleteComponentInstanceArtifact", "parameters" : [ { "in" : "header", "name" : "USER_ID", @@ -34560,6 +35943,13 @@ "schema" : { "type" : "string" } + }, { + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } } ], "requestBody" : { "content" : { @@ -34845,14 +36235,12 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns updated artifact", + "summary" : "Returns deleted artifact", "tags" : [ "SDCE-2 APIs" ] - } - }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}" : { - "delete" : { - "description" : "Delete Resource Instance artifact", - "operationId" : "deleteComponentInstanceArtifact", + }, + "post" : { + "description" : "Update Resource Instance artifact payload", + "operationId" : "updateComponentInstanceArtifact", "parameters" : [ { "in" : "header", "name" : "USER_ID", @@ -35180,25 +36568,15 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns deleted artifact", + "summary" : "Returns updated artifact", "tags" : [ "SDCE-2 APIs" ] - }, + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}/heatParams" : { "post" : { - "description" : "Update Resource Instance artifact payload", - "operationId" : "updateComponentInstanceArtifact", + "description" : "Update Resource Instance HEAT_ENV parameters", + "operationId" : "updateRIArtifact", "parameters" : [ { - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" - } - }, { - "in" : "header", - "name" : "Content-MD5", - "schema" : { - "type" : "string" - } - }, { "description" : "valid values: resources / services", "in" : "path", "name" : "containerComponentType", @@ -35517,27 +36895,29 @@ "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}/heatParams" : { + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/attributes" : { "post" : { - "description" : "Update Resource Instance HEAT_ENV parameters", - "operationId" : "updateRIArtifact", + "description" : "Update resource instance attribute", + "operationId" : "updateResourceInstanceAttribute", "parameters" : [ { - "description" : "valid values: resources / services", + "description" : "service id", "in" : "path", - "name" : "containerComponentType", + "name" : "componentId", "required" : true, "schema" : { - "type" : "string", - "enum" : [ "resources", "services" ] + "type" : "string" } }, { + "description" : "valid values: resources / services", "in" : "path", - "name" : "componentId", + "name" : "containerComponentType", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "enum" : [ "resources", "services" ] } }, { + "description" : "resource instance id", "in" : "path", "name" : "componentInstanceId", "required" : true, @@ -35545,9 +36925,9 @@ "type" : "string" } }, { - "in" : "path", - "name" : "artifactId", - "required" : true, + "description" : "id of user initiating the operation", + "in" : "header", + "name" : "USER_ID", "schema" : { "type" : "string" } @@ -35560,12 +36940,12 @@ } } }, - "description" : "json describe the artifact", + "description" : "Component Instance Properties JSON Array", "required" : true }, "responses" : { - "200" : { - "description" : "Artifact updated" + "201" : { + "description" : "Resource instance created" }, "400" : { "description" : "Invalid content / Missing content" @@ -35836,16 +37216,15 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns updated artifact", + "summary" : "Returns updated resource instance property", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/attribute" : { + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/changeVersion" : { "post" : { - "description" : "Update resource instance attribute", - "operationId" : "updateResourceInstanceAttribute", + "description" : "Update resource instance", + "operationId" : "changeResourceInstanceVersion", "parameters" : [ { - "description" : "service id", "in" : "path", "name" : "componentId", "required" : true, @@ -35853,16 +37232,6 @@ "type" : "string" } }, { - "description" : "valid values: resources / services", - "in" : "path", - "name" : "containerComponentType", - "required" : true, - "schema" : { - "type" : "string", - "enum" : [ "resources", "services" ] - } - }, { - "description" : "resource instance id", "in" : "path", "name" : "componentInstanceId", "required" : true, @@ -35870,11 +37239,13 @@ "type" : "string" } }, { - "description" : "id of user initiating the operation", - "in" : "header", - "name" : "USER_ID", + "description" : "valid values: resources / services", + "in" : "path", + "name" : "containerComponentType", + "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "enum" : [ "resources", "services" ] } } ], "responses" : { @@ -36150,15 +37521,22 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns updated resource instance attribute", + "summary" : "Returns updated resource instance", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/changeVersion" : { - "post" : { - "description" : "Update resource instance", - "operationId" : "changeResourceInstanceVersion", + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstId}" : { + "get" : { + "description" : "Get group artifacts ", + "operationId" : "getGroupArtifactById", "parameters" : [ { + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { "in" : "path", "name" : "componentId", "required" : true, @@ -36173,25 +37551,29 @@ "type" : "string" } }, { - "description" : "valid values: resources / services", "in" : "path", - "name" : "containerComponentType", + "name" : "groupInstId", "required" : true, "schema" : { - "type" : "string", - "enum" : [ "resources", "services" ] + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" } } ], "responses" : { - "201" : { - "description" : "Resource instance created" - }, - "400" : { - "description" : "Invalid content / Missing content" + "200" : { + "description" : "group found" }, "403" : { "description" : "Restricted operation" }, + "404" : { + "description" : "Group not found" + }, "default" : { "content" : { "application/json" : { @@ -36455,29 +37837,33 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns updated resource instance", + "summary" : "Returns artifacts metadata according to groupInstId", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstId}" : { - "get" : { - "description" : "Get group artifacts ", - "operationId" : "getGroupArtifactById", + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}/property" : { + "post" : { + "description" : "Update resource instance property", + "operationId" : "updateGroupInstanceProperty", "parameters" : [ { + "description" : "service id", "in" : "path", - "name" : "containerComponentType", + "name" : "componentId", "required" : true, "schema" : { "type" : "string" } }, { + "description" : "valid values: resources / services", "in" : "path", - "name" : "componentId", + "name" : "containerComponentType", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "enum" : [ "resources", "services" ] } }, { + "description" : "resource instance id", "in" : "path", "name" : "componentInstanceId", "required" : true, @@ -36485,13 +37871,15 @@ "type" : "string" } }, { + "description" : "group instance id", "in" : "path", - "name" : "groupInstId", + "name" : "groupInstanceId", "required" : true, "schema" : { "type" : "string" } }, { + "description" : "id of user initiating the operation", "in" : "header", "name" : "USER_ID", "schema" : { @@ -36499,15 +37887,15 @@ } } ], "responses" : { - "200" : { - "description" : "group found" + "201" : { + "description" : "Resource instance created" + }, + "400" : { + "description" : "Invalid content / Missing content" }, "403" : { "description" : "Restricted operation" }, - "404" : { - "description" : "Group not found" - }, "default" : { "content" : { "application/json" : { @@ -36771,14 +38159,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns artifacts metadata according to groupInstId", + "summary" : "Returns updated resource instance property", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}/property" : { + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/inputs" : { "post" : { "description" : "Update resource instance property", - "operationId" : "updateGroupInstanceProperty", + "operationId" : "updateResourceInstanceInput", "parameters" : [ { "description" : "service id", "in" : "path", @@ -36804,14 +38192,6 @@ "schema" : { "type" : "string" } - }, { - "description" : "group instance id", - "in" : "path", - "name" : "groupInstanceId", - "required" : true, - "schema" : { - "type" : "string" - } }, { "description" : "id of user initiating the operation", "in" : "header", @@ -36820,6 +38200,17 @@ "type" : "string" } } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Component Instance Properties JSON Array", + "required" : true + }, "responses" : { "201" : { "description" : "Resource instance created" @@ -37097,10 +38488,10 @@ "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/inputs" : { + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/properties" : { "post" : { "description" : "Update resource instance property", - "operationId" : "updateResourceInstanceInput", + "operationId" : "updateResourceInstanceProperties", "parameters" : [ { "description" : "service id", "in" : "path", @@ -37422,10 +38813,10 @@ "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/properties" : { - "post" : { - "description" : "Update resource instance property", - "operationId" : "updateResourceInstanceProperties", + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property/{propertyId}" : { + "delete" : { + "description" : "Update resource instance", + "operationId" : "deleteResourceInstanceProperty", "parameters" : [ { "description" : "service id", "in" : "path", @@ -37451,6 +38842,14 @@ "schema" : { "type" : "string" } + }, { + "description" : "property id", + "in" : "path", + "name" : "propertyId", + "required" : true, + "schema" : { + "type" : "string" + } }, { "description" : "id of user initiating the operation", "in" : "header", @@ -37459,17 +38858,6 @@ "type" : "string" } } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - }, - "description" : "Component Instance Properties JSON Array", - "required" : true - }, "responses" : { "201" : { "description" : "Resource instance created" @@ -37743,16 +39131,15 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns updated resource instance property", + "summary" : "Returns deleted resource instance property", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property/{propertyId}" : { + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{resourceInstanceId}" : { "delete" : { - "description" : "Update resource instance", - "operationId" : "deleteResourceInstanceProperty", + "description" : "Delete ResourceInstance", + "operationId" : "deleteResourceInstance", "parameters" : [ { - "description" : "service id", "in" : "path", "name" : "componentId", "required" : true, @@ -37760,41 +39147,25 @@ "type" : "string" } }, { - "description" : "valid values: resources / services", "in" : "path", - "name" : "containerComponentType", - "required" : true, - "schema" : { - "type" : "string", - "enum" : [ "resources", "services" ] - } - }, { - "description" : "resource instance id", - "in" : "path", - "name" : "componentInstanceId", + "name" : "resourceInstanceId", "required" : true, "schema" : { "type" : "string" } }, { - "description" : "property id", + "description" : "valid values: resources / services / products", "in" : "path", - "name" : "propertyId", + "name" : "containerComponentType", "required" : true, "schema" : { - "type" : "string" - } - }, { - "description" : "id of user initiating the operation", - "in" : "header", - "name" : "USER_ID", - "schema" : { - "type" : "string" + "type" : "string", + "enum" : [ "resources", "services", "products" ] } } ], "responses" : { "201" : { - "description" : "Resource instance created" + "description" : "ResourceInstance deleted" }, "400" : { "description" : "Invalid content / Missing content" @@ -38065,15 +39436,24 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns deleted resource instance property", + "summary" : "Returns delete resourceInstance", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{resourceInstanceId}" : { - "delete" : { - "description" : "Delete ResourceInstance", - "operationId" : "deleteResourceInstance", + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifacts/{artifactId}" : { + "get" : { + "description" : "Download component Artifact in Base64", + "operationId" : "downloadResourceInstanceArtifactBase64", "parameters" : [ { + "description" : "valid values: resources / services", + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + }, { "in" : "path", "name" : "componentId", "required" : true, @@ -38082,30 +39462,25 @@ } }, { "in" : "path", - "name" : "resourceInstanceId", + "name" : "componentInstanceId", "required" : true, "schema" : { "type" : "string" } }, { - "description" : "valid values: resources / services / products", "in" : "path", - "name" : "containerComponentType", + "name" : "artifactId", "required" : true, "schema" : { - "type" : "string", - "enum" : [ "resources", "services", "products" ] + "type" : "string" } } ], "responses" : { - "201" : { - "description" : "ResourceInstance deleted" - }, - "400" : { - "description" : "Invalid content / Missing content" + "200" : { + "description" : "ResourceInstance artifact downloaded" }, - "403" : { - "description" : "Restricted operation" + "404" : { + "description" : "ResourceInstance/Artifact not found" }, "default" : { "content" : { @@ -38370,14 +39745,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns delete resourceInstance", + "summary" : "Returns downloaded artifact", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifacts/{artifactId}" : { + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifactsByType/{artifactGroupType}" : { "get" : { - "description" : "Download component Artifact in Base64", - "operationId" : "downloadResourceInstanceArtifactBase64", + "description" : "Get component Artifacts", + "operationId" : "getComponentInstanceArtifacts", "parameters" : [ { "description" : "valid values: resources / services", "in" : "path", @@ -38403,7 +39778,7 @@ } }, { "in" : "path", - "name" : "artifactId", + "name" : "artifactGroupType", "required" : true, "schema" : { "type" : "string" @@ -38411,10 +39786,10 @@ } ], "responses" : { "200" : { - "description" : "ResourceInstance artifact downloaded" + "description" : "Component artifacts" }, "404" : { - "description" : "ResourceInstance/Artifact not found" + "description" : "Resource/Artifact not found" }, "default" : { "content" : { @@ -38679,14 +40054,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns downloaded artifact", + "summary" : "Returns artifacts", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifactsByType/{artifactGroupType}" : { - "get" : { - "description" : "Get component Artifacts", - "operationId" : "getComponentInstanceArtifacts", + "/v1/catalog/{containerComponentType}/{componentId}/update/inputs" : { + "post" : { + "description" : "Update resource inputs", + "operationId" : "updateComponentInputs", "parameters" : [ { "description" : "valid values: resources / services", "in" : "path", @@ -38703,27 +40078,27 @@ "schema" : { "type" : "string" } - }, { - "in" : "path", - "name" : "componentInstanceId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "in" : "path", - "name" : "artifactGroupType", - "required" : true, - "schema" : { - "type" : "string" - } } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "json describe the input", + "required" : true + }, "responses" : { "200" : { - "description" : "Component artifacts" + "description" : "Input updated" }, - "404" : { - "description" : "Resource/Artifact not found" + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" }, "default" : { "content" : { @@ -38988,52 +40363,52 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns artifacts", + "summary" : "Returns updated input", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{componentId}/update/inputs" : { - "post" : { - "description" : "Update resource inputs", - "operationId" : "updateComponentInputs", + "/v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/attributes" : { + "get" : { + "description" : "Get component instance attributes", + "operationId" : "getInstanceAttributesById", "parameters" : [ { - "description" : "valid values: resources / services", "in" : "path", "name" : "containerComponentType", "required" : true, "schema" : { - "type" : "string", - "enum" : [ "resources", "services" ] + "type" : "string" } }, { "in" : "path", - "name" : "componentId", + "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" : { - "type" : "string" - } - } - }, - "description" : "json describe the input", - "required" : true - }, "responses" : { "200" : { - "description" : "Input updated" - }, - "400" : { - "description" : "Invalid content / Missing content" + "description" : "Attributes found" }, "403" : { "description" : "Restricted operation" }, + "404" : { + "description" : "Component/Component Instance - not found" + }, "default" : { "content" : { "application/json" : { @@ -39297,14 +40672,14 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns updated input", + "summary" : "Returns component instance attributes", "tags" : [ "SDCE-2 APIs" ] } }, - "/v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/attributes" : { - "get" : { - "description" : "Get component instance attributes", - "operationId" : "getInstanceAttributesById", + "/v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/capability" : { + "put" : { + "description" : "Update Component Instance Capability", + "operationId" : "updateInstanceRequirement", "parameters" : [ { "in" : "path", "name" : "containerComponentType", @@ -39333,15 +40708,29 @@ "type" : "string" } } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentInstanceCapabilityUpdateModel" + } + } + }, + "description" : "Component instance capability to update", + "required" : true + }, "responses" : { "200" : { - "description" : "Attributes found" + "description" : "Resource instance capability successfully updated" + }, + "400" : { + "description" : "Invalid content / Missing content" }, "403" : { "description" : "Restricted operation" }, "404" : { - "description" : "Component/Component Instance - not found" + "description" : "Component/Component Instance/Capability not found" }, "default" : { "content" : { @@ -39606,7 +40995,7 @@ "url" : "/sdc2/rest", "variables" : { } } ], - "summary" : "Returns component instance attributes", + "summary" : "Returns updated Component Instance Capability", "tags" : [ "SDCE-2 APIs" ] } }, @@ -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" }, @@ -48750,273 +50349,292 @@ "instanceUniqueId" : { "type" : "string" }, - "invariantName" : { - "type" : "string" - }, - "invariantUUID" : { - "type" : "string" - }, + "invariantName" : { + "type" : "string" + }, + "invariantUUID" : { + "type" : "string" + }, + "isDeclaredListInput" : { + "type" : "boolean" + }, + "isFromCsar" : { + "type" : "boolean" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "normalizedName" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "policyTypeName" : { + "type" : "string" + }, + "policyTypeUid" : { + "type" : "string" + }, + "policyUUID" : { + "type" : "string" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + } + }, + "propertyConstraints" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "propertyId" : { + "type" : "string" + }, + "required" : { + "type" : "boolean" + }, + "schema" : { + "$ref" : "#/components/schemas/SchemaDefinition" + }, + "schemaProperty" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + }, + "schemaType" : { + "type" : "string" + }, + "status" : { + "type" : "string" + }, + "subPropertyInputPath" : { + "type" : "string" + }, + "targets" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "PolicyTargetDTO" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string" + }, + "uniqueIds" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "PolicyTypeDefinition" : { + "type" : "object", + "properties" : { + "creationTime" : { + "type" : "integer", + "format" : "int64" + }, + "derivedFrom" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "highestVersion" : { + "type" : "boolean" + }, + "icon" : { + "type" : "string" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "modificationTime" : { + "type" : "integer", + "format" : "int64" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDefinition" + } + }, + "targets" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "PropertyAssignmentUi" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "value" : { + "type" : "string" + } + } + }, + "PropertyConstraint" : { + "type" : "object" + }, + "PropertyDataDefinition" : { + "type" : "object", + "properties" : { + "annotations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Annotation" + } + }, + "defaultValue" : { + "type" : "string" + }, + "definition" : { + "type" : "boolean" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "getInputProperty" : { + "type" : "boolean" + }, + "getInputValues" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GetInputValueDataDefinition" + } + }, + "getPolicyValues" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GetPolicyValueDataDefinition" + } + }, + "hidden" : { + "type" : "boolean" + }, + "immutable" : { + "type" : "boolean" + }, + "inputId" : { + "type" : "string" + }, + "inputPath" : { + "type" : "string" + }, + "instanceUniqueId" : { + "type" : "string" + }, "isDeclaredListInput" : { "type" : "boolean" }, - "isFromCsar" : { - "type" : "boolean" - }, "label" : { "type" : "string" }, - "metadata" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - }, - "name" : { - "type" : "string" - }, - "normalizedName" : { - "type" : "string" - }, - "ownerId" : { - "type" : "string" - }, - "ownerIdIfEmpty" : { - "type" : "string", - "writeOnly" : true - }, - "parentPropertyType" : { - "type" : "string" - }, - "parentUniqueId" : { - "type" : "string" - }, - "password" : { - "type" : "boolean" - }, - "policyTypeName" : { - "type" : "string" - }, - "policyTypeUid" : { - "type" : "string" - }, - "policyUUID" : { - "type" : "string" - }, - "properties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PropertyDataDefinition" - } - }, - "propertyConstraints" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "propertyId" : { - "type" : "string" - }, - "required" : { + "mappedToComponentProperty" : { "type" : "boolean" }, - "schema" : { - "$ref" : "#/components/schemas/SchemaDefinition" - }, - "schemaProperty" : { - "$ref" : "#/components/schemas/PropertyDataDefinition" - }, - "schemaType" : { - "type" : "string" - }, - "status" : { - "type" : "string" - }, - "subPropertyInputPath" : { - "type" : "string" - }, - "targets" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - }, - "type" : { - "type" : "string" - }, - "uniqueId" : { - "type" : "string" - }, - "value" : { - "type" : "string" - }, - "version" : { - "type" : "string" - } - } - }, - "PolicyTargetDTO" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string" - }, - "uniqueIds" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - }, - "PolicyTypeDefinition" : { - "type" : "object", - "properties" : { - "creationTime" : { - "type" : "integer", - "format" : "int64" - }, - "derivedFrom" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "empty" : { - "type" : "boolean" - }, - "highestVersion" : { - "type" : "boolean" - }, - "icon" : { - "type" : "string" - }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, - "modificationTime" : { - "type" : "integer", - "format" : "int64" - }, - "name" : { - "type" : "string" - }, - "ownerId" : { - "type" : "string" - }, - "ownerIdIfEmpty" : { - "type" : "string", - "writeOnly" : true - }, - "properties" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PropertyDefinition" - } - }, - "targets" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "type" : { - "type" : "string" - }, - "uniqueId" : { - "type" : "string" - }, - "version" : { - "type" : "string" - } - } - }, - "PropertyAssignmentUi" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "type" : { - "type" : "string" - }, - "value" : { - "type" : "string" - } - } - }, - "PropertyConstraint" : { - "type" : "object" - }, - "PropertyDataDefinition" : { - "type" : "object", - "properties" : { - "annotations" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Annotation" - } - }, - "defaultValue" : { - "type" : "string" - }, - "definition" : { - "type" : "boolean" - }, - "description" : { - "type" : "string" - }, - "empty" : { - "type" : "boolean" - }, - "getInputProperty" : { - "type" : "boolean" - }, - "getInputValues" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GetInputValueDataDefinition" - } - }, - "getPolicyValues" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GetPolicyValueDataDefinition" - } - }, - "hidden" : { - "type" : "boolean" - }, - "immutable" : { - "type" : "boolean" - }, - "inputId" : { + "model" : { "type" : "string" }, - "inputPath" : { - "type" : "string" - }, - "instanceUniqueId" : { - "type" : "string" - }, - "isDeclaredListInput" : { - "type" : "boolean" - }, - "label" : { - "type" : "string" - }, - "metadata" : { - "type" : "object", - "additionalProperties" : { - "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" }, diff --git a/docs/swagger/swagger-sdce-7.json b/docs/swagger/swagger-sdce-7.json index c949cd36c2..603d33b066 100644 --- a/docs/swagger/swagger-sdce-7.json +++ b/docs/swagger/swagger-sdce-7.json @@ -3878,6 +3878,9 @@ "instanceUniqueId" : { "type" : "string" }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -3968,6 +3971,12 @@ "empty" : { "type" : "boolean" }, + "external" : { + "type" : "boolean" + }, + "externalName" : { + "type" : "string" + }, "leftOccurrences" : { "type" : "string" }, @@ -4041,6 +4050,12 @@ "empty" : { "type" : "boolean" }, + "external" : { + "type" : "boolean" + }, + "externalName" : { + "type" : "string" + }, "leftOccurrences" : { "type" : "string" }, @@ -4416,6 +4431,9 @@ "instanceUniqueId" : { "type" : "string" }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -4546,12 +4564,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -4616,6 +4640,10 @@ "subPropertyInputPath" : { "type" : "string" }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -4668,6 +4696,9 @@ "type" : "integer", "format" : "int64" }, + "model" : { + "type" : "string" + }, "operations" : { "type" : "object", "additionalProperties" : { @@ -4740,6 +4771,9 @@ "instanceUniqueId" : { "type" : "string" }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -4863,12 +4897,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -4927,6 +4967,10 @@ "subPropertyInputPath" : { "type" : "string" }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -5016,6 +5060,9 @@ "empty" : { "type" : "boolean" }, + "model" : { + "type" : "string" + }, "modificationTime" : { "type" : "integer", "format" : "int64" @@ -5097,6 +5144,9 @@ "inputName" : { "type" : "string" }, + "inputType" : { + "type" : "string" + }, "list" : { "type" : "boolean" }, @@ -5519,12 +5569,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -5571,6 +5627,10 @@ "subPropertyInputPath" : { "type" : "string" }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -5661,12 +5721,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -5719,6 +5785,10 @@ "subPropertyInputPath" : { "type" : "string" }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -5762,6 +5832,9 @@ "type" : "integer", "format" : "int64" }, + "model" : { + "type" : "string" + }, "operations" : { "type" : "object", "additionalProperties" : { @@ -5987,6 +6060,9 @@ "MetadataKeyDataDefinition" : { "type" : "object", "properties" : { + "defaultValue" : { + "type" : "string" + }, "empty" : { "type" : "boolean" }, @@ -6150,12 +6226,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -6211,6 +6293,10 @@ "toscaDefaultValue" : { "type" : "string" }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -6296,12 +6382,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -6348,6 +6440,10 @@ "subPropertyInputPath" : { "type" : "string" }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -6421,6 +6517,9 @@ "instanceUniqueId" : { "type" : "string" }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -6532,12 +6631,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -6611,6 +6716,10 @@ } } }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -6699,12 +6808,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -6751,6 +6866,10 @@ "subPropertyInputPath" : { "type" : "string" }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -6828,12 +6947,18 @@ "label" : { "type" : "string" }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -6880,6 +7005,10 @@ "subPropertyInputPath" : { "type" : "string" }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, "type" : { "type" : "string" }, @@ -6999,6 +7128,9 @@ "external" : { "type" : "boolean" }, + "externalName" : { + "type" : "string" + }, "leftOccurrences" : { "type" : "string" }, @@ -7065,6 +7197,9 @@ "external" : { "type" : "boolean" }, + "externalName" : { + "type" : "string" + }, "leftOccurrences" : { "type" : "string" }, @@ -7392,6 +7527,9 @@ "csarVersion" : { "type" : "string" }, + "csarVersionId" : { + "type" : "string" + }, "dataTypes" : { "type" : "array", "items" : { @@ -7484,6 +7622,9 @@ "type" : "string", "enum" : [ "CERTIFIED", "NOT_CERTIFIED_CHECKIN", "NOT_CERTIFIED_CHECKOUT" ] }, + "model" : { + "type" : "string" + }, "name" : { "type" : "string" }, @@ -7551,12 +7692,6 @@ "substitutionFilter" : { "$ref" : "#/components/schemas/SubstitutionFilterDataDefinition" }, - "substitutionFilterComponents" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/SubstitutionFilterDataDefinition" - } - }, "systemName" : { "type" : "string" }, -- cgit 1.2.3-korg