diff options
| author |   Fiete Ostkamp <Fiete.Ostkamp@telekom.de> | 2022-12-13 21:05:47 +0000 |
|---|---|---|
| committer |   Michael Morris <michael.morris@est.tech> | 2023-01-04 14:46:43 +0000 |
| commit | 8137832ef9e5163fca232e7152c4ba55b7ef6350 (patch) | |
| tree | 5a0ca48eddb889bd5cf147c49901f79b1c6e1574 /docs/openapi | |
| parent | db3e2ef238fa29e06cec3cb3f5b11fb407b161ce (diff) | |
Update openapi files in the docs
- add yaml versions of the spec to the offered apis section
- rename swagger files to openapi
Issue-ID: SDC-4308
Signed-off-by: Fiete Ostkamp <Fiete.Ostkamp@telekom.de>
Change-Id: Ie34e562ccf294c8d9f19d3cad30a5a626c3db0ba
Diffstat (limited to 'docs/openapi')
| -rw-r--r-- | docs/openapi/openapi-sdce-1.json | 10432 | ||||
| -rw-r--r-- | docs/openapi/openapi-sdce-1.yaml | 7963 | ||||
| -rw-r--r-- | docs/openapi/openapi-sdce-2-sdce-5.json | 55154 | ||||
| -rw-r--r-- | docs/openapi/openapi-sdce-2-sdce-5.yaml | 38830 | ||||
| -rw-r--r-- | docs/openapi/openapi-sdce-4.json | 346 | ||||
| -rw-r--r-- | docs/openapi/openapi-sdce-4.yaml | 249 | ||||
| -rw-r--r-- | docs/openapi/openapi-sdce-6.json | 506 | ||||
| -rw-r--r-- | docs/openapi/openapi-sdce-6.yaml | 394 | ||||
| -rw-r--r-- | docs/openapi/openapi-sdce-7.json | 8260 | ||||
| -rw-r--r-- | docs/openapi/openapi-sdce-7.yaml | 5962 |
10 files changed, 128096 insertions, 0 deletions
diff --git a/docs/openapi/openapi-sdce-1.json b/docs/openapi/openapi-sdce-1.json new file mode 100644 index 0000000000..e70283dbb5 --- /dev/null +++ b/docs/openapi/openapi-sdce-1.json @@ -0,0 +1,10432 @@ +{ + "openapi" : "3.0.1", + "info" : { + "contact" : { + "email" : "onap-discuss@lists.onap.org", + "name" : "ONAP", + "url" : "https://onap.readthedocs.io" + }, + "description" : "SDC API for onboarding (SDCE-1)", + "license" : { + "name" : "Apache 2.0", + "url" : "http://www.apache.org/licenses/LICENSE-2.0" + }, + "title" : "SPC API: SDCE-1", + "version" : "1.0" + }, + "servers" : [ { + "description" : "SDCE-1 APIs", + "url" : "/sdc" + } ], + "paths" : { + "/application.wadl" : { + "get" : { + "operationId" : "getWadl", + "responses" : { + "default" : { + "content" : { + "application/vnd.sun.wadl+xml" : { }, + "application/xml" : { } + }, + "description" : "default response" + } + } + } + }, + "/application.wadl/{path}" : { + "get" : { + "operationId" : "getExternalGrammar", + "parameters" : [ { + "in" : "path", + "name" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/xml" : { } + }, + "description" : "default response" + } + } + } + }, + "/v1.0/actuator/prometheus" : { + "get" : { + "description" : "Gets the prometheus micrometer application metrics", + "operationId" : "prometheusMetrics", + "parameters" : [ { + "description" : "The Accept header to determine the output content type", + "in" : "header", + "name" : "Accept", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "default response" + } + }, + "summary" : "Prometheus Micrometer Metrics", + "tags" : [ "SDCE-1 APIs" ] + } + }, + "/v1.0/application-configuration" : { + "post" : { + "description" : "Insert JSON schema into application config table", + "operationId" : "insertToTable", + "parameters" : [ { + "in" : "query", + "name" : "namespace", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "key", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Application Configuration" ] + } + }, + "/v1.0/application-configuration/{namespace}" : { + "get" : { + "description" : "Get List of keys and descriptions by namespace", + "operationId" : "getListOfConfigurationByNamespaceFromTable", + "parameters" : [ { + "in" : "path", + "name" : "namespace", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ApplicationConfigDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Application Configuration" ] + } + }, + "/v1.0/application-configuration/{namespace}/{key}" : { + "get" : { + "description" : "Get JSON schema by namespace and key", + "operationId" : "getFromTable", + "parameters" : [ { + "in" : "path", + "name" : "namespace", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "key", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConfigurationDataDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Application Configuration" ] + } + }, + "/v1.0/externaltesting/config" : { + "get" : { + "operationId" : "getConfig", + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "External-Testing" ] + }, + "put" : { + "operationId" : "setConfig", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClientConfiguration" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "External-Testing" ] + } + }, + "/v1.0/externaltesting/endpoints" : { + "get" : { + "operationId" : "getEndpoints", + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "External-Testing" ] + }, + "put" : { + "operationId" : "setEndpoints", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RemoteTestingEndpointDefinition" + } + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "External-Testing" ] + } + }, + "/v1.0/externaltesting/endpoints/{endpointId}/executions/{executionId}" : { + "post" : { + "operationId" : "getExecution", + "parameters" : [ { + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "executionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "External-Testing" ] + } + }, + "/v1.0/externaltesting/endpoints/{endpointId}/scenarios" : { + "get" : { + "operationId" : "getScenarios", + "parameters" : [ { + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "External-Testing" ] + } + }, + "/v1.0/externaltesting/endpoints/{endpointId}/scenarios/{scenario}/testcases" : { + "get" : { + "operationId" : "getTestcases", + "parameters" : [ { + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "scenario", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "External-Testing" ] + } + }, + "/v1.0/externaltesting/endpoints/{endpointId}/scenarios/{scenario}/testsuites" : { + "get" : { + "operationId" : "getTestsuites", + "parameters" : [ { + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "scenario", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "External-Testing" ] + } + }, + "/v1.0/externaltesting/endpoints/{endpointId}/scenarios/{scenario}/testsuites/{testsuite}/testcases/{testcase}" : { + "get" : { + "operationId" : "getTestcase", + "parameters" : [ { + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "scenario", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "testsuite", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "testcase", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "External-Testing" ] + } + }, + "/v1.0/externaltesting/executions" : { + "get" : { + "operationId" : "getValidationResult", + "parameters" : [ { + "in" : "query", + "name" : "requestId", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "endPoint", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "External-Testing" ] + }, + "post" : { + "operationId" : "execute", + "parameters" : [ { + "in" : "query", + "name" : "vspId", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "vspVersionId", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "requestId", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Attachment" + } + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "External-Testing" ] + } + }, + "/v1.0/externaltesting/testcasetree" : { + "get" : { + "operationId" : "getTestCasesAsTree", + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "External-Testing" ] + } + }, + "/v1.0/healthcheck" : { + "get" : { + "description" : "Perform health check", + "operationId" : "checkHealth", + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/HealthInfoDtos" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Health Check" ] + } + }, + "/v1.0/items" : { + "get" : { + "description" : "Get list of items according to desired filters", + "operationId" : "list", + "parameters" : [ { + "description" : "Filter by item status", + "in" : "query", + "name" : "itemStatus", + "schema" : { + "type" : "string", + "enum" : [ "ACTIVE", "ARCHIVED" ] + } + }, { + "description" : "Filter by version status", + "in" : "query", + "name" : "versionStatus", + "schema" : { + "type" : "string", + "enum" : [ "Certified", "Draft" ] + } + }, { + "description" : "Filter by item type", + "in" : "query", + "name" : "itemType", + "schema" : { + "type" : "string", + "enum" : [ "vsp", "vlm" ] + } + }, { + "description" : "Filter by user permission", + "in" : "query", + "name" : "permission", + "schema" : { + "type" : "string", + "enum" : [ "Owner", "Contributor" ] + } + }, { + "description" : "Filter by onboarding method", + "in" : "query", + "name" : "onboardingMethod", + "schema" : { + "type" : "string", + "enum" : [ "NetworkPackage", "manual" ] + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Item" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Items" ] + } + }, + "/v1.0/items/{itemId}" : { + "get" : { + "description" : "Get details of a item", + "operationId" : "getItem", + "parameters" : [ { + "in" : "path", + "name" : "itemId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Items" ] + } + }, + "/v1.0/items/{itemId}/actions" : { + "put" : { + "description" : "Acts on item version", + "operationId" : "actOn", + "parameters" : [ { + "in" : "path", + "name" : "itemId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ItemActionRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Items" ] + } + }, + "/v1.0/items/{itemId}/permissions" : { + "get" : { + "description" : "List users permissions assigned on item", + "operationId" : "list_2", + "parameters" : [ { + "in" : "path", + "name" : "itemId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ItemPermissionsDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Item Permissions" ] + } + }, + "/v1.0/items/{itemId}/permissions/{permission}" : { + "put" : { + "description" : "Update useres permission on item", + "operationId" : "updatePermissions", + "parameters" : [ { + "in" : "path", + "name" : "itemId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "permission", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ItemPermissionsRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Item Permissions" ] + } + }, + "/v1.0/items/{itemId}/versions" : { + "get" : { + "description" : "Lists item versions", + "operationId" : "list_1", + "parameters" : [ { + "in" : "path", + "name" : "itemId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/VersionDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Item Versions" ] + } + }, + "/v1.0/items/{itemId}/versions/{versionId}" : { + "get" : { + "description" : "Gets item version", + "operationId" : "get", + "parameters" : [ { + "in" : "path", + "name" : "itemId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Item Versions" ] + }, + "post" : { + "description" : "Creates a new item version", + "operationId" : "create", + "parameters" : [ { + "in" : "path", + "name" : "itemId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Item Versions" ] + } + }, + "/v1.0/items/{itemId}/versions/{versionId}/actions" : { + "put" : { + "description" : "Acts on item version", + "operationId" : "actOn_1", + "parameters" : [ { + "in" : "path", + "name" : "itemId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionActionRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Item Versions" ] + } + }, + "/v1.0/items/{itemId}/versions/{versionId}/activity-logs" : { + "get" : { + "description" : "Gets item version activity log", + "operationId" : "getActivityLog", + "parameters" : [ { + "description" : "Item Id", + "in" : "path", + "name" : "itemId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityLogDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Item Versions" ] + } + }, + "/v1.0/items/{itemId}/versions/{versionId}/conflicts" : { + "get" : { + "description" : "item version conflicts", + "operationId" : "getConflict", + "parameters" : [ { + "description" : "Item Id", + "in" : "path", + "name" : "itemId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ItemVersionConflictDto" + } + } + } + } + }, + "summary" : "Item version private copy conflicts against its public copy", + "tags" : [ "SDCE-1 APIs", "Item Version Conflicts" ] + } + }, + "/v1.0/items/{itemId}/versions/{versionId}/conflicts/{conflictId}" : { + "get" : { + "description" : "Gets item version conflict", + "operationId" : "getConflict_1", + "parameters" : [ { + "description" : "Item Id", + "in" : "path", + "name" : "itemId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "conflictId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConflictDto" + } + } + } + } + }, + "summary" : "Gets an item version private copy conflict against its public copy", + "tags" : [ "SDCE-1 APIs", "Item Version Conflicts" ] + }, + "put" : { + "description" : "Resolves item version conflict", + "operationId" : "resolveConflict", + "parameters" : [ { + "description" : "Item Id", + "in" : "path", + "name" : "itemId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "conflictId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConflictResolutionDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "summary" : "Resolves an item version private copy conflict against its public copy", + "tags" : [ "SDCE-1 APIs", "Item Version Conflicts" ] + } + }, + "/v1.0/items/{itemId}/versions/{versionId}/revisions" : { + "get" : { + "description" : "Gets item version revisions", + "operationId" : "listRevisions", + "parameters" : [ { + "in" : "path", + "name" : "itemId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActivityLogDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Item Versions" ] + } + }, + "/v1.0/notifications" : { + "get" : { + "description" : "Retrieve all user notifications", + "operationId" : "getNotifications", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "LAST_DELIVERED_EVENT_ID", + "schema" : { + "type" : "string", + "format" : "uuid" + } + }, { + "in" : "query", + "name" : "END_OF_PAGE_EVENT_ID", + "schema" : { + "type" : "string", + "format" : "uuid" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NotificationsStatusDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Notifications" ] + } + }, + "/v1.0/notifications/last-seen/{notificationId}" : { + "put" : { + "description" : "Update Last Seen Notification", + "operationId" : "updateLastSeenNotification", + "parameters" : [ { + "description" : "Notification Id", + "in" : "path", + "name" : "notificationId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateNotificationResponseStatus" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Notifications" ] + } + }, + "/v1.0/notifications/worker" : { + "get" : { + "description" : "Retrive user not delivered notifications", + "operationId" : "getNewNotificationsByOwnerId", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "LAST_DELIVERED_EVENT_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "NOTIFICATION_ROWS_LIMIT", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NotificationsStatusDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Notifications" ] + } + }, + "/v1.0/notifications/{notificationId}" : { + "put" : { + "description" : "Mark notification as read", + "operationId" : "markAsRead", + "parameters" : [ { + "description" : "Notification Id", + "in" : "path", + "name" : "notificationId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateNotificationResponseStatus" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Notifications" ] + } + }, + "/v1.0/togglz" : { + "get" : { + "description" : "Get TOGGLZ Features", + "operationId" : "getFeatures", + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/FeatureSetDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Togglz" ] + } + }, + "/v1.0/togglz/state/{state}" : { + "put" : { + "description" : "Update feature toggle state for all features", + "operationId" : "setAllFeatures", + "parameters" : [ { + "in" : "path", + "name" : "state", + "required" : true, + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Togglz" ] + } + }, + "/v1.0/togglz/{featureName}/state" : { + "get" : { + "description" : "Get feature toggle state", + "operationId" : "getFeatureState", + "parameters" : [ { + "in" : "path", + "name" : "featureName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FeatureDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Togglz" ] + } + }, + "/v1.0/togglz/{featureName}/state/{state}" : { + "put" : { + "description" : "Update feature toggle state", + "operationId" : "setFeatureState", + "parameters" : [ { + "in" : "path", + "name" : "featureName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "state", + "required" : true, + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Togglz" ] + } + }, + "/v1.0/unique-types" : { + "get" : { + "description" : "Lists unique value types", + "operationId" : "listUniqueTypes", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Unique Types" ] + } + }, + "/v1.0/unique-types/{type}/values/{value}" : { + "get" : { + "description" : "Gets unique value", + "operationId" : "getUniqueValue", + "parameters" : [ { + "description" : "The unique value type, for example: 'VlmName'", + "in" : "path", + "name" : "type", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The unique value", + "in" : "path", + "name" : "value", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Indication whether the unique value is occupied" + }, + "404" : { + "description" : "Unsupported unique type" + } + }, + "tags" : [ "SDCE-1 APIs", "Unique Types" ] + } + }, + "/v1.0/validation/{type}/validate" : { + "post" : { + "description" : "Validate a package", + "operationId" : "validateFile_1", + "parameters" : [ { + "in" : "path", + "name" : "type", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Validation" ] + } + }, + "/v1.0/vendor-license-models" : { + "get" : { + "description" : "List vendor license models", + "operationId" : "listLicenseModels", + "parameters" : [ { + "description" : "Filter to return only Vendor License Models with at least one version at this status. Currently supported values: 'Certified' , 'Draft'", + "in" : "query", + "name" : "versionFilter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Filter to only return Vendor License Models at this status.Currently supported values: 'ACTIVE' , 'ARCHIVED'.Default value = 'ACTIVE'.", + "in" : "query", + "name" : "Status", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ItemDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Models" ] + }, + "post" : { + "description" : "Create vendor license model", + "operationId" : "createLicenseModel", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VendorLicenseModelRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Models" ] + } + }, + "/v1.0/vendor-license-models/{vlmId}" : { + "delete" : { + "description" : "Delete vendor license model", + "operationId" : "deleteLicenseModel", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Models" ] + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}" : { + "get" : { + "description" : "Get vendor license model", + "operationId" : "getLicenseModel", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VendorLicenseModelEntityDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Models" ] + }, + "put" : { + "description" : "Update vendor license model", + "operationId" : "updateLicenseModel", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VendorLicenseModelRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Models" ] + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/actions" : { + "put" : { + "description" : "Update vendor license model", + "operationId" : "actOnLicenseModel", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VendorLicenseModelActionRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Models" ] + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/entitlement-pools" : { + "get" : { + "description" : "List vendor entitlement pools", + "operationId" : "listEntitlementPools", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EntitlementPoolEntityDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - Entitlement Pools" ] + }, + "post" : { + "description" : "Create vendor entitlement pool", + "operationId" : "createEntitlementPool", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitlementPoolRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - Entitlement Pools" ] + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/entitlement-pools/{entitlementPoolId}" : { + "delete" : { + "description" : "Delete vendor entitlement pool", + "operationId" : "deleteEntitlementPool", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "entitlementPoolId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - Entitlement Pools" ] + }, + "get" : { + "description" : "Get vendor entitlement pool", + "operationId" : "getEntitlementPool", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "entitlementPoolId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitlementPoolEntityDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - Entitlement Pools" ] + }, + "put" : { + "description" : "Update vendor entitlement pool", + "operationId" : "updateEntitlementPool", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "entitlementPoolId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitlementPoolRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - Entitlement Pools" ] + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/entitlement-pools/{entitlementPoolId}/limits" : { + "get" : { + "description" : "List vendor entitlement pool limits", + "operationId" : "listLimits", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model Entitlement Pool Id", + "in" : "path", + "name" : "entitlementPoolId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LimitRequestDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - Entitlement Pool Limits" ] + }, + "post" : { + "description" : "Create vendor entitlement pool limits", + "operationId" : "createLimit", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model Entitlement Pool Id", + "in" : "path", + "name" : "entitlementPoolId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LimitRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - Entitlement Pool Limits" ] + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/entitlement-pools/{entitlementPoolId}/limits/{limitId}" : { + "delete" : { + "description" : "Delete vendor entitlement pool limit", + "operationId" : "deleteLimit", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model Entitlement pool Id", + "in" : "path", + "name" : "entitlementPoolId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "limitId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - Entitlement Pool Limits" ] + }, + "get" : { + "description" : "Get vendor entitlement pool limit", + "operationId" : "getLimit", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model Entitlement Pool Id", + "in" : "path", + "name" : "entitlementPoolId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model Entitlement Pool Limit Id", + "in" : "path", + "name" : "limitId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LimitEntityDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - Entitlement Pool Limits" ] + }, + "put" : { + "description" : "Update vendor entitlement pool limit", + "operationId" : "updateLimit", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model Entitlement Pool Id", + "in" : "path", + "name" : "entitlementPoolId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "limitId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LimitRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - Entitlement Pool Limits" ] + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/feature-groups" : { + "get" : { + "description" : "List vendor feature groups", + "operationId" : "listFeatureGroups", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/FeatureGroupEntityDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - Feature Groups" ] + }, + "post" : { + "description" : "Create vendor feature group", + "operationId" : "createFeatureGroup", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FeatureGroupRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - Feature Groups" ] + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/feature-groups/{featureGroupId}" : { + "delete" : { + "description" : "Delete vendor feature group", + "operationId" : "deleteFeatureGroup", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "featureGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - Feature Groups" ] + }, + "get" : { + "description" : "Get vendor feature group", + "operationId" : "getFeatureGroup", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "featureGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FeatureGroupModelDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - Feature Groups" ] + }, + "put" : { + "description" : "Update vendor feature group", + "operationId" : "updateFeatureGroup", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "featureGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FeatureGroupUpdateRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - Feature Groups" ] + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-agreements" : { + "get" : { + "description" : "List vendor license agreements", + "operationId" : "listLicenseAgreements", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LicenseAgreementEntityDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - License Agreements" ] + }, + "post" : { + "description" : "Create vendor license agreement", + "operationId" : "createLicenseAgreement", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LicenseAgreementRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - License Agreements" ] + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-agreements/{licenseAgreementId}" : { + "delete" : { + "description" : "Delete vendor license agreement", + "operationId" : "deleteLicenseAgreement", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "licenseAgreementId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - License Agreements" ] + }, + "get" : { + "description" : "Get vendor license agreement", + "operationId" : "getLicenseAgreement", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "licenseAgreementId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LicenseAgreementModelDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - License Agreements" ] + }, + "put" : { + "description" : "Update vendor license agreement", + "operationId" : "updateLicenseAgreement", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "licenseAgreementId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LicenseAgreementUpdateRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - License Agreements" ] + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-key-groups" : { + "get" : { + "description" : "List vendor license key groups", + "operationId" : "listLicenseKeyGroups", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LicenseKeyGroupEntityDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - License Key Groups" ] + }, + "post" : { + "description" : "Create vendor license key group", + "operationId" : "createLicenseKeyGroup", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LicenseKeyGroupRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - License Key Groups" ] + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-key-groups/{licenseKeyGroupId}" : { + "delete" : { + "description" : "Delete vendor license key group", + "operationId" : "deleteLicenseKeyGroup", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "licenseKeyGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - License Key Groups" ] + }, + "get" : { + "description" : "Get vendor license key group", + "operationId" : "getLicenseKeyGroup", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "licenseKeyGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LicenseKeyGroupEntityDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - License Key Groups" ] + }, + "put" : { + "description" : "Update vendor license key group", + "operationId" : "updateLicenseKeyGroup", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "licenseKeyGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LicenseKeyGroupRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - License Key Groups" ] + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-key-groups/{licenseKeyGroupId}/limits" : { + "get" : { + "description" : "List vendor license key group limits", + "operationId" : "listLimits_1", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model License Key Group Id", + "in" : "path", + "name" : "licenseKeyGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LimitEntityDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - License Key Group Limits" ] + }, + "post" : { + "description" : "Create vendor license key group limit", + "operationId" : "createLimit_1", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model License Key Group Id", + "in" : "path", + "name" : "licenseKeyGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LimitRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - License Key Group Limits" ] + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-key-groups/{licenseKeyGroupId}/limits/{limitId}" : { + "delete" : { + "description" : "Delete vendor license key group limit", + "operationId" : "deleteLimit_1", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model license key group Id", + "in" : "path", + "name" : "licenseKeyGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "limitId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - License Key Group Limits" ] + }, + "get" : { + "description" : "Get vendor entitlement pool limit", + "operationId" : "getLimit_1", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model License Key Group", + "in" : "path", + "name" : "licenseKeyGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model License Key Group Limit Id", + "in" : "path", + "name" : "limitId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LimitEntityDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - License Key Group Limits" ] + }, + "put" : { + "description" : "Update vendor license key group limit", + "operationId" : "updateLimit_1", + "parameters" : [ { + "description" : "Vendor license model Id", + "in" : "path", + "name" : "vlmId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor license model License Key Group Id", + "in" : "path", + "name" : "licenseKeyGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "limitId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LimitRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor License Model - License Key Group Limits" ] + } + }, + "/v1.0/vendor-software-products" : { + "get" : { + "description" : "Get list of vendor software products and their description", + "operationId" : "listVsps", + "parameters" : [ { + "description" : "Filter to return only Vendor Software Products with at least one version at this status. Currently supported values: 'Certified' , 'Draft'", + "in" : "query", + "name" : "versionFilter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Filter to only return Vendor Software Products at this status.Currently supported values: 'ACTIVE' , 'ARCHIVED'.Default value = 'ACTIVE'.", + "in" : "query", + "name" : "Status", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/VspDetailsDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Products" ] + }, + "post" : { + "description" : "Create a new vendor software product", + "operationId" : "createVsp", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VspRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ItemCreationDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Products" ] + } + }, + "/v1.0/vendor-software-products/packages" : { + "get" : { + "description" : "Get list of translated CSAR files details", + "operationId" : "listPackages", + "parameters" : [ { + "description" : "Vendor Software Product status filter. Currently supported values: 'ACTIVE', 'ARCHIVED'", + "in" : "query", + "name" : "Status", + "schema" : { + "type" : "string" + } + }, { + "description" : "Category", + "in" : "query", + "name" : "category", + "schema" : { + "type" : "string" + } + }, { + "description" : "Sub-category", + "in" : "query", + "name" : "subCategory", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PackageInfoDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Products" ] + } + }, + "/v1.0/vendor-software-products/packages/{vspId}" : { + "get" : { + "description" : "Get translated CSAR file", + "operationId" : "getTranslatedFile", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "versionId", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "string", + "format" : "binary" + } + } + } + } + }, + "summary" : "Exports translated file to a zip file", + "tags" : [ "SDCE-1 APIs", "Vendor Software Products" ] + } + }, + "/v1.0/vendor-software-products/validation-vsp" : { + "get" : { + "operationId" : "getValidationVsp", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Products" ] + } + }, + "/v1.0/vendor-software-products/{vspId}" : { + "delete" : { + "operationId" : "deleteVsp", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Products" ] + }, + "get" : { + "operationId" : "getLatestVsp", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Products" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}" : { + "get" : { + "operationId" : "getVsp", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Products" ] + }, + "put" : { + "operationId" : "updateVsp", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VspDescriptionDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Products" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/actions" : { + "put" : { + "description" : "Actions on a vendor software product", + "operationId" : "actOnVendorSoftwareProduct", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionSoftwareProductActionRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "summary" : "Performs one of the following actions on a vendor software product: |Checkout: Locks it for edits by other users. Only the locking user sees the edited version.|Undo_Checkout: Unlocks it and deletes the edits that were done.|Checkin: Unlocks it and activates the edited version to all users.| Submit: Finalize its active version.|Create_Package: Creates a CSAR zip file.|", + "tags" : [ "SDCE-1 APIs", "Vendor Software Products" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/component-dependencies" : { + "get" : { + "description" : "Get component dependencies for vendor software product", + "operationId" : "list_3", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentDependencyResponseDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Dependencies" ] + }, + "post" : { + "description" : "Create a vendor software product component dependency", + "operationId" : "create_1", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentDependencyModel" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Dependencies" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/component-dependencies/{dependencyId}" : { + "delete" : { + "description" : "Delete component dependency for vendor software product", + "operationId" : "delete", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product Component Dependency Id", + "in" : "path", + "name" : "dependencyId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Dependencies" ] + }, + "get" : { + "description" : "Get component dependency for vendor software product", + "operationId" : "get_1", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product Component Dependency Id", + "in" : "path", + "name" : "dependencyId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentDependencyResponseDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Dependencies" ] + }, + "put" : { + "description" : "Update component dependency for vendor software product", + "operationId" : "update", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product Component Dependency Id", + "in" : "path", + "name" : "dependencyId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentDependencyModel" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Dependencies" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components" : { + "delete" : { + "description" : "Delete vendor software product components", + "operationId" : "deleteList_1", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Components" ] + }, + "get" : { + "description" : "List vendor software product components", + "operationId" : "list_6", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Components" ] + }, + "post" : { + "description" : "Create a vendor software product component", + "operationId" : "create_3", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Components" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}" : { + "delete" : { + "description" : "Delete vendor software product component", + "operationId" : "delete_3", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Components" ] + }, + "get" : { + "description" : "Get vendor software product component", + "operationId" : "get_3", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentData" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Components" ] + }, + "put" : { + "description" : "Update vendor software product component", + "operationId" : "update_2", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Components" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/compute-flavors" : { + "get" : { + "description" : "Get list of vendor software product component compute-flavors", + "operationId" : "list_7", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComputeDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Compute-flavors" ] + }, + "post" : { + "description" : "Create a vendor software product component compute-flavor", + "operationId" : "create_4", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComputeDetailsDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Compute-flavors" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/compute-flavors/{computeFlavorId}" : { + "delete" : { + "description" : "Delete vendor software product component compute-flavor", + "operationId" : "delete_4", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product compute-flavor Id", + "in" : "path", + "name" : "computeFlavorId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Compute-flavors" ] + }, + "get" : { + "description" : "Get vendor software product component compute-flavor", + "operationId" : "get_4", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product compute-flavor Id", + "in" : "path", + "name" : "computeFlavorId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComputeDetailsDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Compute-flavors" ] + }, + "put" : { + "description" : "Update vendor software product component compute-flavor", + "operationId" : "update_3", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product compute-flavor Id", + "in" : "path", + "name" : "computeFlavorId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComputeDetailsDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Compute-flavors" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/compute-flavors/{computeFlavorId}/questionnaire" : { + "get" : { + "description" : "Get vendor software product component compute-flavor questionnaire", + "operationId" : "getQuestionnaire_1", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product compute-flavor Id", + "in" : "path", + "name" : "computeFlavorId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/QuestionnaireResponseDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Compute-flavors" ] + }, + "put" : { + "description" : "Update vendor software product component compute-flavor questionnaire", + "operationId" : "updateQuestionnaire_1", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product compute-flavor Id", + "in" : "path", + "name" : "computeFlavorId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "required" : true + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Compute-flavors" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/images" : { + "get" : { + "description" : "List vendor software product component images", + "operationId" : "list_9", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ImageDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Images" ] + }, + "post" : { + "description" : "Create a vendor software product component image", + "operationId" : "create_6", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ImageRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Images" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/images/schema" : { + "get" : { + "operationId" : "getImageSchema", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Images" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/images/{imageId}" : { + "delete" : { + "description" : "Delete vendor software product Image", + "operationId" : "delete_6", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product Image Id", + "in" : "path", + "name" : "imageId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Images" ] + }, + "get" : { + "description" : "Get vendor software product component Image", + "operationId" : "get_6", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product Image Id", + "in" : "path", + "name" : "imageId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ImageDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Images" ] + }, + "put" : { + "description" : "Update vendor software product Image", + "operationId" : "update_5", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product Image Id", + "in" : "path", + "name" : "imageId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ImageRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Images" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/images/{imageId}/questionnaire" : { + "get" : { + "description" : "Get vendor software product component image questionnaire", + "operationId" : "getQuestionnaire_2", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product image Id", + "in" : "path", + "name" : "imageId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/QuestionnaireResponseDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Images" ] + }, + "put" : { + "description" : "Update vendor software product component image questionnaire", + "operationId" : "updateQuestionnaire_2", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product image Id", + "in" : "path", + "name" : "imageId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "required" : true + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Images" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/nics" : { + "get" : { + "description" : "List vendor software product component NICs", + "operationId" : "list_11", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NicDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component NICs" ] + }, + "post" : { + "description" : "Create a vendor software product NIC", + "operationId" : "create_8", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/NicRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component NICs" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/nics/{nicId}" : { + "delete" : { + "description" : "Delete vendor software product NIC", + "operationId" : "delete_8", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product NIC Id", + "in" : "path", + "name" : "nicId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component NICs" ] + }, + "get" : { + "description" : "Get vendor software product NIC", + "operationId" : "get_8", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product NIC Id", + "in" : "path", + "name" : "nicId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/NicDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component NICs" ] + }, + "put" : { + "description" : "Update vendor software product NIC", + "operationId" : "update_7", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product NIC Id", + "in" : "path", + "name" : "nicId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/NicRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component NICs" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/nics/{nicId}/questionnaire" : { + "get" : { + "description" : "Get vendor software product component NIC questionnaire", + "operationId" : "getQuestionnaire_3", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product NIC Id", + "in" : "path", + "name" : "nicId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/QuestionnaireResponseDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component NICs" ] + }, + "put" : { + "description" : "Update vendor software product component NIC questionnaire", + "operationId" : "updateQuestionnaire_3", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product NIC Id", + "in" : "path", + "name" : "nicId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "required" : true + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component NICs" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/processes" : { + "delete" : { + "description" : "Delete vendor software product processes", + "operationId" : "deleteList", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Processes" ] + }, + "get" : { + "description" : "List vendor software product component processes", + "operationId" : "list_5", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ProcessEntityDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Processes" ] + }, + "post" : { + "description" : "Create a vendor software product process", + "operationId" : "create_2", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProcessRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Processes" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/processes/{processId}" : { + "delete" : { + "description" : "Delete vendor software product process", + "operationId" : "delete_2", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product process Id", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Processes" ] + }, + "get" : { + "description" : "Get vendor software product process", + "operationId" : "get_2", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product process Id", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProcessEntityDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Processes" ] + }, + "put" : { + "description" : "Update vendor software product process", + "operationId" : "update_1", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product process Id", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProcessRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Processes" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/processes/{processId}/upload" : { + "delete" : { + "description" : "Delete vendor software product process uploaded file", + "operationId" : "deleteUploadedFile", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product process Id", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Processes" ] + }, + "get" : { + "description" : "Get vendor software product process uploaded file", + "operationId" : "getUploadedFile", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product process Id", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/octet-stream" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Processes" ] + }, + "post" : { + "description" : "Update vendor software product process upload", + "operationId" : "uploadFile", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product process Id", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "$ref" : "#/components/schemas/Attachment" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Processes" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/questionnaire" : { + "get" : { + "description" : "Get vendor software product component questionnaire", + "operationId" : "getQuestionnaire", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/QuestionnaireResponseDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Components" ] + }, + "put" : { + "description" : "Update vendor software product component questionnaire", + "operationId" : "updateQuestionnaire", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "required" : true + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Components" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/uploads" : { + "get" : { + "description" : "Get the filenames of uploaded files by type", + "operationId" : "list_4", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MonitoringUploadStatusDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Uploads" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/uploads/types/{type}" : { + "delete" : { + "description" : "Delete file uploaded for component", + "operationId" : "delete_1", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Upload Type", + "in" : "path", + "name" : "type", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Uploads" ] + }, + "post" : { + "description" : "Upload file for component by type", + "operationId" : "upload", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Upload Type", + "in" : "path", + "name" : "type", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "$ref" : "#/components/schemas/Attachment" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Component Uploads" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/compute-flavors" : { + "get" : { + "description" : "Get list of vendor software product compute-flavors", + "operationId" : "listComputes", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/VspComputeDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Products" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/deployment-flavors" : { + "get" : { + "description" : "List vendor software product Deployment Flavor", + "operationId" : "list_8", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DeploymentFlavorListResponseDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product deployment-flavors" ] + }, + "post" : { + "description" : "Create a vendor software product Deployment Flavor", + "operationId" : "create_5", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeploymentFlavorRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product deployment-flavors" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/deployment-flavors/schema" : { + "get" : { + "operationId" : "getSchema", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product deployment-flavors" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/deployment-flavors/{deploymentFlavorId}" : { + "delete" : { + "description" : "Delete vendor software product Deployment Flavor", + "operationId" : "delete_5", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product Deployment Flavor Id", + "in" : "path", + "name" : "deploymentFlavorId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product deployment-flavors" ] + }, + "get" : { + "description" : "Get vendor software product Deployment Flavor", + "operationId" : "get_5", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product Deployment Flavor Id", + "in" : "path", + "name" : "deploymentFlavorId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeploymentFlavorDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product deployment-flavors" ] + }, + "put" : { + "description" : "Update vendor software product Deployment Flavor", + "operationId" : "update_4", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product Deployment Flavor Id", + "in" : "path", + "name" : "deploymentFlavorId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeploymentFlavorRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product deployment-flavors" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/heal" : { + "put" : { + "description" : "Checkout and heal vendor software product questionnaire", + "operationId" : "heal", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/QuestionnaireResponseDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Products" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/networks" : { + "get" : { + "description" : "List vendor software product networks", + "operationId" : "list_10", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NetworkDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Networks" ] + }, + "post" : { + "description" : "Create a vendor software product network", + "operationId" : "create_7", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Networks" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/networks/{networkId}" : { + "delete" : { + "description" : "Delete vendor software product network", + "operationId" : "delete_7", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product network Id", + "in" : "path", + "name" : "networkId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Networks" ] + }, + "get" : { + "description" : "Get vendor software product network", + "operationId" : "get_7", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product network Id", + "in" : "path", + "name" : "networkId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Networks" ] + }, + "put" : { + "description" : "Update vendor software product network", + "operationId" : "update_6", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product network Id", + "in" : "path", + "name" : "networkId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Networks" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template" : { + "get" : { + "description" : "Get Orchestration Template (HEAT) file", + "operationId" : "getOrchestrationTemplate", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "string", + "format" : "binary" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Products" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template-candidate" : { + "delete" : { + "description" : "Delete orchestration template candidate file and its files data structure", + "operationId" : "abort", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Orchestration Template Candidate" ] + }, + "get" : { + "description" : "Get uploaded Network Package file", + "operationId" : "get_9", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "string", + "format" : "binary" + } + } + } + } + }, + "summary" : "Downloads in uploaded Network Package file", + "tags" : [ "SDCE-1 APIs", "Orchestration Template Candidate" ] + }, + "post" : { + "description" : "Uploads a HEAT package to translate", + "operationId" : "uploadOrchestrationTemplateCandidate", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UploadFileResponseDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Products" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template-candidate/manifest" : { + "get" : { + "description" : "Get uploaded HEAT file files data structure", + "operationId" : "getFilesDataStructure", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FileDataStructureDto" + } + } + } + } + }, + "summary" : "Downloads the latest HEAT package", + "tags" : [ "SDCE-1 APIs", "Orchestration Template Candidate" ] + }, + "put" : { + "description" : "Update an existing vendor software product", + "operationId" : "updateFilesDataStructure", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FileDataStructureDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Orchestration Template Candidate" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template-candidate/process" : { + "put" : { + "description" : "process Orchestration Template Candidate", + "operationId" : "process", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UploadFileResponseDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Orchestration Template Candidate" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template-candidate/upload" : { + "get" : { + "operationId" : "getLatestStatus", + "parameters" : [ { + "description" : "Vendor Software Product id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor Software Product version id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Package Upload Manager" ] + }, + "post" : { + "operationId" : "createUploadLock", + "parameters" : [ { + "description" : "Vendor Software Product id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor Software Product version id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Package Upload Manager" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/processes" : { + "delete" : { + "description" : "Delete vendor software product processes", + "operationId" : "deleteList_2", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Processes" ] + }, + "get" : { + "description" : "List vendor software product processes", + "operationId" : "list_12", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ProcessEntityDto" + } + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Processes" ] + }, + "post" : { + "description" : "Create a vendor software product process", + "operationId" : "create_9", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProcessRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Processes" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/processes/{processId}" : { + "delete" : { + "description" : "Delete vendor software product process", + "operationId" : "delete_9", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product process Id", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Processes" ] + }, + "get" : { + "description" : "Get vendor software product process", + "operationId" : "get_10", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product process Id", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProcessEntityDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Processes" ] + }, + "put" : { + "description" : "Update vendor software product process", + "operationId" : "update_8", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product process Id", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProcessRequestDto" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Processes" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/processes/{processId}/upload" : { + "delete" : { + "description" : "Delete vendor software product process uploaded file", + "operationId" : "deleteUploadedFile_1", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product process Id", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Processes" ] + }, + "get" : { + "description" : "Get vendor software product process uploaded file", + "operationId" : "getUploadedFile_1", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product process Id", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/octet-stream" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Processes" ] + }, + "post" : { + "description" : "Update vendor software product process upload", + "operationId" : "uploadFile_1", + "parameters" : [ { + "description" : "Vendor software product Id", + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Vendor software product process Id", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "$ref" : "#/components/schemas/Attachment" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Product Processes" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/questionnaire" : { + "get" : { + "description" : "Get vendor software product questionnaire", + "operationId" : "getQuestionnaire_4", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/QuestionnaireResponseDto" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Products" ] + }, + "put" : { + "description" : "Update vendor software product questionnaire", + "operationId" : "updateQuestionnaire_4", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "required" : true + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Products" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/vnfrepository/vnfpackage/{csarId}/download" : { + "get" : { + "description" : "Download VNF package from VNF Repository", + "operationId" : "downloadVnfPackage", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "csarId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "string", + "format" : "binary" + } + } + } + } + }, + "summary" : "Download VNF package from VNF repository and send to client", + "tags" : [ "SDCE-1 APIs", "VNF Repository packages" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/vnfrepository/vnfpackage/{csarId}/import" : { + "post" : { + "description" : "Import VNF package from VNF Repository", + "operationId" : "importVnfPackage", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "csarId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UploadFileResponseDto" + } + } + } + } + }, + "summary" : "Call VNF Repository to download VNF package, validate it and send the response", + "tags" : [ "SDCE-1 APIs", "VNF Repository packages" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/vnfrepository/vnfpackages" : { + "get" : { + "description" : "Get VNF packages from VNF Repository", + "operationId" : "getVnfPackages", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Version Id", + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "string", + "format" : "binary" + } + } + } + } + }, + "summary" : "Call VNF Repository to get VNF package details", + "tags" : [ "SDCE-1 APIs", "VNF Repository packages" ] + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/vspInformationArtifact" : { + "get" : { + "description" : "Get vendor software product information artifact for specified version", + "operationId" : "getVspInformationArtifact", + "parameters" : [ { + "in" : "path", + "name" : "vspId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "versionId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "text/plain" : { + "schema" : { + "type" : "string", + "format" : "binary" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Vendor Software Products" ] + } + }, + "/workflow/v1.0/actions" : { + "get" : { + "description" : "List Filtered Actions ", + "operationId" : "getFilteredActions", + "parameters" : [ { + "in" : "query", + "name" : "vendor", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "category", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "modelId", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "componentId", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ListResponseWrapper" + } + } + } + } + }, + "summary" : "Get list of actions based on a filter criteria | If no filter is sent all actions will be returned", + "tags" : [ "SDCE-1 APIs", "Actions" ] + }, + "post" : { + "description" : "Create a new Action", + "operationId" : "createAction", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Actions" ] + } + }, + "/workflow/v1.0/actions/components" : { + "get" : { + "description" : "List OPENECOMP Components supported by Action Library", + "operationId" : "getOpenEcompComponents", + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ListResponseWrapper" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Actions" ] + } + }, + "/workflow/v1.0/actions/{actionInvariantUuId}" : { + "delete" : { + "description" : "Delete Action", + "operationId" : "deleteAction", + "parameters" : [ { + "in" : "path", + "name" : "actionInvariantUuId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Actions" ] + }, + "get" : { + "description" : "List Actions For Given Action Invariant UuId", + "operationId" : "getActionsByActionInvariantUuId", + "parameters" : [ { + "in" : "path", + "name" : "actionInvariantUuId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "version", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ListResponseWrapper" + } + } + } + } + }, + "tags" : [ "SDCE-1 APIs", "Actions" ] + }, + "post" : { + "description" : "Actions on a action", + "operationId" : "actOnAction", + "parameters" : [ { + "in" : "path", + "name" : "actionInvariantUuId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "summary" : "Performs one of the following actions on a action: |Checkout: Locks it for edits by other users. Only the locking user sees the edited version.|Undo_Checkout: Unlocks it and deletes the edits that were done.|Checkin: Unlocks it and activates the edited version to all users.| Submit: Finalize its active version.|", + "tags" : [ "SDCE-1 APIs", "Actions" ] + }, + "put" : { + "description" : "Update an existing action", + "operationId" : "updateAction", + "parameters" : [ { + "in" : "path", + "name" : "actionInvariantUuId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Actions" ] + } + }, + "/workflow/v1.0/actions/{actionInvariantUuId}/artifacts" : { + "post" : { + "description" : "Upload new Artifact", + "operationId" : "uploadArtifact_1", + "parameters" : [ { + "in" : "path", + "name" : "actionInvariantUuId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "Content-MD5", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "string" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Actions" ] + } + }, + "/workflow/v1.0/actions/{actionInvariantUuId}/artifacts/{artifactUuId}" : { + "delete" : { + "description" : "Delete Artifact", + "operationId" : "deleteArtifact", + "parameters" : [ { + "in" : "path", + "name" : "actionInvariantUuId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactUuId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Actions" ] + }, + "put" : { + "description" : "Update an existing artifact", + "operationId" : "updateArtifact_1", + "parameters" : [ { + "in" : "path", + "name" : "actionInvariantUuId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactUuId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "Content-MD5", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "string" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Actions" ] + } + }, + "/workflow/v1.0/actions/{actionUuId}/artifacts/{artifactUuId}" : { + "get" : { + "description" : "Downloads artifact for action", + "operationId" : "downloadArtifact", + "parameters" : [ { + "in" : "path", + "name" : "actionUuId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactUuId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/octet-stream" : { } + }, + "description" : "default response" + } + }, + "tags" : [ "SDCE-1 APIs", "Actions" ] + } + } + }, + "components" : { + "schemas" : { + "ActionResponseDto" : { + "type" : "object", + "properties" : { + "actionInvariantUuId" : { + "type" : "string" + }, + "actionUuId" : { + "type" : "string" + }, + "categoryList" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "status" : { + "type" : "string" + }, + "supportedComponents" : { + "type" : "array", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + } + }, + "supportedModels" : { + "type" : "array", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + } + }, + "timestamp" : { + "type" : "string" + }, + "updatedBy" : { + "type" : "string" + }, + "vendorList" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "version" : { + "type" : "string" + } + } + }, + "ActivityLogDto" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "status" : { + "$ref" : "#/components/schemas/ActivityStatus" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time" + }, + "type" : { + "type" : "string" + }, + "user" : { + "type" : "string" + } + } + }, + "ActivityStatus" : { + "type" : "object", + "properties" : { + "message" : { + "type" : "string" + }, + "success" : { + "type" : "boolean" + } + } + }, + "ApplicationConfigDto" : { + "type" : "object", + "properties" : { + "key" : { + "type" : "string" + }, + "value" : { + "type" : "string" + } + } + }, + "Artifact" : { + "type" : "object", + "properties" : { + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ErrorMessage" + } + }, + "fileName" : { + "type" : "string" + }, + "type" : { + "type" : "string", + "enum" : [ "HEAT", "HEAT_ENV", "HEAT_NET", "HEAT_VOL", "CHEF", "PUPPET", "SHELL", "YANG", "YANG_XML", "BPEL", "DG_XML", "MURANO_PKG", "VENDOR_LICENSE", "VF_LICENSE", "CLOUD_TECHNOLOGY_SPECIFIC_ARTIFACT", "CONTROLLER_BLUEPRINT_ARCHIVE", "HELM", "OTHER", "PNF_SW_INFORMATION", "PM_DICTIONARY" ] + } + } + }, + "Attachment" : { + "type" : "object", + "properties" : { + "contentDisposition" : { + "$ref" : "#/components/schemas/ContentDisposition" + }, + "contentId" : { + "type" : "string" + }, + "contentType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "dataHandler" : { + "type" : "object", + "properties" : { + "allCommands" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "commandClass" : { + "type" : "string" + }, + "commandName" : { + "type" : "string" + } + } + } + }, + "commandMap" : { + "type" : "object", + "properties" : { + "mimeTypes" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, + "writeOnly" : true + }, + "content" : { + "type" : "object" + }, + "contentType" : { + "type" : "string" + }, + "dataSource" : { + "type" : "object", + "properties" : { + "contentType" : { + "type" : "string" + }, + "inputStream" : { + "type" : "object" + }, + "name" : { + "type" : "string" + }, + "outputStream" : { + "type" : "object" + } + } + }, + "inputStream" : { + "type" : "object" + }, + "name" : { + "type" : "string" + }, + "outputStream" : { + "type" : "object" + }, + "preferredCommands" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "commandClass" : { + "type" : "string" + }, + "commandName" : { + "type" : "string" + } + } + } + }, + "transferDataFlavors" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "defaultRepresentationClassAsString" : { + "type" : "string" + }, + "flavorJavaFileListType" : { + "type" : "boolean" + }, + "flavorRemoteObjectType" : { + "type" : "boolean" + }, + "flavorSerializedObjectType" : { + "type" : "boolean" + }, + "flavorTextType" : { + "type" : "boolean" + }, + "humanPresentableName" : { + "type" : "string" + }, + "mimeType" : { + "type" : "string" + }, + "mimeTypeSerializedObject" : { + "type" : "boolean" + }, + "primaryType" : { + "type" : "string" + }, + "representationClassByteBuffer" : { + "type" : "boolean" + }, + "representationClassCharBuffer" : { + "type" : "boolean" + }, + "representationClassInputStream" : { + "type" : "boolean" + }, + "representationClassReader" : { + "type" : "boolean" + }, + "representationClassRemote" : { + "type" : "boolean" + }, + "representationClassSerializable" : { + "type" : "boolean" + }, + "subType" : { + "type" : "string" + } + } + } + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, + "object" : { + "type" : "object" + } + } + }, + "ChoiceOrOtherDtoLicenseTerm" : { + "type" : "object", + "properties" : { + "choice" : { + "type" : "string", + "enum" : [ "Fixed_Term", "Perpetual", "Unlimited", "Other" ] + }, + "other" : { + "type" : "string" + } + }, + "required" : [ "choice", "other" ] + }, + "ClientConfiguration" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean" + } + } + }, + "CommitRequestDto" : { + "type" : "object", + "properties" : { + "message" : { + "type" : "string" + } + } + }, + "ComponentComputeAssociation" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string" + }, + "computeFlavorId" : { + "type" : "string" + } + } + }, + "ComponentData" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "name" : { + "type" : "string" + } + } + }, + "ComponentDependencyModel" : { + "type" : "object", + "properties" : { + "relationType" : { + "type" : "string" + }, + "sourceId" : { + "type" : "string" + }, + "targetId" : { + "type" : "string" + } + } + }, + "ComponentDependencyResponseDto" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" + }, + "relationType" : { + "type" : "string" + }, + "sourceId" : { + "type" : "string" + }, + "targetId" : { + "type" : "string" + } + } + }, + "ComponentDto" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string" + }, + "displayName" : { + "type" : "string", + "maxLength" : 30, + "minLength" : 1 + }, + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + } + }, + "required" : [ "displayName" ] + }, + "ComponentRequestDto" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string" + }, + "displayName" : { + "type" : "string", + "maxLength" : 30, + "minLength" : 1 + }, + "name" : { + "type" : "string" + } + }, + "required" : [ "displayName" ] + }, + "ComputeDetailsDto" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "maxLength" : 300, + "minLength" : 0 + }, + "name" : { + "type" : "string", + "maxLength" : 30, + "minLength" : 0 + } + }, + "required" : [ "name" ] + }, + "ComputeDto" : { + "type" : "object", + "properties" : { + "associatedToDeploymentFlavor" : { + "type" : "boolean" + }, + "description" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + } + } + }, + "ConfigurationDataDto" : { + "type" : "object", + "properties" : { + "timeStamp" : { + "type" : "integer", + "format" : "int64" + }, + "value" : { + "type" : "string" + } + } + }, + "ConflictDto" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "theirs" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "type" : { + "type" : "string", + "enum" : [ "itemVersion", "VendorLicenseModel", "LicenseAgreements", "LicenseAgreement", "FeatureGroups", "FeatureGroup", "LicenseKeyGroups", "LicenseKeyGroup", "EntitlementPools", "EntitlementPool", "Limits", "Limit", "VendorSoftwareProduct", "VSPQuestionnaire", "VspModel", "NetworkPackage", "OrchestrationTemplateCandidate", "OrchestrationTemplateCandidateContent", "OrchestrationTemplateCandidateValidationData", "ORIGINAL_ONBOARDED_PACKAGE", "OrchestrationTemplateStructure", "OrchestrationTemplate", "OrchestrationTemplateValidationData", "OrchestrationTemplateContent", "Networks", "Network", "Components", "Component", "ComponentQuestionnaire", "ComponentDependencies", "ComponentDependency", "Nics", "Nic", "NicQuestionnaire", "Mibs", "SNMP_POLL", "SNMP_TRAP", "VES_EVENTS", "Processes", "Process", "DeploymentFlavors", "DeploymentFlavor", "Computes", "Compute", "ComputeQuestionnaire", "Images", "Image", "ImageQuestionnaire", "ServiceModel", "EnrichedServiceModel", "ServiceTemplate", "Templates", "Artifact", "Artifacts", "test" ] + }, + "yours" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + } + } + }, + "ConflictInfoDto" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "type" : { + "type" : "string", + "enum" : [ "itemVersion", "VendorLicenseModel", "LicenseAgreements", "LicenseAgreement", "FeatureGroups", "FeatureGroup", "LicenseKeyGroups", "LicenseKeyGroup", "EntitlementPools", "EntitlementPool", "Limits", "Limit", "VendorSoftwareProduct", "VSPQuestionnaire", "VspModel", "NetworkPackage", "OrchestrationTemplateCandidate", "OrchestrationTemplateCandidateContent", "OrchestrationTemplateCandidateValidationData", "ORIGINAL_ONBOARDED_PACKAGE", "OrchestrationTemplateStructure", "OrchestrationTemplate", "OrchestrationTemplateValidationData", "OrchestrationTemplateContent", "Networks", "Network", "Components", "Component", "ComponentQuestionnaire", "ComponentDependencies", "ComponentDependency", "Nics", "Nic", "NicQuestionnaire", "Mibs", "SNMP_POLL", "SNMP_TRAP", "VES_EVENTS", "Processes", "Process", "DeploymentFlavors", "DeploymentFlavor", "Computes", "Compute", "ComputeQuestionnaire", "Images", "Image", "ImageQuestionnaire", "ServiceModel", "EnrichedServiceModel", "ServiceTemplate", "Templates", "Artifact", "Artifacts", "test" ] + } + } + }, + "ConflictResolutionDto" : { + "type" : "object", + "properties" : { + "otherResolution" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "resolution" : { + "type" : "string", + "enum" : [ "THEIRS", "YOURS", "OTHER" ] + } + } + }, + "ContentDisposition" : { + "type" : "object", + "properties" : { + "filename" : { + "type" : "string" + }, + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "type" : { + "type" : "string" + } + } + }, + "DeploymentFlavorDto" : { + "type" : "object", + "properties" : { + "componentComputeAssociations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentComputeAssociation" + } + }, + "description" : { + "type" : "string", + "maxLength" : 300, + "minLength" : 0 + }, + "featureGroupId" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "model" : { + "type" : "string", + "maxLength" : 30, + "minLength" : 0 + } + }, + "required" : [ "model" ] + }, + "DeploymentFlavorListResponseDto" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "model" : { + "type" : "string" + } + } + }, + "DeploymentFlavorRequestDto" : { + "type" : "object", + "properties" : { + "componentComputeAssociations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentComputeAssociation" + } + }, + "description" : { + "type" : "string", + "maxLength" : 300, + "minLength" : 0 + }, + "featureGroupId" : { + "type" : "string" + }, + "model" : { + "type" : "string", + "maxLength" : 30, + "minLength" : 0 + } + }, + "required" : [ "model" ] + }, + "EntitlementPoolEntityDto" : { + "type" : "object", + "description" : "EntitlementPoolEntity", + "properties" : { + "description" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + }, + "expiryDate" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "increments" : { + "type" : "string", + "maxLength" : 120, + "minLength" : 0 + }, + "manufacturerReferenceNumber" : { + "type" : "string", + "maxLength" : 100, + "minLength" : 0 + }, + "name" : { + "type" : "string", + "maxLength" : 120, + "minLength" : 0 + }, + "operationalScope" : { + "$ref" : "#/components/schemas/MultiChoiceOrOtherDtoOperationalScope" + }, + "referencingFeatureGroups" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "startDate" : { + "type" : "string" + }, + "thresholdUnits" : { + "type" : "string", + "enum" : [ "Absolute", "Percentage" ] + }, + "thresholdValue" : { + "type" : "integer", + "format" : "int32" + }, + "type" : { + "type" : "string", + "enum" : [ "Universal", "Unique", "One_Time" ] + }, + "versionUUID" : { + "type" : "string" + } + }, + "required" : [ "manufacturerReferenceNumber", "name", "type" ] + }, + "EntitlementPoolRequestDto" : { + "type" : "object", + "description" : "EntitlementPoolRequest", + "properties" : { + "description" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + }, + "expiryDate" : { + "type" : "string" + }, + "increments" : { + "type" : "string", + "maxLength" : 120, + "minLength" : 0 + }, + "manufacturerReferenceNumber" : { + "type" : "string", + "maxLength" : 100, + "minLength" : 0 + }, + "name" : { + "type" : "string", + "maxLength" : 120, + "minLength" : 0 + }, + "operationalScope" : { + "$ref" : "#/components/schemas/MultiChoiceOrOtherDtoOperationalScope" + }, + "startDate" : { + "type" : "string" + }, + "thresholdUnits" : { + "type" : "string", + "enum" : [ "Absolute", "Percentage" ] + }, + "thresholdValue" : { + "type" : "integer", + "format" : "int32" + }, + "type" : { + "type" : "string", + "enum" : [ "Universal", "Unique", "One_Time" ] + } + }, + "required" : [ "manufacturerReferenceNumber", "name", "type" ] + }, + "ErrorMessage" : { + "type" : "object", + "properties" : { + "level" : { + "type" : "string", + "enum" : [ "ERROR", "WARNING", "INFO" ] + }, + "message" : { + "type" : "string" + } + } + }, + "FeatureDto" : { + "type" : "object", + "properties" : { + "active" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + } + } + }, + "FeatureGroupEntityDto" : { + "type" : "object", + "description" : "FeatureGroupEntity", + "properties" : { + "description" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + }, + "entitlementPoolsIds" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "maxItems" : 2147483647, + "minItems" : 1, + "uniqueItems" : true + }, + "id" : { + "type" : "string" + }, + "licenseKeyGroupsIds" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "name" : { + "type" : "string", + "maxLength" : 120, + "minLength" : 0 + }, + "partNumber" : { + "type" : "string" + }, + "referencingLicenseAgreements" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + }, + "required" : [ "name", "partNumber" ] + }, + "FeatureGroupModelDto" : { + "type" : "object", + "description" : "FeatureGroupModel", + "properties" : { + "description" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + }, + "entitlementPools" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EntitlementPoolEntityDto" + } + }, + "id" : { + "type" : "string" + }, + "licenseKeyGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LicenseKeyGroupEntityDto" + } + }, + "name" : { + "type" : "string", + "maxLength" : 120, + "minLength" : 0 + }, + "partNumber" : { + "type" : "string" + }, + "referencingLicenseAgreements" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + }, + "required" : [ "name", "partNumber" ] + }, + "FeatureGroupRequestDto" : { + "type" : "object", + "description" : "FeatureGroupRequest", + "properties" : { + "addedEntitlementPoolsIds" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "addedLicenseKeyGroupsIds" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + }, + "name" : { + "type" : "string", + "maxLength" : 120, + "minLength" : 0 + }, + "partNumber" : { + "type" : "string" + } + }, + "required" : [ "name", "partNumber" ] + }, + "FeatureGroupUpdateRequestDto" : { + "type" : "object", + "description" : "FeatureGroupUpdateRequest", + "properties" : { + "addedEntitlementPoolsIds" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "addedLicenseKeyGroupsIds" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + }, + "name" : { + "type" : "string", + "maxLength" : 120, + "minLength" : 0 + }, + "partNumber" : { + "type" : "string" + }, + "removedEntitlementPoolsIds" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "removedLicenseKeyGroupsIds" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + }, + "required" : [ "name", "partNumber" ] + }, + "FeatureSetDto" : { + "type" : "object", + "properties" : { + "features" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/FeatureDto" + }, + "uniqueItems" : true + } + } + }, + "FileDataStructureDto" : { + "type" : "object", + "properties" : { + "artifacts" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "modules" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Module" + } + }, + "nested" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "unassigned" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "HealthInfoDto" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string" + }, + "healthCheckComponent" : { + "type" : "string", + "enum" : [ "BE", "Cassandra", "Zusammen" ] + }, + "healthStatus" : { + "type" : "string", + "enum" : [ "UP", "DOWN" ] + }, + "version" : { + "type" : "string" + } + } + }, + "HealthInfoDtos" : { + "type" : "object", + "properties" : { + "healthInfos" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HealthInfoDto" + } + } + } + }, + "HeatStructureTree" : { + "type" : "object", + "properties" : { + "artifacts" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Artifact" + }, + "uniqueItems" : true + }, + "base" : { + "type" : "boolean" + }, + "env" : { + "$ref" : "#/components/schemas/HeatStructureTree" + }, + "errors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ErrorMessage" + } + }, + "fileName" : { + "type" : "string" + }, + "heat" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HeatStructureTree" + }, + "uniqueItems" : true + }, + "helm" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HeatStructureTree" + }, + "uniqueItems" : true + }, + "nested" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HeatStructureTree" + }, + "uniqueItems" : true + }, + "network" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HeatStructureTree" + }, + "uniqueItems" : true + }, + "other" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HeatStructureTree" + }, + "uniqueItems" : true + }, + "type" : { + "type" : "string", + "enum" : [ "HEAT", "HEAT_ENV", "HEAT_NET", "HEAT_VOL", "CHEF", "PUPPET", "SHELL", "YANG", "YANG_XML", "BPEL", "DG_XML", "MURANO_PKG", "VENDOR_LICENSE", "VF_LICENSE", "CLOUD_TECHNOLOGY_SPECIFIC_ARTIFACT", "CONTROLLER_BLUEPRINT_ARCHIVE", "HELM", "OTHER", "PNF_SW_INFORMATION", "PM_DICTIONARY" ] + }, + "volume" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HeatStructureTree" + }, + "uniqueItems" : true + } + } + }, + "ImageDto" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string" + }, + "fileName" : { + "type" : "string" + }, + "id" : { + "type" : "string" + } + }, + "required" : [ "fileName" ] + }, + "ImageRequestDto" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string" + }, + "fileName" : { + "type" : "string" + } + }, + "required" : [ "fileName" ] + }, + "Item" : { + "type" : "object", + "properties" : { + "creationTime" : { + "type" : "string", + "format" : "date-time" + }, + "description" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "modificationTime" : { + "type" : "string", + "format" : "date-time" + }, + "name" : { + "type" : "string" + }, + "owner" : { + "type" : "string" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "status" : { + "type" : "string", + "enum" : [ "ACTIVE", "ARCHIVED" ] + }, + "type" : { + "type" : "string" + }, + "versionStatusCounters" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "ItemActionRequestDto" : { + "type" : "object", + "properties" : { + "action" : { + "type" : "string", + "enum" : [ "ARCHIVE", "RESTORE" ] + } + } + }, + "ItemCreationDto" : { + "type" : "object", + "properties" : { + "itemId" : { + "type" : "string" + }, + "version" : { + "$ref" : "#/components/schemas/VersionDto" + } + } + }, + "ItemDto" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "owner" : { + "type" : "string" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "status" : { + "type" : "string" + }, + "type" : { + "type" : "string" + } + } + }, + "ItemPermissionsDto" : { + "type" : "object", + "properties" : { + "permission" : { + "type" : "string" + }, + "userId" : { + "type" : "string" + } + } + }, + "ItemPermissionsRequestDto" : { + "type" : "object", + "description" : "ItemPermissionsRequest", + "properties" : { + "addedUsersIds" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "removedUsersIds" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + } + }, + "ItemVersionConflictDto" : { + "type" : "object", + "properties" : { + "conflict" : { + "$ref" : "#/components/schemas/ConflictDto" + }, + "conflictInfoList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ConflictInfoDto" + } + } + } + }, + "LicenseAgreementEntityDto" : { + "type" : "object", + "description" : "LicenseAgreementEntity", + "properties" : { + "description" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + }, + "featureGroupsIds" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "maxItems" : 2147483647, + "minItems" : 1, + "uniqueItems" : true + }, + "id" : { + "type" : "string" + }, + "licenseTerm" : { + "$ref" : "#/components/schemas/ChoiceOrOtherDtoLicenseTerm" + }, + "name" : { + "type" : "string", + "maxLength" : 120, + "minLength" : 0 + }, + "requirementsAndConstrains" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + } + }, + "required" : [ "licenseTerm", "name" ] + }, + "LicenseAgreementModelDto" : { + "type" : "object", + "description" : "LicenseAgreementModel", + "properties" : { + "description" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + }, + "featureGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/FeatureGroupEntityDto" + }, + "uniqueItems" : true + }, + "id" : { + "type" : "string" + }, + "licenseTerm" : { + "$ref" : "#/components/schemas/ChoiceOrOtherDtoLicenseTerm" + }, + "name" : { + "type" : "string", + "maxLength" : 120, + "minLength" : 0 + }, + "requirementsAndConstrains" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + } + }, + "required" : [ "licenseTerm", "name" ] + }, + "LicenseAgreementRequestDto" : { + "type" : "object", + "description" : "LicenseAgreementRequest", + "properties" : { + "addedFeatureGroupsIds" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + }, + "licenseTerm" : { + "$ref" : "#/components/schemas/ChoiceOrOtherDtoLicenseTerm" + }, + "name" : { + "type" : "string", + "maxLength" : 120, + "minLength" : 0 + }, + "requirementsAndConstrains" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + } + }, + "required" : [ "licenseTerm", "name" ] + }, + "LicenseAgreementUpdateRequestDto" : { + "type" : "object", + "description" : "LicenseAgreementUpdateRequest", + "properties" : { + "addedFeatureGroupsIds" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + }, + "licenseTerm" : { + "$ref" : "#/components/schemas/ChoiceOrOtherDtoLicenseTerm" + }, + "name" : { + "type" : "string", + "maxLength" : 120, + "minLength" : 0 + }, + "removedFeatureGroupsIds" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "requirementsAndConstrains" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + } + }, + "required" : [ "licenseTerm", "name" ] + }, + "LicenseKeyGroupEntityDto" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + }, + "expiryDate" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "increments" : { + "type" : "string", + "maxLength" : 120, + "minLength" : 0 + }, + "manufacturerReferenceNumber" : { + "type" : "string", + "maxLength" : 100, + "minLength" : 0 + }, + "name" : { + "type" : "string", + "maxLength" : 120, + "minLength" : 0 + }, + "operationalScope" : { + "$ref" : "#/components/schemas/MultiChoiceOrOtherDtoOperationalScope" + }, + "referencingFeatureGroups" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "startDate" : { + "type" : "string" + }, + "thresholdUnits" : { + "type" : "string", + "enum" : [ "Absolute", "Percentage" ] + }, + "thresholdValue" : { + "type" : "integer", + "format" : "int32" + }, + "type" : { + "type" : "string", + "enum" : [ "Universal", "Unique", "One_Time" ] + }, + "versionUUID" : { + "type" : "string" + } + }, + "required" : [ "name", "type" ] + }, + "LicenseKeyGroupRequestDto" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + }, + "expiryDate" : { + "type" : "string" + }, + "increments" : { + "type" : "string", + "maxLength" : 120, + "minLength" : 0 + }, + "manufacturerReferenceNumber" : { + "type" : "string", + "maxLength" : 100, + "minLength" : 0 + }, + "name" : { + "type" : "string", + "maxLength" : 120, + "minLength" : 0 + }, + "operationalScope" : { + "$ref" : "#/components/schemas/MultiChoiceOrOtherDtoOperationalScope" + }, + "startDate" : { + "type" : "string" + }, + "thresholdUnits" : { + "type" : "string", + "enum" : [ "Absolute", "Percentage" ] + }, + "thresholdValue" : { + "type" : "integer", + "format" : "int32" + }, + "type" : { + "type" : "string", + "enum" : [ "Universal", "Unique", "One_Time" ] + } + }, + "required" : [ "name", "type" ] + }, + "LicensingData" : { + "type" : "object", + "properties" : { + "featureGroups" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "licenseAgreement" : { + "type" : "string" + } + } + }, + "LimitEntityDto" : { + "type" : "object", + "properties" : { + "aggregationFunction" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "metric" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "time" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "unit" : { + "type" : "string" + }, + "value" : { + "type" : "string" + } + } + }, + "LimitRequestDto" : { + "type" : "object", + "description" : "LimitRequest", + "properties" : { + "aggregationFunction" : { + "type" : "string" + }, + "description" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + }, + "metric" : { + "type" : "string" + }, + "name" : { + "type" : "string", + "maxLength" : 120, + "minLength" : 0 + }, + "time" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "unit" : { + "type" : "string" + }, + "value" : { + "type" : "string" + } + }, + "required" : [ "metric", "name", "type", "value" ] + }, + "ListResponseWrapper" : { + "type" : "object", + "properties" : { + "actionList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActionResponseDto" + } + }, + "componentList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OpenEcompComponent" + } + }, + "versions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ActionResponseDto" + } + } + } + }, + "Module" : { + "type" : "object", + "properties" : { + "env" : { + "type" : "string" + }, + "isBase" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "type" : { + "type" : "string", + "enum" : [ "HEAT", "HEAT_ENV", "HEAT_NET", "HEAT_VOL", "CHEF", "PUPPET", "SHELL", "YANG", "YANG_XML", "BPEL", "DG_XML", "MURANO_PKG", "VENDOR_LICENSE", "VF_LICENSE", "CLOUD_TECHNOLOGY_SPECIFIC_ARTIFACT", "CONTROLLER_BLUEPRINT_ARCHIVE", "HELM", "OTHER", "PNF_SW_INFORMATION", "PM_DICTIONARY" ] + }, + "vol" : { + "type" : "string" + }, + "volEnv" : { + "type" : "string" + }, + "yaml" : { + "type" : "string" + } + } + }, + "MonitoringUploadStatusDto" : { + "type" : "object", + "properties" : { + "snmpPoll" : { + "type" : "string" + }, + "snmpTrap" : { + "type" : "string" + }, + "vesEvent" : { + "type" : "string" + } + } + }, + "MultiChoiceOrOtherDtoOperationalScope" : { + "type" : "object", + "properties" : { + "choices" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "Network_Wide", "Availability_Zone", "Data_Center", "Tenant", "VM", "CPU", "Core", "Other" ] + }, + "maxItems" : 2147483647, + "minItems" : 1, + "uniqueItems" : true + }, + "other" : { + "type" : "string" + } + }, + "required" : [ "choices", "other" ] + }, + "NetworkDto" : { + "type" : "object", + "properties" : { + "dhcp" : { + "type" : "boolean" + }, + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + } + }, + "required" : [ "dhcp", "name" ] + }, + "NetworkRequestDto" : { + "type" : "object", + "properties" : { + "dhcp" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + } + }, + "required" : [ "dhcp", "name" ] + }, + "NicDto" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "networkDescription" : { + "type" : "string" + }, + "networkId" : { + "type" : "string" + }, + "networkName" : { + "type" : "string" + }, + "networkType" : { + "type" : "string" + } + }, + "required" : [ "name", "networkType" ] + }, + "NicRequestDto" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "networkDescription" : { + "type" : "string" + }, + "networkId" : { + "type" : "string" + }, + "networkType" : { + "type" : "string" + } + }, + "required" : [ "name", "networkType" ] + }, + "NotificationEntityDto" : { + "type" : "object", + "properties" : { + "dateTime" : { + "type" : "string" + }, + "eventAttributes" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "eventId" : { + "type" : "string", + "format" : "uuid" + }, + "eventType" : { + "type" : "string" + }, + "read" : { + "type" : "boolean" + } + } + }, + "NotificationsStatusDto" : { + "type" : "object", + "properties" : { + "endOfPage" : { + "type" : "string", + "format" : "uuid" + }, + "lastScanned" : { + "type" : "string", + "format" : "uuid" + }, + "newEntries" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "uuid" + } + }, + "notifications" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NotificationEntityDto" + } + }, + "numOfNotSeenNotifications" : { + "type" : "integer", + "format" : "int64" + } + } + }, + "OpenEcompComponent" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + } + } + }, + "PackageInfoDto" : { + "type" : "object", + "properties" : { + "category" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "models" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "packageChecksum" : { + "type" : "string" + }, + "packageId" : { + "type" : "string" + }, + "packageType" : { + "type" : "string" + }, + "resourceType" : { + "type" : "string" + }, + "subCategory" : { + "type" : "string" + }, + "vendorName" : { + "type" : "string" + }, + "vendorRelease" : { + "type" : "string" + }, + "version" : { + "type" : "string" + }, + "versionId" : { + "type" : "string" + }, + "vspName" : { + "type" : "string" + } + } + }, + "ProcessEntityDto" : { + "type" : "object", + "properties" : { + "artifactName" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "type" : { + "type" : "string", + "enum" : [ "Lifecycle_Operations", "Other" ] + } + }, + "required" : [ "name" ] + }, + "ProcessRequestDto" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "type" : { + "type" : "string", + "enum" : [ "Lifecycle_Operations", "Other" ] + } + }, + "required" : [ "name" ] + }, + "QuestionnaireResponseDto" : { + "type" : "object", + "properties" : { + "data" : { + "type" : "string" + }, + "errorMessage" : { + "$ref" : "#/components/schemas/ErrorMessage" + }, + "schema" : { + "type" : "string" + } + } + }, + "RemoteTestingEndpointDefinition" : { + "type" : "object", + "properties" : { + "apiKey" : { + "type" : "string" + }, + "enabled" : { + "type" : "boolean" + }, + "id" : { + "type" : "string" + }, + "scenarioFilter" : { + "type" : "string" + }, + "title" : { + "type" : "string" + }, + "url" : { + "type" : "string" + } + } + }, + "RevisionRequestDto" : { + "type" : "object", + "properties" : { + "revisionId" : { + "type" : "string" + } + } + }, + "SubmitRequestDto" : { + "type" : "object", + "properties" : { + "message" : { + "type" : "string" + } + } + }, + "UpdateNotificationResponseStatus" : { + "type" : "object", + "properties" : { + "errors" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ErrorMessage" + } + } + }, + "status" : { + "type" : "string", + "enum" : [ "Success", "Failure" ] + } + } + }, + "UploadFileResponseDto" : { + "type" : "object", + "properties" : { + "errors" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ErrorMessage" + } + } + }, + "networkPackageName" : { + "type" : "string" + }, + "onboardingOrigin" : { + "type" : "string" + }, + "status" : { + "type" : "string", + "enum" : [ "Success", "Failure" ] + } + } + }, + "ValidationStructureList" : { + "type" : "object", + "properties" : { + "importStructure" : { + "$ref" : "#/components/schemas/HeatStructureTree" + } + } + }, + "VendorLicenseModelActionRequestDto" : { + "type" : "object", + "properties" : { + "action" : { + "type" : "string", + "enum" : [ "Submit" ] + }, + "submitRequest" : { + "$ref" : "#/components/schemas/SubmitRequestDto" + } + } + }, + "VendorLicenseModelEntityDto" : { + "type" : "object", + "description" : "VendorLicenseModelEntity", + "properties" : { + "description" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + }, + "iconRef" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "vendorName" : { + "type" : "string", + "maxLength" : 25, + "minLength" : 0 + } + }, + "required" : [ "description", "iconRef", "vendorName" ] + }, + "VendorLicenseModelRequestDto" : { + "type" : "object", + "description" : "VendorLicenseModelRequest", + "properties" : { + "description" : { + "type" : "string", + "maxLength" : 1000, + "minLength" : 0 + }, + "iconRef" : { + "type" : "string" + }, + "vendorName" : { + "type" : "string", + "maxLength" : 25, + "minLength" : 0 + } + }, + "required" : [ "description", "iconRef", "vendorName" ] + }, + "VersionActionRequestDto" : { + "type" : "object", + "properties" : { + "action" : { + "type" : "string", + "enum" : [ "Sync", "Commit", "Revert", "Reset", "Clean" ] + }, + "commitRequest" : { + "$ref" : "#/components/schemas/CommitRequestDto" + }, + "revisionRequest" : { + "$ref" : "#/components/schemas/RevisionRequestDto" + } + } + }, + "VersionDto" : { + "type" : "object", + "properties" : { + "additionalInfo" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "baseId" : { + "type" : "string" + }, + "creationTime" : { + "type" : "string", + "format" : "date-time" + }, + "description" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "modificationTime" : { + "type" : "string", + "format" : "date-time" + }, + "name" : { + "type" : "string" + }, + "state" : { + "$ref" : "#/components/schemas/VersionState" + }, + "status" : { + "type" : "string", + "enum" : [ "Draft", "Locked", "Certified", "Deprecated", "Deleted" ] + } + } + }, + "VersionRequestDto" : { + "type" : "object", + "properties" : { + "creationMethod" : { + "type" : "string", + "enum" : [ "major", "minor" ] + }, + "description" : { + "type" : "string" + } + } + }, + "VersionSoftwareProductActionRequestDto" : { + "type" : "object", + "properties" : { + "action" : { + "type" : "string", + "enum" : [ "Submit", "Create_Package" ] + }, + "submitRequest" : { + "$ref" : "#/components/schemas/SubmitRequestDto" + } + } + }, + "VersionState" : { + "type" : "object", + "properties" : { + "dirty" : { + "type" : "boolean" + }, + "synchronizationState" : { + "type" : "string", + "enum" : [ "Up to date", "Out of sync", "Merging" ] + } + } + }, + "VspComputeDto" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string" + }, + "computeFlavorId" : { + "type" : "string" + }, + "name" : { + "type" : "string" + } + } + }, + "VspDescriptionDto" : { + "type" : "object", + "properties" : { + "category" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "icon" : { + "type" : "string" + }, + "licenseType" : { + "type" : "string", + "enum" : [ "EXTERNAL", "INTERNAL" ] + }, + "licensingData" : { + "$ref" : "#/components/schemas/LicensingData" + }, + "licensingVersion" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "selectedModelList" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "subCategory" : { + "type" : "string" + }, + "vendorId" : { + "type" : "string" + }, + "vendorName" : { + "type" : "string" + } + }, + "required" : [ "category", "description", "name", "subCategory", "vendorId", "vendorName" ] + }, + "VspDetailsDto" : { + "type" : "object", + "description" : "VspDetails", + "properties" : { + "candidateOnboardingOrigin" : { + "type" : "string" + }, + "category" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "icon" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "licenseType" : { + "type" : "string", + "enum" : [ "EXTERNAL", "INTERNAL" ] + }, + "licensingData" : { + "$ref" : "#/components/schemas/LicensingData" + }, + "licensingVersion" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "networkPackageName" : { + "type" : "string" + }, + "onboardingMethod" : { + "type" : "string" + }, + "onboardingOrigin" : { + "type" : "string" + }, + "owner" : { + "type" : "string" + }, + "selectedModelList" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "status" : { + "type" : "string" + }, + "subCategory" : { + "type" : "string" + }, + "validationData" : { + "$ref" : "#/components/schemas/ValidationStructureList" + }, + "vendorId" : { + "type" : "string" + }, + "vendorName" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + }, + "required" : [ "category", "description", "name", "onboardingMethod", "subCategory", "vendorId", "vendorName" ] + }, + "VspRequestDto" : { + "type" : "object", + "properties" : { + "category" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "icon" : { + "type" : "string" + }, + "licenseType" : { + "type" : "string", + "enum" : [ "EXTERNAL", "INTERNAL" ] + }, + "licensingData" : { + "$ref" : "#/components/schemas/LicensingData" + }, + "licensingVersion" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "onboardingMethod" : { + "type" : "string" + }, + "selectedModelList" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "subCategory" : { + "type" : "string" + }, + "vendorId" : { + "type" : "string" + }, + "vendorName" : { + "type" : "string" + } + }, + "required" : [ "category", "description", "name", "onboardingMethod", "subCategory", "vendorId", "vendorName" ] + } + } + } +}
\ No newline at end of file diff --git a/docs/openapi/openapi-sdce-1.yaml b/docs/openapi/openapi-sdce-1.yaml new file mode 100644 index 0000000000..3dd236e9e6 --- /dev/null +++ b/docs/openapi/openapi-sdce-1.yaml @@ -0,0 +1,7963 @@ +openapi: 3.0.1 +info: + contact: + email: onap-discuss@lists.onap.org + name: ONAP + url: https://onap.readthedocs.io + description: SDC API for onboarding (SDCE-1) + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0 + title: "SPC API: SDCE-1" + version: "1.0" +servers: +- description: SDCE-1 APIs + url: /sdc +paths: + /application.wadl: + get: + operationId: getWadl + responses: + default: + content: + application/vnd.sun.wadl+xml: {} + application/xml: {} + description: default response + /application.wadl/{path}: + get: + operationId: getExternalGrammar + parameters: + - in: path + name: path + required: true + schema: + type: string + responses: + default: + content: + application/xml: {} + description: default response + /v1.0/actuator/prometheus: + get: + description: Gets the prometheus micrometer application metrics + operationId: prometheusMetrics + parameters: + - description: The Accept header to determine the output content type + in: header + name: Accept + schema: + type: string + responses: + default: + content: + '*/*': + schema: + type: string + description: default response + summary: Prometheus Micrometer Metrics + tags: + - SDCE-1 APIs + /v1.0/application-configuration: + post: + description: Insert JSON schema into application config table + operationId: insertToTable + parameters: + - in: query + name: namespace + schema: + type: string + - in: query + name: key + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Application Configuration + /v1.0/application-configuration/{namespace}: + get: + description: Get List of keys and descriptions by namespace + operationId: getListOfConfigurationByNamespaceFromTable + parameters: + - in: path + name: namespace + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ApplicationConfigDto' + tags: + - SDCE-1 APIs + - Application Configuration + /v1.0/application-configuration/{namespace}/{key}: + get: + description: Get JSON schema by namespace and key + operationId: getFromTable + parameters: + - in: path + name: namespace + required: true + schema: + type: string + - in: path + name: key + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigurationDataDto' + tags: + - SDCE-1 APIs + - Application Configuration + /v1.0/externaltesting/config: + get: + operationId: getConfig + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + put: + operationId: setConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClientConfiguration' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/externaltesting/endpoints: + get: + operationId: getEndpoints + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + put: + operationId: setEndpoints + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RemoteTestingEndpointDefinition' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/externaltesting/endpoints/{endpointId}/executions/{executionId}: + post: + operationId: getExecution + parameters: + - in: path + name: endpointId + required: true + schema: + type: string + - in: path + name: executionId + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/externaltesting/endpoints/{endpointId}/scenarios: + get: + operationId: getScenarios + parameters: + - in: path + name: endpointId + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/externaltesting/endpoints/{endpointId}/scenarios/{scenario}/testcases: + get: + operationId: getTestcases + parameters: + - in: path + name: endpointId + required: true + schema: + type: string + - in: path + name: scenario + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/externaltesting/endpoints/{endpointId}/scenarios/{scenario}/testsuites: + get: + operationId: getTestsuites + parameters: + - in: path + name: endpointId + required: true + schema: + type: string + - in: path + name: scenario + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/externaltesting/endpoints/{endpointId}/scenarios/{scenario}/testsuites/{testsuite}/testcases/{testcase}: + get: + operationId: getTestcase + parameters: + - in: path + name: endpointId + required: true + schema: + type: string + - in: path + name: scenario + required: true + schema: + type: string + - in: path + name: testsuite + required: true + schema: + type: string + - in: path + name: testcase + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/externaltesting/executions: + get: + operationId: getValidationResult + parameters: + - in: query + name: requestId + schema: + type: string + - in: query + name: endPoint + schema: + type: array + items: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + post: + operationId: execute + parameters: + - in: query + name: vspId + schema: + type: string + - in: query + name: vspVersionId + schema: + type: string + - in: query + name: requestId + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/Attachment' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/externaltesting/testcasetree: + get: + operationId: getTestCasesAsTree + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/healthcheck: + get: + description: Perform health check + operationId: checkHealth + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/HealthInfoDtos' + tags: + - SDCE-1 APIs + - Health Check + /v1.0/items: + get: + description: Get list of items according to desired filters + operationId: list + parameters: + - description: Filter by item status + in: query + name: itemStatus + schema: + type: string + enum: + - ACTIVE + - ARCHIVED + - description: Filter by version status + in: query + name: versionStatus + schema: + type: string + enum: + - Certified + - Draft + - description: Filter by item type + in: query + name: itemType + schema: + type: string + enum: + - vsp + - vlm + - description: Filter by user permission + in: query + name: permission + schema: + type: string + enum: + - Owner + - Contributor + - description: Filter by onboarding method + in: query + name: onboardingMethod + schema: + type: string + enum: + - NetworkPackage + - manual + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Item' + tags: + - SDCE-1 APIs + - Items + /v1.0/items/{itemId}: + get: + description: Get details of a item + operationId: getItem + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Items + /v1.0/items/{itemId}/actions: + put: + description: Acts on item version + operationId: actOn + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ItemActionRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Items + /v1.0/items/{itemId}/permissions: + get: + description: List users permissions assigned on item + operationId: list_2 + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ItemPermissionsDto' + tags: + - SDCE-1 APIs + - Item Permissions + /v1.0/items/{itemId}/permissions/{permission}: + put: + description: Update useres permission on item + operationId: updatePermissions + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: path + name: permission + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ItemPermissionsRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Item Permissions + /v1.0/items/{itemId}/versions: + get: + description: Lists item versions + operationId: list_1 + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VersionDto' + tags: + - SDCE-1 APIs + - Item Versions + /v1.0/items/{itemId}/versions/{versionId}: + get: + description: Gets item version + operationId: get + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/VersionDto' + tags: + - SDCE-1 APIs + - Item Versions + post: + description: Creates a new item version + operationId: create + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VersionRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Item Versions + /v1.0/items/{itemId}/versions/{versionId}/actions: + put: + description: Acts on item version + operationId: actOn_1 + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VersionActionRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Item Versions + /v1.0/items/{itemId}/versions/{versionId}/activity-logs: + get: + description: Gets item version activity log + operationId: getActivityLog + parameters: + - description: Item Id + in: path + name: itemId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivityLogDto' + tags: + - SDCE-1 APIs + - Item Versions + /v1.0/items/{itemId}/versions/{versionId}/conflicts: + get: + description: item version conflicts + operationId: getConflict + parameters: + - description: Item Id + in: path + name: itemId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ItemVersionConflictDto' + summary: Item version private copy conflicts against its public copy + tags: + - SDCE-1 APIs + - Item Version Conflicts + /v1.0/items/{itemId}/versions/{versionId}/conflicts/{conflictId}: + get: + description: Gets item version conflict + operationId: getConflict_1 + parameters: + - description: Item Id + in: path + name: itemId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Version Id + in: path + name: conflictId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ConflictDto' + summary: Gets an item version private copy conflict against its public copy + tags: + - SDCE-1 APIs + - Item Version Conflicts + put: + description: Resolves item version conflict + operationId: resolveConflict + parameters: + - description: Item Id + in: path + name: itemId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Version Id + in: path + name: conflictId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConflictResolutionDto' + responses: + default: + content: + application/json: {} + description: default response + summary: Resolves an item version private copy conflict against its public copy + tags: + - SDCE-1 APIs + - Item Version Conflicts + /v1.0/items/{itemId}/versions/{versionId}/revisions: + get: + description: Gets item version revisions + operationId: listRevisions + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivityLogDto' + tags: + - SDCE-1 APIs + - Item Versions + /v1.0/notifications: + get: + description: Retrieve all user notifications + operationId: getNotifications + parameters: + - in: header + name: USER_ID + required: true + schema: + type: string + - in: query + name: LAST_DELIVERED_EVENT_ID + schema: + type: string + format: uuid + - in: query + name: END_OF_PAGE_EVENT_ID + schema: + type: string + format: uuid + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationsStatusDto' + tags: + - SDCE-1 APIs + - Notifications + /v1.0/notifications/last-seen/{notificationId}: + put: + description: Update Last Seen Notification + operationId: updateLastSeenNotification + parameters: + - description: Notification Id + in: path + name: notificationId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateNotificationResponseStatus' + tags: + - SDCE-1 APIs + - Notifications + /v1.0/notifications/worker: + get: + description: Retrive user not delivered notifications + operationId: getNewNotificationsByOwnerId + parameters: + - in: header + name: USER_ID + required: true + schema: + type: string + - in: query + name: LAST_DELIVERED_EVENT_ID + schema: + type: string + - in: query + name: NOTIFICATION_ROWS_LIMIT + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationsStatusDto' + tags: + - SDCE-1 APIs + - Notifications + /v1.0/notifications/{notificationId}: + put: + description: Mark notification as read + operationId: markAsRead + parameters: + - description: Notification Id + in: path + name: notificationId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateNotificationResponseStatus' + tags: + - SDCE-1 APIs + - Notifications + /v1.0/togglz: + get: + description: Get TOGGLZ Features + operationId: getFeatures + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FeatureSetDto' + tags: + - SDCE-1 APIs + - Togglz + /v1.0/togglz/state/{state}: + put: + description: Update feature toggle state for all features + operationId: setAllFeatures + parameters: + - in: path + name: state + required: true + schema: + type: boolean + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Togglz + /v1.0/togglz/{featureName}/state: + get: + description: Get feature toggle state + operationId: getFeatureState + parameters: + - in: path + name: featureName + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/FeatureDto' + tags: + - SDCE-1 APIs + - Togglz + /v1.0/togglz/{featureName}/state/{state}: + put: + description: Update feature toggle state + operationId: setFeatureState + parameters: + - in: path + name: featureName + required: true + schema: + type: string + - in: path + name: state + required: true + schema: + type: boolean + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Togglz + /v1.0/unique-types: + get: + description: Lists unique value types + operationId: listUniqueTypes + parameters: + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Unique Types + /v1.0/unique-types/{type}/values/{value}: + get: + description: Gets unique value + operationId: getUniqueValue + parameters: + - description: "The unique value type, for example: 'VlmName'" + in: path + name: type + required: true + schema: + type: string + - description: The unique value + in: path + name: value + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + "200": + description: Indication whether the unique value is occupied + "404": + description: Unsupported unique type + tags: + - SDCE-1 APIs + - Unique Types + /v1.0/validation/{type}/validate: + post: + description: Validate a package + operationId: validateFile_1 + parameters: + - in: path + name: type + required: true + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Validation + /v1.0/vendor-license-models: + get: + description: List vendor license models + operationId: listLicenseModels + parameters: + - description: "Filter to return only Vendor License Models with at least one\ + \ version at this status. Currently supported values: 'Certified' , 'Draft'" + in: query + name: versionFilter + schema: + type: string + - description: "Filter to only return Vendor License Models at this status.Currently\ + \ supported values: 'ACTIVE' , 'ARCHIVED'.Default value = 'ACTIVE'." + in: query + name: Status + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ItemDto' + tags: + - SDCE-1 APIs + - Vendor License Models + post: + description: Create vendor license model + operationId: createLicenseModel + parameters: + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VendorLicenseModelRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Models + /v1.0/vendor-license-models/{vlmId}: + delete: + description: Delete vendor license model + operationId: deleteLicenseModel + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Models + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}: + get: + description: Get vendor license model + operationId: getLicenseModel + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/VendorLicenseModelEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Models + put: + description: Update vendor license model + operationId: updateLicenseModel + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VendorLicenseModelRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Models + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/actions: + put: + description: Update vendor license model + operationId: actOnLicenseModel + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VendorLicenseModelActionRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Models + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/entitlement-pools: + get: + description: List vendor entitlement pools + operationId: listEntitlementPools + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/EntitlementPoolEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pools + post: + description: Create vendor entitlement pool + operationId: createEntitlementPool + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EntitlementPoolRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pools + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/entitlement-pools/{entitlementPoolId}: + delete: + description: Delete vendor entitlement pool + operationId: deleteEntitlementPool + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: entitlementPoolId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pools + get: + description: Get vendor entitlement pool + operationId: getEntitlementPool + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: entitlementPoolId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/EntitlementPoolEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pools + put: + description: Update vendor entitlement pool + operationId: updateEntitlementPool + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: entitlementPoolId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EntitlementPoolRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pools + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/entitlement-pools/{entitlementPoolId}/limits: + get: + description: List vendor entitlement pool limits + operationId: listLimits + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model Entitlement Pool Id + in: path + name: entitlementPoolId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LimitRequestDto' + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pool Limits + post: + description: Create vendor entitlement pool limits + operationId: createLimit + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model Entitlement Pool Id + in: path + name: entitlementPoolId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LimitRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pool Limits + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/entitlement-pools/{entitlementPoolId}/limits/{limitId}: + delete: + description: Delete vendor entitlement pool limit + operationId: deleteLimit + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model Entitlement pool Id + in: path + name: entitlementPoolId + required: true + schema: + type: string + - in: path + name: limitId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pool Limits + get: + description: Get vendor entitlement pool limit + operationId: getLimit + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model Entitlement Pool Id + in: path + name: entitlementPoolId + required: true + schema: + type: string + - description: Vendor license model Entitlement Pool Limit Id + in: path + name: limitId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/LimitEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pool Limits + put: + description: Update vendor entitlement pool limit + operationId: updateLimit + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model Entitlement Pool Id + in: path + name: entitlementPoolId + required: true + schema: + type: string + - in: path + name: limitId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LimitRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pool Limits + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/feature-groups: + get: + description: List vendor feature groups + operationId: listFeatureGroups + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FeatureGroupEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - Feature Groups + post: + description: Create vendor feature group + operationId: createFeatureGroup + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FeatureGroupRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Feature Groups + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/feature-groups/{featureGroupId}: + delete: + description: Delete vendor feature group + operationId: deleteFeatureGroup + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: featureGroupId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Feature Groups + get: + description: Get vendor feature group + operationId: getFeatureGroup + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: featureGroupId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/FeatureGroupModelDto' + tags: + - SDCE-1 APIs + - Vendor License Model - Feature Groups + put: + description: Update vendor feature group + operationId: updateFeatureGroup + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: featureGroupId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FeatureGroupUpdateRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Feature Groups + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-agreements: + get: + description: List vendor license agreements + operationId: listLicenseAgreements + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LicenseAgreementEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - License Agreements + post: + description: Create vendor license agreement + operationId: createLicenseAgreement + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LicenseAgreementRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Agreements + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-agreements/{licenseAgreementId}: + delete: + description: Delete vendor license agreement + operationId: deleteLicenseAgreement + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: licenseAgreementId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Agreements + get: + description: Get vendor license agreement + operationId: getLicenseAgreement + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: licenseAgreementId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/LicenseAgreementModelDto' + tags: + - SDCE-1 APIs + - Vendor License Model - License Agreements + put: + description: Update vendor license agreement + operationId: updateLicenseAgreement + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: licenseAgreementId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LicenseAgreementUpdateRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Agreements + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-key-groups: + get: + description: List vendor license key groups + operationId: listLicenseKeyGroups + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LicenseKeyGroupEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Groups + post: + description: Create vendor license key group + operationId: createLicenseKeyGroup + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LicenseKeyGroupRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Groups + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-key-groups/{licenseKeyGroupId}: + delete: + description: Delete vendor license key group + operationId: deleteLicenseKeyGroup + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: licenseKeyGroupId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Groups + get: + description: Get vendor license key group + operationId: getLicenseKeyGroup + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: licenseKeyGroupId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/LicenseKeyGroupEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Groups + put: + description: Update vendor license key group + operationId: updateLicenseKeyGroup + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: licenseKeyGroupId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LicenseKeyGroupRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Groups + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-key-groups/{licenseKeyGroupId}/limits: + get: + description: List vendor license key group limits + operationId: listLimits_1 + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model License Key Group Id + in: path + name: licenseKeyGroupId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LimitEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Group Limits + post: + description: Create vendor license key group limit + operationId: createLimit_1 + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model License Key Group Id + in: path + name: licenseKeyGroupId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LimitRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Group Limits + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-key-groups/{licenseKeyGroupId}/limits/{limitId}: + delete: + description: Delete vendor license key group limit + operationId: deleteLimit_1 + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model license key group Id + in: path + name: licenseKeyGroupId + required: true + schema: + type: string + - in: path + name: limitId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Group Limits + get: + description: Get vendor entitlement pool limit + operationId: getLimit_1 + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model License Key Group + in: path + name: licenseKeyGroupId + required: true + schema: + type: string + - description: Vendor license model License Key Group Limit Id + in: path + name: limitId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/LimitEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Group Limits + put: + description: Update vendor license key group limit + operationId: updateLimit_1 + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model License Key Group Id + in: path + name: licenseKeyGroupId + required: true + schema: + type: string + - in: path + name: limitId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LimitRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Group Limits + /v1.0/vendor-software-products: + get: + description: Get list of vendor software products and their description + operationId: listVsps + parameters: + - description: "Filter to return only Vendor Software Products with at least\ + \ one version at this status. Currently supported values: 'Certified' ,\ + \ 'Draft'" + in: query + name: versionFilter + schema: + type: string + - description: "Filter to only return Vendor Software Products at this status.Currently\ + \ supported values: 'ACTIVE' , 'ARCHIVED'.Default value = 'ACTIVE'." + in: query + name: Status + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VspDetailsDto' + tags: + - SDCE-1 APIs + - Vendor Software Products + post: + description: Create a new vendor software product + operationId: createVsp + parameters: + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VspRequestDto' + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ItemCreationDto' + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/packages: + get: + description: Get list of translated CSAR files details + operationId: listPackages + parameters: + - description: "Vendor Software Product status filter. Currently supported values:\ + \ 'ACTIVE', 'ARCHIVED'" + in: query + name: Status + schema: + type: string + - description: Category + in: query + name: category + schema: + type: string + - description: Sub-category + in: query + name: subCategory + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PackageInfoDto' + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/packages/{vspId}: + get: + description: Get translated CSAR file + operationId: getTranslatedFile + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: query + name: versionId + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + default: + content: + application/octet-stream: + schema: + type: string + format: binary + summary: Exports translated file to a zip file + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/validation-vsp: + get: + operationId: getValidationVsp + parameters: + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}: + delete: + operationId: deleteVsp + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Products + get: + operationId: getLatestVsp + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}/versions/{versionId}: + get: + operationId: getVsp + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Products + put: + operationId: updateVsp + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VspDescriptionDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/actions: + put: + description: Actions on a vendor software product + operationId: actOnVendorSoftwareProduct + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VersionSoftwareProductActionRequestDto' + responses: + default: + content: + application/json: {} + description: default response + summary: "Performs one of the following actions on a vendor software product:\ + \ |Checkout: Locks it for edits by other users. Only the locking user sees\ + \ the edited version.|Undo_Checkout: Unlocks it and deletes the edits that\ + \ were done.|Checkin: Unlocks it and activates the edited version to all users.|\ + \ Submit: Finalize its active version.|Create_Package: Creates a CSAR zip\ + \ file.|" + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/component-dependencies: + get: + description: Get component dependencies for vendor software product + operationId: list_3 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ComponentDependencyResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component Dependencies + post: + description: Create a vendor software product component dependency + operationId: create_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ComponentDependencyModel' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Dependencies + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/component-dependencies/{dependencyId}: + delete: + description: Delete component dependency for vendor software product + operationId: delete + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product Component Dependency Id + in: path + name: dependencyId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Dependencies + get: + description: Get component dependency for vendor software product + operationId: get_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product Component Dependency Id + in: path + name: dependencyId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ComponentDependencyResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component Dependencies + put: + description: Update component dependency for vendor software product + operationId: update + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product Component Dependency Id + in: path + name: dependencyId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ComponentDependencyModel' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Dependencies + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components: + delete: + description: Delete vendor software product components + operationId: deleteList_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: string + tags: + - SDCE-1 APIs + - Vendor Software Product Components + get: + description: List vendor software product components + operationId: list_6 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ComponentDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Components + post: + description: Create a vendor software product component + operationId: create_3 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ComponentRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Components + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}: + delete: + description: Delete vendor software product component + operationId: delete_3 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Components + get: + description: Get vendor software product component + operationId: get_3 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ComponentData' + tags: + - SDCE-1 APIs + - Vendor Software Product Components + put: + description: Update vendor software product component + operationId: update_2 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ComponentRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Components + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/compute-flavors: + get: + description: Get list of vendor software product component compute-flavors + operationId: list_7 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ComputeDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component Compute-flavors + post: + description: Create a vendor software product component compute-flavor + operationId: create_4 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ComputeDetailsDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Compute-flavors + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/compute-flavors/{computeFlavorId}: + delete: + description: Delete vendor software product component compute-flavor + operationId: delete_4 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product compute-flavor Id + in: path + name: computeFlavorId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Compute-flavors + get: + description: Get vendor software product component compute-flavor + operationId: get_4 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product compute-flavor Id + in: path + name: computeFlavorId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ComputeDetailsDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component Compute-flavors + put: + description: Update vendor software product component compute-flavor + operationId: update_3 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product compute-flavor Id + in: path + name: computeFlavorId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ComputeDetailsDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Compute-flavors + ? /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/compute-flavors/{computeFlavorId}/questionnaire + : get: + description: Get vendor software product component compute-flavor questionnaire + operationId: getQuestionnaire_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product compute-flavor Id + in: path + name: computeFlavorId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/QuestionnaireResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component Compute-flavors + put: + description: Update vendor software product component compute-flavor questionnaire + operationId: updateQuestionnaire_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product compute-flavor Id + in: path + name: computeFlavorId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + required: true + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Compute-flavors + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/images: + get: + description: List vendor software product component images + operationId: list_9 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ImageDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Images + post: + description: Create a vendor software product component image + operationId: create_6 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImageRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Images + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/images/schema: + get: + operationId: getImageSchema + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Images + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/images/{imageId}: + delete: + description: Delete vendor software product Image + operationId: delete_6 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product Image Id + in: path + name: imageId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Images + get: + description: Get vendor software product component Image + operationId: get_6 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product Image Id + in: path + name: imageId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ImageDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Images + put: + description: Update vendor software product Image + operationId: update_5 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product Image Id + in: path + name: imageId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImageRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Images + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/images/{imageId}/questionnaire: + get: + description: Get vendor software product component image questionnaire + operationId: getQuestionnaire_2 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product image Id + in: path + name: imageId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/QuestionnaireResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Images + put: + description: Update vendor software product component image questionnaire + operationId: updateQuestionnaire_2 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product image Id + in: path + name: imageId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + required: true + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Images + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/nics: + get: + description: List vendor software product component NICs + operationId: list_11 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NicDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component NICs + post: + description: Create a vendor software product NIC + operationId: create_8 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NicRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component NICs + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/nics/{nicId}: + delete: + description: Delete vendor software product NIC + operationId: delete_8 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product NIC Id + in: path + name: nicId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component NICs + get: + description: Get vendor software product NIC + operationId: get_8 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product NIC Id + in: path + name: nicId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/NicDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component NICs + put: + description: Update vendor software product NIC + operationId: update_7 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product NIC Id + in: path + name: nicId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NicRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component NICs + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/nics/{nicId}/questionnaire: + get: + description: Get vendor software product component NIC questionnaire + operationId: getQuestionnaire_3 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product NIC Id + in: path + name: nicId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/QuestionnaireResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component NICs + put: + description: Update vendor software product component NIC questionnaire + operationId: updateQuestionnaire_3 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product NIC Id + in: path + name: nicId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + required: true + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component NICs + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/processes: + delete: + description: Delete vendor software product processes + operationId: deleteList + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: string + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + get: + description: List vendor software product component processes + operationId: list_5 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProcessEntityDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + post: + description: Create a vendor software product process + operationId: create_2 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProcessRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/processes/{processId}: + delete: + description: Delete vendor software product process + operationId: delete_2 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + get: + description: Get vendor software product process + operationId: get_2 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ProcessEntityDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + put: + description: Update vendor software product process + operationId: update_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProcessRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/processes/{processId}/upload: + delete: + description: Delete vendor software product process uploaded file + operationId: deleteUploadedFile + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + get: + description: Get vendor software product process uploaded file + operationId: getUploadedFile + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/octet-stream: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + post: + description: Update vendor software product process upload + operationId: uploadFile + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/Attachment' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/questionnaire: + get: + description: Get vendor software product component questionnaire + operationId: getQuestionnaire + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/QuestionnaireResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Components + put: + description: Update vendor software product component questionnaire + operationId: updateQuestionnaire + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + required: true + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Components + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/uploads: + get: + description: Get the filenames of uploaded files by type + operationId: list_4 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MonitoringUploadStatusDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component Uploads + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/uploads/types/{type}: + delete: + description: Delete file uploaded for component + operationId: delete_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Upload Type + in: path + name: type + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Uploads + post: + description: Upload file for component by type + operationId: upload + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Upload Type + in: path + name: type + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/Attachment' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Uploads + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/compute-flavors: + get: + description: Get list of vendor software product compute-flavors + operationId: listComputes + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VspComputeDto' + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/deployment-flavors: + get: + description: List vendor software product Deployment Flavor + operationId: list_8 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeploymentFlavorListResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Product deployment-flavors + post: + description: Create a vendor software product Deployment Flavor + operationId: create_5 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentFlavorRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product deployment-flavors + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/deployment-flavors/schema: + get: + operationId: getSchema + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product deployment-flavors + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/deployment-flavors/{deploymentFlavorId}: + delete: + description: Delete vendor software product Deployment Flavor + operationId: delete_5 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product Deployment Flavor Id + in: path + name: deploymentFlavorId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product deployment-flavors + get: + description: Get vendor software product Deployment Flavor + operationId: get_5 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product Deployment Flavor Id + in: path + name: deploymentFlavorId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentFlavorDto' + tags: + - SDCE-1 APIs + - Vendor Software Product deployment-flavors + put: + description: Update vendor software product Deployment Flavor + operationId: update_4 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product Deployment Flavor Id + in: path + name: deploymentFlavorId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentFlavorRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product deployment-flavors + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/heal: + put: + description: Checkout and heal vendor software product questionnaire + operationId: heal + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/QuestionnaireResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/networks: + get: + description: List vendor software product networks + operationId: list_10 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NetworkDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Networks + post: + description: Create a vendor software product network + operationId: create_7 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Networks + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/networks/{networkId}: + delete: + description: Delete vendor software product network + operationId: delete_7 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product network Id + in: path + name: networkId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Networks + get: + description: Get vendor software product network + operationId: get_7 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product network Id + in: path + name: networkId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Networks + put: + description: Update vendor software product network + operationId: update_6 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product network Id + in: path + name: networkId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Networks + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template: + get: + description: Get Orchestration Template (HEAT) file + operationId: getOrchestrationTemplate + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + default: + content: + application/octet-stream: + schema: + type: string + format: binary + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template-candidate: + delete: + description: Delete orchestration template candidate file and its files data + structure + operationId: abort + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Orchestration Template Candidate + get: + description: Get uploaded Network Package file + operationId: get_9 + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/octet-stream: + schema: + type: string + format: binary + summary: Downloads in uploaded Network Package file + tags: + - SDCE-1 APIs + - Orchestration Template Candidate + post: + description: Uploads a HEAT package to translate + operationId: uploadOrchestrationTemplateCandidate + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/UploadFileResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template-candidate/manifest: + get: + description: Get uploaded HEAT file files data structure + operationId: getFilesDataStructure + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/FileDataStructureDto' + summary: Downloads the latest HEAT package + tags: + - SDCE-1 APIs + - Orchestration Template Candidate + put: + description: Update an existing vendor software product + operationId: updateFilesDataStructure + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FileDataStructureDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Orchestration Template Candidate + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template-candidate/process: + put: + description: process Orchestration Template Candidate + operationId: process + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/UploadFileResponseDto' + tags: + - SDCE-1 APIs + - Orchestration Template Candidate + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template-candidate/upload: + get: + operationId: getLatestStatus + parameters: + - description: Vendor Software Product id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor Software Product version id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Package Upload Manager + post: + operationId: createUploadLock + parameters: + - description: Vendor Software Product id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor Software Product version id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Package Upload Manager + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/processes: + delete: + description: Delete vendor software product processes + operationId: deleteList_2 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: string + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + get: + description: List vendor software product processes + operationId: list_12 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProcessEntityDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + post: + description: Create a vendor software product process + operationId: create_9 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProcessRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/processes/{processId}: + delete: + description: Delete vendor software product process + operationId: delete_9 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + get: + description: Get vendor software product process + operationId: get_10 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ProcessEntityDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + put: + description: Update vendor software product process + operationId: update_8 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProcessRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/processes/{processId}/upload: + delete: + description: Delete vendor software product process uploaded file + operationId: deleteUploadedFile_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + get: + description: Get vendor software product process uploaded file + operationId: getUploadedFile_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/octet-stream: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + post: + description: Update vendor software product process upload + operationId: uploadFile_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/Attachment' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/questionnaire: + get: + description: Get vendor software product questionnaire + operationId: getQuestionnaire_4 + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/QuestionnaireResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Products + put: + description: Update vendor software product questionnaire + operationId: updateQuestionnaire_4 + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + required: true + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/vnfrepository/vnfpackage/{csarId}/download: + get: + description: Download VNF package from VNF Repository + operationId: downloadVnfPackage + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: csarId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/octet-stream: + schema: + type: string + format: binary + summary: Download VNF package from VNF repository and send to client + tags: + - SDCE-1 APIs + - VNF Repository packages + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/vnfrepository/vnfpackage/{csarId}/import: + post: + description: Import VNF package from VNF Repository + operationId: importVnfPackage + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: csarId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/UploadFileResponseDto' + summary: "Call VNF Repository to download VNF package, validate it and send\ + \ the response" + tags: + - SDCE-1 APIs + - VNF Repository packages + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/vnfrepository/vnfpackages: + get: + description: Get VNF packages from VNF Repository + operationId: getVnfPackages + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/octet-stream: + schema: + type: string + format: binary + summary: Call VNF Repository to get VNF package details + tags: + - SDCE-1 APIs + - VNF Repository packages + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/vspInformationArtifact: + get: + description: Get vendor software product information artifact for specified + version + operationId: getVspInformationArtifact + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + text/plain: + schema: + type: string + format: binary + tags: + - SDCE-1 APIs + - Vendor Software Products + /workflow/v1.0/actions: + get: + description: 'List Filtered Actions ' + operationId: getFilteredActions + parameters: + - in: query + name: vendor + schema: + type: string + - in: query + name: category + schema: + type: string + - in: query + name: name + schema: + type: string + - in: query + name: modelId + schema: + type: string + - in: query + name: componentId + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ListResponseWrapper' + summary: Get list of actions based on a filter criteria | If no filter is sent + all actions will be returned + tags: + - SDCE-1 APIs + - Actions + post: + description: Create a new Action + operationId: createAction + requestBody: + content: + application/json: + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Actions + /workflow/v1.0/actions/components: + get: + description: List OPENECOMP Components supported by Action Library + operationId: getOpenEcompComponents + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ListResponseWrapper' + tags: + - SDCE-1 APIs + - Actions + /workflow/v1.0/actions/{actionInvariantUuId}: + delete: + description: Delete Action + operationId: deleteAction + parameters: + - in: path + name: actionInvariantUuId + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Actions + get: + description: List Actions For Given Action Invariant UuId + operationId: getActionsByActionInvariantUuId + parameters: + - in: path + name: actionInvariantUuId + required: true + schema: + type: string + - in: query + name: version + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ListResponseWrapper' + tags: + - SDCE-1 APIs + - Actions + post: + description: Actions on a action + operationId: actOnAction + parameters: + - in: path + name: actionInvariantUuId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + summary: "Performs one of the following actions on a action: |Checkout: Locks\ + \ it for edits by other users. Only the locking user sees the edited version.|Undo_Checkout:\ + \ Unlocks it and deletes the edits that were done.|Checkin: Unlocks it and\ + \ activates the edited version to all users.| Submit: Finalize its active\ + \ version.|" + tags: + - SDCE-1 APIs + - Actions + put: + description: Update an existing action + operationId: updateAction + parameters: + - in: path + name: actionInvariantUuId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Actions + /workflow/v1.0/actions/{actionInvariantUuId}/artifacts: + post: + description: Upload new Artifact + operationId: uploadArtifact_1 + parameters: + - in: path + name: actionInvariantUuId + required: true + schema: + type: string + - in: header + name: Content-MD5 + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Actions + /workflow/v1.0/actions/{actionInvariantUuId}/artifacts/{artifactUuId}: + delete: + description: Delete Artifact + operationId: deleteArtifact + parameters: + - in: path + name: actionInvariantUuId + required: true + schema: + type: string + - in: path + name: artifactUuId + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Actions + put: + description: Update an existing artifact + operationId: updateArtifact_1 + parameters: + - in: path + name: actionInvariantUuId + required: true + schema: + type: string + - in: path + name: artifactUuId + required: true + schema: + type: string + - in: header + name: Content-MD5 + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Actions + /workflow/v1.0/actions/{actionUuId}/artifacts/{artifactUuId}: + get: + description: Downloads artifact for action + operationId: downloadArtifact + parameters: + - in: path + name: actionUuId + required: true + schema: + type: string + - in: path + name: artifactUuId + required: true + schema: + type: string + responses: + default: + content: + application/octet-stream: {} + description: default response + tags: + - SDCE-1 APIs + - Actions +components: + schemas: + ActionResponseDto: + type: object + properties: + actionInvariantUuId: + type: string + actionUuId: + type: string + categoryList: + type: array + items: + type: string + description: + type: string + displayName: + type: string + name: + type: string + status: + type: string + supportedComponents: + type: array + items: + type: object + additionalProperties: + type: string + supportedModels: + type: array + items: + type: object + additionalProperties: + type: string + timestamp: + type: string + updatedBy: + type: string + vendorList: + type: array + items: + type: string + version: + type: string + ActivityLogDto: + type: object + properties: + comment: + type: string + id: + type: string + status: + $ref: '#/components/schemas/ActivityStatus' + timestamp: + type: string + format: date-time + type: + type: string + user: + type: string + ActivityStatus: + type: object + properties: + message: + type: string + success: + type: boolean + ApplicationConfigDto: + type: object + properties: + key: + type: string + value: + type: string + Artifact: + type: object + properties: + errors: + type: array + items: + $ref: '#/components/schemas/ErrorMessage' + fileName: + type: string + type: + type: string + enum: + - HEAT + - HEAT_ENV + - HEAT_NET + - HEAT_VOL + - CHEF + - PUPPET + - SHELL + - YANG + - YANG_XML + - BPEL + - DG_XML + - MURANO_PKG + - VENDOR_LICENSE + - VF_LICENSE + - CLOUD_TECHNOLOGY_SPECIFIC_ARTIFACT + - CONTROLLER_BLUEPRINT_ARCHIVE + - HELM + - OTHER + - PNF_SW_INFORMATION + - PM_DICTIONARY + Attachment: + type: object + properties: + contentDisposition: + $ref: '#/components/schemas/ContentDisposition' + contentId: + type: string + contentType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + dataHandler: + type: object + properties: + allCommands: + type: array + items: + type: object + properties: + commandClass: + type: string + commandName: + type: string + commandMap: + type: object + properties: + mimeTypes: + type: array + items: + type: string + writeOnly: true + content: + type: object + contentType: + type: string + dataSource: + type: object + properties: + contentType: + type: string + inputStream: + type: object + name: + type: string + outputStream: + type: object + inputStream: + type: object + name: + type: string + outputStream: + type: object + preferredCommands: + type: array + items: + type: object + properties: + commandClass: + type: string + commandName: + type: string + transferDataFlavors: + type: array + items: + type: object + properties: + defaultRepresentationClassAsString: + type: string + flavorJavaFileListType: + type: boolean + flavorRemoteObjectType: + type: boolean + flavorSerializedObjectType: + type: boolean + flavorTextType: + type: boolean + humanPresentableName: + type: string + mimeType: + type: string + mimeTypeSerializedObject: + type: boolean + primaryType: + type: string + representationClassByteBuffer: + type: boolean + representationClassCharBuffer: + type: boolean + representationClassInputStream: + type: boolean + representationClassReader: + type: boolean + representationClassRemote: + type: boolean + representationClassSerializable: + type: boolean + subType: + type: string + headers: + type: object + additionalProperties: + type: array + items: + type: string + object: + type: object + ChoiceOrOtherDtoLicenseTerm: + type: object + properties: + choice: + type: string + enum: + - Fixed_Term + - Perpetual + - Unlimited + - Other + other: + type: string + required: + - choice + - other + ClientConfiguration: + type: object + properties: + enabled: + type: boolean + CommitRequestDto: + type: object + properties: + message: + type: string + ComponentComputeAssociation: + type: object + properties: + componentId: + type: string + computeFlavorId: + type: string + ComponentData: + type: object + properties: + description: + type: string + displayName: + type: string + name: + type: string + ComponentDependencyModel: + type: object + properties: + relationType: + type: string + sourceId: + type: string + targetId: + type: string + ComponentDependencyResponseDto: + type: object + properties: + id: + type: string + relationType: + type: string + sourceId: + type: string + targetId: + type: string + ComponentDto: + type: object + properties: + description: + type: string + displayName: + type: string + maxLength: 30 + minLength: 1 + id: + type: string + name: + type: string + required: + - displayName + ComponentRequestDto: + type: object + properties: + description: + type: string + displayName: + type: string + maxLength: 30 + minLength: 1 + name: + type: string + required: + - displayName + ComputeDetailsDto: + type: object + properties: + description: + type: string + maxLength: 300 + minLength: 0 + name: + type: string + maxLength: 30 + minLength: 0 + required: + - name + ComputeDto: + type: object + properties: + associatedToDeploymentFlavor: + type: boolean + description: + type: string + id: + type: string + name: + type: string + ConfigurationDataDto: + type: object + properties: + timeStamp: + type: integer + format: int64 + value: + type: string + ConflictDto: + type: object + properties: + id: + type: string + name: + type: string + theirs: + type: object + additionalProperties: + type: object + type: + type: string + enum: + - itemVersion + - VendorLicenseModel + - LicenseAgreements + - LicenseAgreement + - FeatureGroups + - FeatureGroup + - LicenseKeyGroups + - LicenseKeyGroup + - EntitlementPools + - EntitlementPool + - Limits + - Limit + - VendorSoftwareProduct + - VSPQuestionnaire + - VspModel + - NetworkPackage + - OrchestrationTemplateCandidate + - OrchestrationTemplateCandidateContent + - OrchestrationTemplateCandidateValidationData + - ORIGINAL_ONBOARDED_PACKAGE + - OrchestrationTemplateStructure + - OrchestrationTemplate + - OrchestrationTemplateValidationData + - OrchestrationTemplateContent + - Networks + - Network + - Components + - Component + - ComponentQuestionnaire + - ComponentDependencies + - ComponentDependency + - Nics + - Nic + - NicQuestionnaire + - Mibs + - SNMP_POLL + - SNMP_TRAP + - VES_EVENTS + - Processes + - Process + - DeploymentFlavors + - DeploymentFlavor + - Computes + - Compute + - ComputeQuestionnaire + - Images + - Image + - ImageQuestionnaire + - ServiceModel + - EnrichedServiceModel + - ServiceTemplate + - Templates + - Artifact + - Artifacts + - test + yours: + type: object + additionalProperties: + type: object + ConflictInfoDto: + type: object + properties: + id: + type: string + name: + type: string + type: + type: string + enum: + - itemVersion + - VendorLicenseModel + - LicenseAgreements + - LicenseAgreement + - FeatureGroups + - FeatureGroup + - LicenseKeyGroups + - LicenseKeyGroup + - EntitlementPools + - EntitlementPool + - Limits + - Limit + - VendorSoftwareProduct + - VSPQuestionnaire + - VspModel + - NetworkPackage + - OrchestrationTemplateCandidate + - OrchestrationTemplateCandidateContent + - OrchestrationTemplateCandidateValidationData + - ORIGINAL_ONBOARDED_PACKAGE + - OrchestrationTemplateStructure + - OrchestrationTemplate + - OrchestrationTemplateValidationData + - OrchestrationTemplateContent + - Networks + - Network + - Components + - Component + - ComponentQuestionnaire + - ComponentDependencies + - ComponentDependency + - Nics + - Nic + - NicQuestionnaire + - Mibs + - SNMP_POLL + - SNMP_TRAP + - VES_EVENTS + - Processes + - Process + - DeploymentFlavors + - DeploymentFlavor + - Computes + - Compute + - ComputeQuestionnaire + - Images + - Image + - ImageQuestionnaire + - ServiceModel + - EnrichedServiceModel + - ServiceTemplate + - Templates + - Artifact + - Artifacts + - test + ConflictResolutionDto: + type: object + properties: + otherResolution: + type: object + additionalProperties: + type: object + resolution: + type: string + enum: + - THEIRS + - YOURS + - OTHER + ContentDisposition: + type: object + properties: + filename: + type: string + parameters: + type: object + additionalProperties: + type: string + type: + type: string + DeploymentFlavorDto: + type: object + properties: + componentComputeAssociations: + type: array + items: + $ref: '#/components/schemas/ComponentComputeAssociation' + description: + type: string + maxLength: 300 + minLength: 0 + featureGroupId: + type: string + id: + type: string + model: + type: string + maxLength: 30 + minLength: 0 + required: + - model + DeploymentFlavorListResponseDto: + type: object + properties: + description: + type: string + id: + type: string + model: + type: string + DeploymentFlavorRequestDto: + type: object + properties: + componentComputeAssociations: + type: array + items: + $ref: '#/components/schemas/ComponentComputeAssociation' + description: + type: string + maxLength: 300 + minLength: 0 + featureGroupId: + type: string + model: + type: string + maxLength: 30 + minLength: 0 + required: + - model + EntitlementPoolEntityDto: + type: object + description: EntitlementPoolEntity + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + expiryDate: + type: string + id: + type: string + increments: + type: string + maxLength: 120 + minLength: 0 + manufacturerReferenceNumber: + type: string + maxLength: 100 + minLength: 0 + name: + type: string + maxLength: 120 + minLength: 0 + operationalScope: + $ref: '#/components/schemas/MultiChoiceOrOtherDtoOperationalScope' + referencingFeatureGroups: + type: array + items: + type: string + uniqueItems: true + startDate: + type: string + thresholdUnits: + type: string + enum: + - Absolute + - Percentage + thresholdValue: + type: integer + format: int32 + type: + type: string + enum: + - Universal + - Unique + - One_Time + versionUUID: + type: string + required: + - manufacturerReferenceNumber + - name + - type + EntitlementPoolRequestDto: + type: object + description: EntitlementPoolRequest + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + expiryDate: + type: string + increments: + type: string + maxLength: 120 + minLength: 0 + manufacturerReferenceNumber: + type: string + maxLength: 100 + minLength: 0 + name: + type: string + maxLength: 120 + minLength: 0 + operationalScope: + $ref: '#/components/schemas/MultiChoiceOrOtherDtoOperationalScope' + startDate: + type: string + thresholdUnits: + type: string + enum: + - Absolute + - Percentage + thresholdValue: + type: integer + format: int32 + type: + type: string + enum: + - Universal + - Unique + - One_Time + required: + - manufacturerReferenceNumber + - name + - type + ErrorMessage: + type: object + properties: + level: + type: string + enum: + - ERROR + - WARNING + - INFO + message: + type: string + FeatureDto: + type: object + properties: + active: + type: boolean + name: + type: string + FeatureGroupEntityDto: + type: object + description: FeatureGroupEntity + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + entitlementPoolsIds: + type: array + items: + type: string + maxItems: 2147483647 + minItems: 1 + uniqueItems: true + id: + type: string + licenseKeyGroupsIds: + type: array + items: + type: string + uniqueItems: true + name: + type: string + maxLength: 120 + minLength: 0 + partNumber: + type: string + referencingLicenseAgreements: + type: array + items: + type: string + uniqueItems: true + required: + - name + - partNumber + FeatureGroupModelDto: + type: object + description: FeatureGroupModel + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + entitlementPools: + type: array + items: + $ref: '#/components/schemas/EntitlementPoolEntityDto' + id: + type: string + licenseKeyGroups: + type: array + items: + $ref: '#/components/schemas/LicenseKeyGroupEntityDto' + name: + type: string + maxLength: 120 + minLength: 0 + partNumber: + type: string + referencingLicenseAgreements: + type: array + items: + type: string + uniqueItems: true + required: + - name + - partNumber + FeatureGroupRequestDto: + type: object + description: FeatureGroupRequest + properties: + addedEntitlementPoolsIds: + type: array + items: + type: string + uniqueItems: true + addedLicenseKeyGroupsIds: + type: array + items: + type: string + uniqueItems: true + description: + type: string + maxLength: 1000 + minLength: 0 + name: + type: string + maxLength: 120 + minLength: 0 + partNumber: + type: string + required: + - name + - partNumber + FeatureGroupUpdateRequestDto: + type: object + description: FeatureGroupUpdateRequest + properties: + addedEntitlementPoolsIds: + type: array + items: + type: string + uniqueItems: true + addedLicenseKeyGroupsIds: + type: array + items: + type: string + uniqueItems: true + description: + type: string + maxLength: 1000 + minLength: 0 + name: + type: string + maxLength: 120 + minLength: 0 + partNumber: + type: string + removedEntitlementPoolsIds: + type: array + items: + type: string + uniqueItems: true + removedLicenseKeyGroupsIds: + type: array + items: + type: string + uniqueItems: true + required: + - name + - partNumber + FeatureSetDto: + type: object + properties: + features: + type: array + items: + $ref: '#/components/schemas/FeatureDto' + uniqueItems: true + FileDataStructureDto: + type: object + properties: + artifacts: + type: array + items: + type: string + modules: + type: array + items: + $ref: '#/components/schemas/Module' + nested: + type: array + items: + type: string + unassigned: + type: array + items: + type: string + HealthInfoDto: + type: object + properties: + description: + type: string + healthCheckComponent: + type: string + enum: + - BE + - Cassandra + - Zusammen + healthStatus: + type: string + enum: + - UP + - DOWN + version: + type: string + HealthInfoDtos: + type: object + properties: + healthInfos: + type: array + items: + $ref: '#/components/schemas/HealthInfoDto' + HeatStructureTree: + type: object + properties: + artifacts: + type: array + items: + $ref: '#/components/schemas/Artifact' + uniqueItems: true + base: + type: boolean + env: + $ref: '#/components/schemas/HeatStructureTree' + errors: + type: array + items: + $ref: '#/components/schemas/ErrorMessage' + fileName: + type: string + heat: + type: array + items: + $ref: '#/components/schemas/HeatStructureTree' + uniqueItems: true + helm: + type: array + items: + $ref: '#/components/schemas/HeatStructureTree' + uniqueItems: true + nested: + type: array + items: + $ref: '#/components/schemas/HeatStructureTree' + uniqueItems: true + network: + type: array + items: + $ref: '#/components/schemas/HeatStructureTree' + uniqueItems: true + other: + type: array + items: + $ref: '#/components/schemas/HeatStructureTree' + uniqueItems: true + type: + type: string + enum: + - HEAT + - HEAT_ENV + - HEAT_NET + - HEAT_VOL + - CHEF + - PUPPET + - SHELL + - YANG + - YANG_XML + - BPEL + - DG_XML + - MURANO_PKG + - VENDOR_LICENSE + - VF_LICENSE + - CLOUD_TECHNOLOGY_SPECIFIC_ARTIFACT + - CONTROLLER_BLUEPRINT_ARCHIVE + - HELM + - OTHER + - PNF_SW_INFORMATION + - PM_DICTIONARY + volume: + type: array + items: + $ref: '#/components/schemas/HeatStructureTree' + uniqueItems: true + ImageDto: + type: object + properties: + description: + type: string + fileName: + type: string + id: + type: string + required: + - fileName + ImageRequestDto: + type: object + properties: + description: + type: string + fileName: + type: string + required: + - fileName + Item: + type: object + properties: + creationTime: + type: string + format: date-time + description: + type: string + id: + type: string + modificationTime: + type: string + format: date-time + name: + type: string + owner: + type: string + properties: + type: object + additionalProperties: + type: object + status: + type: string + enum: + - ACTIVE + - ARCHIVED + type: + type: string + versionStatusCounters: + type: object + additionalProperties: + type: integer + format: int32 + ItemActionRequestDto: + type: object + properties: + action: + type: string + enum: + - ARCHIVE + - RESTORE + ItemCreationDto: + type: object + properties: + itemId: + type: string + version: + $ref: '#/components/schemas/VersionDto' + ItemDto: + type: object + properties: + description: + type: string + id: + type: string + name: + type: string + owner: + type: string + properties: + type: object + additionalProperties: + type: object + status: + type: string + type: + type: string + ItemPermissionsDto: + type: object + properties: + permission: + type: string + userId: + type: string + ItemPermissionsRequestDto: + type: object + description: ItemPermissionsRequest + properties: + addedUsersIds: + type: array + items: + type: string + uniqueItems: true + removedUsersIds: + type: array + items: + type: string + uniqueItems: true + ItemVersionConflictDto: + type: object + properties: + conflict: + $ref: '#/components/schemas/ConflictDto' + conflictInfoList: + type: array + items: + $ref: '#/components/schemas/ConflictInfoDto' + LicenseAgreementEntityDto: + type: object + description: LicenseAgreementEntity + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + featureGroupsIds: + type: array + items: + type: string + maxItems: 2147483647 + minItems: 1 + uniqueItems: true + id: + type: string + licenseTerm: + $ref: '#/components/schemas/ChoiceOrOtherDtoLicenseTerm' + name: + type: string + maxLength: 120 + minLength: 0 + requirementsAndConstrains: + type: string + maxLength: 1000 + minLength: 0 + required: + - licenseTerm + - name + LicenseAgreementModelDto: + type: object + description: LicenseAgreementModel + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + featureGroups: + type: array + items: + $ref: '#/components/schemas/FeatureGroupEntityDto' + uniqueItems: true + id: + type: string + licenseTerm: + $ref: '#/components/schemas/ChoiceOrOtherDtoLicenseTerm' + name: + type: string + maxLength: 120 + minLength: 0 + requirementsAndConstrains: + type: string + maxLength: 1000 + minLength: 0 + required: + - licenseTerm + - name + LicenseAgreementRequestDto: + type: object + description: LicenseAgreementRequest + properties: + addedFeatureGroupsIds: + type: array + items: + type: string + uniqueItems: true + description: + type: string + maxLength: 1000 + minLength: 0 + licenseTerm: + $ref: '#/components/schemas/ChoiceOrOtherDtoLicenseTerm' + name: + type: string + maxLength: 120 + minLength: 0 + requirementsAndConstrains: + type: string + maxLength: 1000 + minLength: 0 + required: + - licenseTerm + - name + LicenseAgreementUpdateRequestDto: + type: object + description: LicenseAgreementUpdateRequest + properties: + addedFeatureGroupsIds: + type: array + items: + type: string + uniqueItems: true + description: + type: string + maxLength: 1000 + minLength: 0 + licenseTerm: + $ref: '#/components/schemas/ChoiceOrOtherDtoLicenseTerm' + name: + type: string + maxLength: 120 + minLength: 0 + removedFeatureGroupsIds: + type: array + items: + type: string + uniqueItems: true + requirementsAndConstrains: + type: string + maxLength: 1000 + minLength: 0 + required: + - licenseTerm + - name + LicenseKeyGroupEntityDto: + type: object + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + expiryDate: + type: string + id: + type: string + increments: + type: string + maxLength: 120 + minLength: 0 + manufacturerReferenceNumber: + type: string + maxLength: 100 + minLength: 0 + name: + type: string + maxLength: 120 + minLength: 0 + operationalScope: + $ref: '#/components/schemas/MultiChoiceOrOtherDtoOperationalScope' + referencingFeatureGroups: + type: array + items: + type: string + uniqueItems: true + startDate: + type: string + thresholdUnits: + type: string + enum: + - Absolute + - Percentage + thresholdValue: + type: integer + format: int32 + type: + type: string + enum: + - Universal + - Unique + - One_Time + versionUUID: + type: string + required: + - name + - type + LicenseKeyGroupRequestDto: + type: object + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + expiryDate: + type: string + increments: + type: string + maxLength: 120 + minLength: 0 + manufacturerReferenceNumber: + type: string + maxLength: 100 + minLength: 0 + name: + type: string + maxLength: 120 + minLength: 0 + operationalScope: + $ref: '#/components/schemas/MultiChoiceOrOtherDtoOperationalScope' + startDate: + type: string + thresholdUnits: + type: string + enum: + - Absolute + - Percentage + thresholdValue: + type: integer + format: int32 + type: + type: string + enum: + - Universal + - Unique + - One_Time + required: + - name + - type + LicensingData: + type: object + properties: + featureGroups: + type: array + items: + type: string + licenseAgreement: + type: string + LimitEntityDto: + type: object + properties: + aggregationFunction: + type: string + description: + type: string + id: + type: string + metric: + type: string + name: + type: string + time: + type: string + type: + type: string + unit: + type: string + value: + type: string + LimitRequestDto: + type: object + description: LimitRequest + properties: + aggregationFunction: + type: string + description: + type: string + maxLength: 1000 + minLength: 0 + metric: + type: string + name: + type: string + maxLength: 120 + minLength: 0 + time: + type: string + type: + type: string + unit: + type: string + value: + type: string + required: + - metric + - name + - type + - value + ListResponseWrapper: + type: object + properties: + actionList: + type: array + items: + $ref: '#/components/schemas/ActionResponseDto' + componentList: + type: array + items: + $ref: '#/components/schemas/OpenEcompComponent' + versions: + type: array + items: + $ref: '#/components/schemas/ActionResponseDto' + Module: + type: object + properties: + env: + type: string + isBase: + type: boolean + name: + type: string + type: + type: string + enum: + - HEAT + - HEAT_ENV + - HEAT_NET + - HEAT_VOL + - CHEF + - PUPPET + - SHELL + - YANG + - YANG_XML + - BPEL + - DG_XML + - MURANO_PKG + - VENDOR_LICENSE + - VF_LICENSE + - CLOUD_TECHNOLOGY_SPECIFIC_ARTIFACT + - CONTROLLER_BLUEPRINT_ARCHIVE + - HELM + - OTHER + - PNF_SW_INFORMATION + - PM_DICTIONARY + vol: + type: string + volEnv: + type: string + yaml: + type: string + MonitoringUploadStatusDto: + type: object + properties: + snmpPoll: + type: string + snmpTrap: + type: string + vesEvent: + type: string + MultiChoiceOrOtherDtoOperationalScope: + type: object + properties: + choices: + type: array + items: + type: string + enum: + - Network_Wide + - Availability_Zone + - Data_Center + - Tenant + - VM + - CPU + - Core + - Other + maxItems: 2147483647 + minItems: 1 + uniqueItems: true + other: + type: string + required: + - choices + - other + NetworkDto: + type: object + properties: + dhcp: + type: boolean + id: + type: string + name: + type: string + required: + - dhcp + - name + NetworkRequestDto: + type: object + properties: + dhcp: + type: boolean + name: + type: string + required: + - dhcp + - name + NicDto: + type: object + properties: + description: + type: string + id: + type: string + name: + type: string + networkDescription: + type: string + networkId: + type: string + networkName: + type: string + networkType: + type: string + required: + - name + - networkType + NicRequestDto: + type: object + properties: + description: + type: string + name: + type: string + networkDescription: + type: string + networkId: + type: string + networkType: + type: string + required: + - name + - networkType + NotificationEntityDto: + type: object + properties: + dateTime: + type: string + eventAttributes: + type: object + additionalProperties: + type: object + eventId: + type: string + format: uuid + eventType: + type: string + read: + type: boolean + NotificationsStatusDto: + type: object + properties: + endOfPage: + type: string + format: uuid + lastScanned: + type: string + format: uuid + newEntries: + type: array + items: + type: string + format: uuid + notifications: + type: array + items: + $ref: '#/components/schemas/NotificationEntityDto' + numOfNotSeenNotifications: + type: integer + format: int64 + OpenEcompComponent: + type: object + properties: + id: + type: string + name: + type: string + PackageInfoDto: + type: object + properties: + category: + type: string + description: + type: string + displayName: + type: string + models: + type: array + items: + type: string + uniqueItems: true + packageChecksum: + type: string + packageId: + type: string + packageType: + type: string + resourceType: + type: string + subCategory: + type: string + vendorName: + type: string + vendorRelease: + type: string + version: + type: string + versionId: + type: string + vspName: + type: string + ProcessEntityDto: + type: object + properties: + artifactName: + type: string + description: + type: string + id: + type: string + name: + type: string + type: + type: string + enum: + - Lifecycle_Operations + - Other + required: + - name + ProcessRequestDto: + type: object + properties: + description: + type: string + name: + type: string + type: + type: string + enum: + - Lifecycle_Operations + - Other + required: + - name + QuestionnaireResponseDto: + type: object + properties: + data: + type: string + errorMessage: + $ref: '#/components/schemas/ErrorMessage' + schema: + type: string + RemoteTestingEndpointDefinition: + type: object + properties: + apiKey: + type: string + enabled: + type: boolean + id: + type: string + scenarioFilter: + type: string + title: + type: string + url: + type: string + RevisionRequestDto: + type: object + properties: + revisionId: + type: string + SubmitRequestDto: + type: object + properties: + message: + type: string + UpdateNotificationResponseStatus: + type: object + properties: + errors: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ErrorMessage' + status: + type: string + enum: + - Success + - Failure + UploadFileResponseDto: + type: object + properties: + errors: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ErrorMessage' + networkPackageName: + type: string + onboardingOrigin: + type: string + status: + type: string + enum: + - Success + - Failure + ValidationStructureList: + type: object + properties: + importStructure: + $ref: '#/components/schemas/HeatStructureTree' + VendorLicenseModelActionRequestDto: + type: object + properties: + action: + type: string + enum: + - Submit + submitRequest: + $ref: '#/components/schemas/SubmitRequestDto' + VendorLicenseModelEntityDto: + type: object + description: VendorLicenseModelEntity + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + iconRef: + type: string + id: + type: string + vendorName: + type: string + maxLength: 25 + minLength: 0 + required: + - description + - iconRef + - vendorName + VendorLicenseModelRequestDto: + type: object + description: VendorLicenseModelRequest + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + iconRef: + type: string + vendorName: + type: string + maxLength: 25 + minLength: 0 + required: + - description + - iconRef + - vendorName + VersionActionRequestDto: + type: object + properties: + action: + type: string + enum: + - Sync + - Commit + - Revert + - Reset + - Clean + commitRequest: + $ref: '#/components/schemas/CommitRequestDto' + revisionRequest: + $ref: '#/components/schemas/RevisionRequestDto' + VersionDto: + type: object + properties: + additionalInfo: + type: object + additionalProperties: + type: object + baseId: + type: string + creationTime: + type: string + format: date-time + description: + type: string + id: + type: string + modificationTime: + type: string + format: date-time + name: + type: string + state: + $ref: '#/components/schemas/VersionState' + status: + type: string + enum: + - Draft + - Locked + - Certified + - Deprecated + - Deleted + VersionRequestDto: + type: object + properties: + creationMethod: + type: string + enum: + - major + - minor + description: + type: string + VersionSoftwareProductActionRequestDto: + type: object + properties: + action: + type: string + enum: + - Submit + - Create_Package + submitRequest: + $ref: '#/components/schemas/SubmitRequestDto' + VersionState: + type: object + properties: + dirty: + type: boolean + synchronizationState: + type: string + enum: + - Up to date + - Out of sync + - Merging + VspComputeDto: + type: object + properties: + componentId: + type: string + computeFlavorId: + type: string + name: + type: string + VspDescriptionDto: + type: object + properties: + category: + type: string + description: + type: string + icon: + type: string + licenseType: + type: string + enum: + - EXTERNAL + - INTERNAL + licensingData: + $ref: '#/components/schemas/LicensingData' + licensingVersion: + type: string + name: + type: string + selectedModelList: + type: array + items: + type: string + subCategory: + type: string + vendorId: + type: string + vendorName: + type: string + required: + - category + - description + - name + - subCategory + - vendorId + - vendorName + VspDetailsDto: + type: object + description: VspDetails + properties: + candidateOnboardingOrigin: + type: string + category: + type: string + description: + type: string + icon: + type: string + id: + type: string + licenseType: + type: string + enum: + - EXTERNAL + - INTERNAL + licensingData: + $ref: '#/components/schemas/LicensingData' + licensingVersion: + type: string + name: + type: string + networkPackageName: + type: string + onboardingMethod: + type: string + onboardingOrigin: + type: string + owner: + type: string + selectedModelList: + type: array + items: + type: string + status: + type: string + subCategory: + type: string + validationData: + $ref: '#/components/schemas/ValidationStructureList' + vendorId: + type: string + vendorName: + type: string + version: + type: string + required: + - category + - description + - name + - onboardingMethod + - subCategory + - vendorId + - vendorName + VspRequestDto: + type: object + properties: + category: + type: string + description: + type: string + icon: + type: string + licenseType: + type: string + enum: + - EXTERNAL + - INTERNAL + licensingData: + $ref: '#/components/schemas/LicensingData' + licensingVersion: + type: string + name: + type: string + onboardingMethod: + type: string + selectedModelList: + type: array + items: + type: string + subCategory: + type: string + vendorId: + type: string + vendorName: + type: string + required: + - category + - description + - name + - onboardingMethod + - subCategory + - vendorId + - vendorName diff --git a/docs/openapi/openapi-sdce-2-sdce-5.json b/docs/openapi/openapi-sdce-2-sdce-5.json new file mode 100644 index 0000000000..eb2bfb5aaf --- /dev/null +++ b/docs/openapi/openapi-sdce-2-sdce-5.json @@ -0,0 +1,55154 @@ +{ + "openapi" : "3.0.1", + "info" : { + "contact" : { + "email" : "onap-discuss@lists.onap.org", + "name" : "ONAP", + "url" : "https://onap.readthedocs.io" + }, + "description" : "SDC API for designing services and resources (SDCE-2) and distributing services (SDCE-5)", + "license" : { + "name" : "Apache 2.0", + "url" : "http://www.apache.org/licenses/LICENSE-2.0" + }, + "title" : "SPC API: SDCE-2 and SDCE-5", + "version" : "1.0" + }, + "servers" : [ { + "description" : "SDCE-2 and SDCE-5 APIs", + "url" : "/sdc" + } ], + "paths" : { + "/actuator/prometheus" : { + "get" : { + "description" : "Gets the prometheus micrometer application metrics", + "operationId" : "prometheus", + "parameters" : [ { + "description" : "The Accept header to determine the output content type", + "in" : "header", + "name" : "Accept", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Prometheus Micrometer Metrics", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/config/get" : { + "get" : { + "description" : "Retrieve configuration", + "operationId" : "getConfig_1", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "OK" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/configmgr/get" : { + "get" : { + "operationId" : "getConfig", + "parameters" : [ { + "in" : "query", + "name" : "type", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/configmgr/set1" : { + "post" : { + "operationId" : "setConfig1", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Configuration" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "text/plain" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/configmgr/set2" : { + "post" : { + "operationId" : "setConfig2", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Configuration" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "text/plain" : { } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/configmgr/setput1" : { + "put" : { + "operationId" : "setConfig3", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Configuration" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "text/plain" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/configmgr/setput2" : { + "put" : { + "operationId" : "setConfig4", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Configuration" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "text/plain" : { } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/healthCheck" : { + "get" : { + "description" : "Return aggregate BE health check of SDC BE components", + "operationId" : "getHealthCheck", + "responses" : { + "200" : { + "description" : "SDC BE components are all up" + }, + "500" : { + "description" : "One or more SDC BE components are down" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "return BE health check", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/artifactTypes" : { + "get" : { + "description" : "Retrieve all artifactTypes", + "operationId" : "getArtifactTypes", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Returns artifactTypes Ok" + }, + "404" : { + "description" : "No artifactTypes were found" + }, + "500" : { + "description" : "Internal Server Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/User" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Retrieve all artifactTypes", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/allDataTypes" : { + "get" : { + "description" : "Get data types", + "operationId" : "getAllDataTypesFromAllModels", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "allDataTypes" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Data 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 all data types from all models", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/archive" : { + "get" : { + "description" : "Get all Archived Components", + "operationId" : "getArchivedComponents", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Success" + }, + "400" : { + "description" : "Bad request" + }, + "403" : { + "description" : "Restricted operation" + }, + "500" : { + "description" : "Internal Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Get all Archived Components", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/artifactTypes" : { + "get" : { + "description" : "Get Tosca ArtifactTypes", + "operationId" : "getAllToscaArtifactTypes", + "parameters" : [ { + "description" : "Model name", + "in" : "query", + "name" : "model", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Listing successful" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Tosca Artifact Types not found" + }, + "default" : { + "content" : { + "*/*" : { + "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 tosca artifact types", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/audit-records/{componentType}/{componentUniqueId}" : { + "get" : { + "description" : "get component audit records", + "operationId" : "getComponentAuditRecords", + "parameters" : [ { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentUniqueId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Service found" + }, + "403" : { + "description" : "Restricted operation" + }, + "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" : "get audit records for a service or a resource", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/capabilityTypes" : { + "get" : { + "description" : "Get capability types", + "operationId" : "getAllCapabilityTypesServlet", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "description" : "model", + "in" : "query", + "name" : "model", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "capabilityTypes" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Capability 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 capability types", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/data-types/{dataTypeUid}" : { + "get" : { + "description" : "Get data types", + "operationId" : "fetchDataType", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "dataTypeUid", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Data type found" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Data types not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DataTypeDataDefinition" + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns data types", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/data-types/{id}/properties" : { + "get" : { + "description" : "Get a data type properties", + "operationId" : "fetchProperties", + "parameters" : [ { + "description" : "The data type id", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Data type found, properties may be empty" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Data type not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns the data type properties", + "tags" : [ "SDCE-2 APIs" ] + }, + "post" : { + "description" : "Create a property in the given data type", + "operationId" : "createProperty", + "parameters" : [ { + "description" : "The data type id", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PropertyDefinitionDto" + } + } + }, + "description" : "Property to add", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Property created in the data type" + }, + "400" : { + "description" : "Invalid payload" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Data type not found" + }, + "409" : { + "description" : "Property already exists in the data type" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PropertyDefinitionDto" + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Create a property in the given data type", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/dataTypes" : { + "get" : { + "description" : "Get data types", + "operationId" : "getAllDataTypesServlet", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "description" : "model", + "in" : "query", + "name" : "model", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "datatypes" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Data 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 data types", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/directives" : { + "get" : { + "description" : "Retrieve all Directives values from configuration file", + "operationId" : "getConfCategoriesAndVersion", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Returns Directive values from configuration file Ok" + }, + "404" : { + "description" : "Directive not found" + }, + "500" : { + "description" : "Internal Server Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/User" + } + } + } + } + } + }, + "summary" : "Retrieve all Directives", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/gab/searchFor" : { + "post" : { + "description" : "Search json paths inside the yaml", + "operationId" : "searchFor", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GenericArtifactQueryInfo" + } + } + }, + "description" : "Generic Artifact search model", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Returned yaml entries" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "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 found entries of json paths", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/groupTypes" : { + "get" : { + "description" : "Get group types ", + "operationId" : "getGroupTypes", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "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" + } + } ], + "responses" : { + "200" : { + "description" : "group types found" + }, + "400" : { + "description" : "field name invalid type/length, characters; mandatory field is absent, already exists (name)" + }, + "403" : { + "description" : "Restricted operation" + }, + "500" : { + "description" : "Internal Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupTypeDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns group types", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/handleException" : { + "get" : { + "description" : "Handle exception", + "operationId" : "sendError", + "responses" : { + "500" : { + "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" + } + } + } + } + } + } + }, + "description" : "Internal Error" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/interfaceLifecycleTypes" : { + "get" : { + "description" : "Get interface lifecycle types", + "operationId" : "getInterfaceLifecycleTypes", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "description" : "model", + "in" : "query", + "name" : "model", + "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/lock" : { + "post" : { + "description" : "Toggle disable locking", + "operationId" : "toggleDisableLocking", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "boolean" + } + } + }, + "description" : "Disable Locking" + }, + "responses" : { + "200" : { + "description" : "Disable locking successfully updated" + }, + "500" : { + "description" : "Update disable locking failed" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/model" : { + "get" : { + "description" : "List all the existing TOSCA models", + "operationId" : "listModels", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "modelType", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Listing successful" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Model" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "List TOSCA models", + "tags" : [ "SDCE-2 APIs" ] + }, + "post" : { + "description" : "Create a TOSCA model, along with its imports files", + "operationId" : "createModel", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object", + "properties" : { + "model" : { + "$ref" : "#/components/schemas/ModelCreateRequest" + }, + "modelImportsZip" : { + "type" : "object", + "description" : "the model TOSCA imports zipped" + } + }, + "required" : [ "model", "modelImportsZip" ] + } + } + } + }, + "responses" : { + "201" : { + "description" : "Model created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Model already exists" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Create a TOSCA model", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/model/imports" : { + "put" : { + "description" : "Update a model TOSCA imports", + "operationId" : "updateModelImports", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object", + "properties" : { + "modelImportsZip" : { + "type" : "object", + "description" : "the model TOSCA imports zipped" + }, + "modelName" : { + "type" : "string", + "description" : "model to be created" + } + }, + "required" : [ "modelImportsZip", "modelName" ] + } + } + } + }, + "responses" : { + "204" : { + "description" : "Model imports updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Model not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Update a model TOSCA imports", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/nodeTypes" : { + "get" : { + "description" : "Get node types", + "operationId" : "getAllNodeTypesServlet", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "description" : "model", + "in" : "query", + "name" : "model", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "nodeTypes" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Node 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 node types", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/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" : [ { + "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/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" : "policy types found" + }, + "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" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns policy types", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/relationshipTypes" : { + "get" : { + "description" : "Get relationship types", + "operationId" : "getAllRelationshipTypesServlet", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "description" : "model", + "in" : "query", + "name" : "model", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "relationshipTypes" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Relationship 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 relationship types", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources" : { + "post" : { + "description" : "Create Resource", + "operationId" : "createResource", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "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" + } + } + } + } + } + }, + "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}/interfaceOperation" : { + "put" : { + "description" : "Update Interface Operation", + "operationId" : "updateResourceInterfaceOperation", + "parameters" : [ { + "description" : "Component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Update Interface Operation" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Update Interface Operation on ComponentInstance", + "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" + } + }, { + "description" : "Optional parameter to determine the delete action: DELETE, which will permanently delete the Resource from the system or MARK_AS_DELETE, which will logically mark the Resource as deleted. Default action is to MARK_AS_DELETE", + "in" : "query", + "name" : "deleteAction", + "schema" : { + "type" : "string", + "enum" : [ "MARK_AS_DELETE", "DELETE" ] + } + } ], + "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" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated Additional Inforamtion property", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}/artifacts" : { + "post" : { + "description" : "Create Artifact", + "operationId" : "loadArtifact", + "parameters" : [ { + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "json describe the artifact", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Resource created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Artifact 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 ArtifactDefinition", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}/artifacts/{artifactId}" : { + "delete" : { + "description" : "Delete Artifact", + "operationId" : "deleteArtifact", + "parameters" : [ { + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Resource created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "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 delete artifact", + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "Download resource Artifact in Base64", + "operationId" : "downloadResourceArtifactBase64", + "parameters" : [ { + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Resource artifact downloaded" + }, + "404" : { + "description" : "Resource/Artifact 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 downloaded artifact", + "tags" : [ "SDCE-2 APIs" ] + }, + "post" : { + "description" : "Update Artifact", + "operationId" : "updateArtifact", + "parameters" : [ { + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "json describe the artifact", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Resource created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated artifact", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}/attributes" : { + "get" : { + "description" : "Get Resource Attribute", + "operationId" : "getAttributeListInResource", + "parameters" : [ { + "description" : "resource id of attribute", + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "attribute" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Resource attribute 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 attribute list of resource", + "tags" : [ "SDCE-2 APIs" ] + }, + "post" : { + "description" : "Create Resource Attribute", + "operationId" : "createAttribute", + "parameters" : [ { + "description" : "resource id to update with new attribute", + "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" : "Resource attribute to be created", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Resource property created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Resource attribute 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 resource attribute", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}/attributes/{attributeId}" : { + "delete" : { + "description" : "Create Resource Attribute", + "operationId" : "deleteAttribute", + "parameters" : [ { + "description" : "resource id of attribute", + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Attribute id to delete", + "in" : "path", + "name" : "attributeId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "deleted attribute" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Resource property 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 deleted attribute", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update Resource Attribute", + "operationId" : "updateAttribute", + "parameters" : [ { + "description" : "resource id to update with new attribute", + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "attribute id to update", + "in" : "path", + "name" : "attributeId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Resource attribute to update", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Resource attribute updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated attribute", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}/capabilities" : { + "post" : { + "description" : "Create Capabilities on resource", + "operationId" : "createCapabilitiesOnResource", + "parameters" : [ { + "description" : "Resource Id", + "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" : "Capability to create", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Create Capabilities" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Capability 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" : "Create Capabilities on resource", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update Capabilities on resource", + "operationId" : "updateCapabilitiesOnResource", + "parameters" : [ { + "description" : "Component Id", + "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" : "Capabilities to update", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Update Capabilities" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CapabilityDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Update Capabilities on resource", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}/capabilities/{capabilityId}" : { + "delete" : { + "description" : "Delete capability from resource", + "operationId" : "deleteCapabilityOnResource", + "parameters" : [ { + "description" : "capability Id", + "in" : "path", + "name" : "capabilityId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Resource Id", + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Delete capability" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CapabilityDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Delete capability from resource", + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "Get Capability from resource", + "operationId" : "getCapabilityOnResource", + "parameters" : [ { + "description" : "Resource Id", + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Capability Id", + "in" : "path", + "name" : "capabilityId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "GET Capability" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CapabilityDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "GET Capability from resource", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}/interfaceOperations" : { + "post" : { + "description" : "Create Interface Operations on Resource", + "operationId" : "createInterfaceOperationsOnResource", + "parameters" : [ { + "description" : "Resource Id", + "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" : "Interface Operations to create", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Create Interface Operations on Resource" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Resource not found" + }, + "409" : { + "description" : "Interface Operation already exist" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/InterfaceDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Create Interface Operations on Resource", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update Interface Operations on Resource", + "operationId" : "updateInterfaceOperationsOnResource", + "parameters" : [ { + "description" : "Resource Id", + "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" : "Interface Operations to update", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Update Interface Operations on Resource" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Resource not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/InterfaceDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Update Interface Operations on Resource", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}/interfaces/{interfaceId}/operations/{operationId}" : { + "delete" : { + "description" : "Delete Interface Operation from Resource", + "operationId" : "deleteInterfaceOperationsFromResource", + "parameters" : [ { + "description" : "Resource Id", + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Interface Id", + "in" : "path", + "name" : "interfaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Operation Id", + "in" : "path", + "name" : "operationId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Delete Interface Operation from Resource" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Resource not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/InterfaceDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Delete Interface Operation from Resource", + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "Get Interface Operation from Resource", + "operationId" : "getInterfaceOperationsFromResource", + "parameters" : [ { + "description" : "Resource Id", + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Interface Id", + "in" : "path", + "name" : "interfaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Operation Id", + "in" : "path", + "name" : "operationId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Delete Interface Operation from Resource" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Resource not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/InterfaceDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "GET Interface Operation from Resource", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}/metadata" : { + "put" : { + "description" : "Update Resource Metadata", + "operationId" : "updateResourceMetadata", + "parameters" : [ { + "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" : "Resource metadata to be updated", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Resource metadata updated" + }, + "400" : { + "description" : "Invalid content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated resource metadata", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}/properties" : { + "get" : { + "description" : "Get Resource Property", + "operationId" : "getPropertyListInResource", + "parameters" : [ { + "description" : "resource id of property", + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "property" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Resource property 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 property list of resource", + "tags" : [ "SDCE-2 APIs" ] + }, + "post" : { + "description" : "Create Resource Property", + "operationId" : "createPropertyInResource", + "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" : "Resource property to be created", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Resource property created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Resource property 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 service property", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update Resource Property", + "operationId" : "updatePropertyInResource", + "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" : "Resource property to update", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Resource property updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated property", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}/properties/{propertyId}" : { + "delete" : { + "description" : "Delete Resource Property", + "operationId" : "deletePropertyInResource", + "parameters" : [ { + "description" : "resource id of property", + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Property id to delete", + "in" : "path", + "name" : "propertyId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "deleted property" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Resource property 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 deleted property", + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "Get Resource Property", + "operationId" : "getPropertyInResource", + "parameters" : [ { + "description" : "resource id of property", + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "property id to get", + "in" : "path", + "name" : "propertyId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "property" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Resource property 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 property of resource", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}/requirements" : { + "post" : { + "description" : "Create requirements on resource", + "operationId" : "createRequirementsOnResource", + "parameters" : [ { + "description" : "Resource Id", + "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" : "Requirement to create", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Create requirements" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "requirement 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" : "Create requirements on resource", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update Requirements on resource", + "operationId" : "updateRequirementsOnResource", + "parameters" : [ { + "description" : "Component Id", + "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" : "Requirements to update", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Update Requirements" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Update Requirements on resource", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}/requirements/{requirementId}" : { + "delete" : { + "description" : "Delete requirements from resource", + "operationId" : "deleteRequirementsFromResource", + "parameters" : [ { + "description" : "Resource Id", + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "requirement Id", + "in" : "path", + "name" : "requirementId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Delete requirement" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Delete requirements from resource", + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "Get Requirement from resource", + "operationId" : "getRequirementsFromResource", + "parameters" : [ { + "description" : "Resource Id", + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Requirement Id", + "in" : "path", + "name" : "requirementId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "GET requirement" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "GET Requirement from resource", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts" : { + "post" : { + "description" : "Create Artifact and Attach to interface", + "operationId" : "loadArtifactToInterface", + "parameters" : [ { + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "interfaceType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "operation", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "Content-MD5", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "json describe the artifact", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Resource created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Artifact 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 resource", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts/{artifactId}" : { + "delete" : { + "description" : "delete Artifact from interface", + "operationId" : "deleteArtifactToInterface", + "parameters" : [ { + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "interfaceType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "operation", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "delete artifact under interface deleted" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Artifact 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" : "delete matching artifact from interface", + "tags" : [ "SDCE-2 APIs" ] + }, + "post" : { + "description" : "update Artifact Attach to interface", + "operationId" : "updateArtifactToInterface", + "parameters" : [ { + "in" : "path", + "name" : "resourceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "interfaceType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "operation", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "Content-MD5", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "json describe the artifact", + "required" : true + }, + "responses" : { + "201" : { + "description" : "delete artifact under interface deleted" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Artifact 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" : "updates artifact by interface", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/resources/{resourceName}/{version}" : { + "delete" : { + "description" : "Delete Resource By Name And Version", + "operationId" : "deleteResourceByNameAndVersion", + "parameters" : [ { + "in" : "path", + "name" : "resourceName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "Resource deleted" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Resource not found" + }, + "default" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns no content", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services" : { + "post" : { + "description" : "Create Service", + "operationId" : "createService", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Service object to be created", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Service created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Service already exist" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Service" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns created service", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/distribution/{did}" : { + "get" : { + "description" : "Retrieve Distributions", + "operationId" : "getListOfDistributionStatuses", + "parameters" : [ { + "in" : "path", + "name" : "did", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Service found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Status not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DistributionStatusListResponse" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Return the list of distribution status objects", + "tags" : [ "SDCE-5 APIs" ] + } + }, + "/v1/catalog/services/importService" : { + "post" : { + "description" : "Import Service", + "operationId" : "importNsService", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Service object to be imported", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Service created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Service already exist" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns imported service", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/replaceVNF" : { + "post" : { + "description" : "Replace new VNF based on the existing VNF", + "operationId" : "replaceVNF", + "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" : "string" + } + } + }, + "description" : "Resource object to be created", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ReplaceVNFInfo" + } + } + } + }, + "description" : "ECOMP component is authenticated and list of Catalog Assets Metadata is returned" + }, + "400" : { + "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "404" : { + "description" : "Error: Requested '%1' (uuid) resource was not found - SVC4063" + }, + "405" : { + "description" : "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050" + }, + "409" : { + "description" : "Service already exist" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Return whether the replace VNF is successful", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/serviceName/{serviceName}/serviceVersion/{serviceVersion}" : { + "get" : { + "description" : "Retrieve Service", + "operationId" : "getServiceByNameAndVersion", + "parameters" : [ { + "in" : "path", + "name" : "serviceName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "serviceVersion", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Service found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Service not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Service" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns service according to name and version", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/serviceUUID/{uuid}/importReplaceService" : { + "post" : { + "description" : "Import Service", + "operationId" : "importReplaceService", + "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" + } + }, { + "description" : "The requested asset uuid", + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "object", + "properties" : { + "serviceZip" : { + "$ref" : "#/components/schemas/FormDataContentDisposition" + }, + "serviceZipMetadata" : { + "type" : "string", + "description" : "serviceMetadata" + } + } + } + } + } + }, + "responses" : { + "201" : { + "description" : "Service created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Service already exist" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns imported service", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/validate-name/{serviceName}" : { + "get" : { + "description" : "validate service name", + "operationId" : "validateServiceName", + "parameters" : [ { + "in" : "path", + "name" : "serviceName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Service found" + }, + "403" : { + "description" : "Restricted operation" + }, + "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" : "checks if the chosen service name is available ", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{componentId}/archive" : { + "post" : { + "description" : "Archive Service", + "operationId" : "archiveService", + "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" : "Service not found" + }, + "500" : { + "description" : "Internal Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Marks a service as archived. Can be restored with restore action", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{componentId}/copyComponentInstance/{componentInstanceId}" : { + "post" : { + "description" : "Copy Component Instance", + "operationId" : "copyComponentInstance", + "parameters" : [ { + "description" : "service unique id in pasted canvas", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Data for copying", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Copy and Paste Success" + }, + "400" : { + "description" : "Invalid Content / Missing content" + }, + "403" : { + "description" : "Restricted Operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Service" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated service information", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{componentId}/restore" : { + "post" : { + "description" : "Restore Service", + "operationId" : "restoreService", + "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" : "Service not found" + }, + "500" : { + "description" : "Internal Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Restores a service from archive.", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}" : { + "delete" : { + "description" : "Delete Service", + "operationId" : "deleteService", + "parameters" : [ { + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Optional parameter to determine the delete action: DELETE, which will permanently delete theService from the system or MARK_AS_DELETE, which will logically mark the service as deleted. Default action is to MARK_AS_DELETE", + "in" : "query", + "name" : "deleteAction", + "schema" : { + "type" : "string", + "enum" : [ "DELETE", "MARK_AS_DELETE" ] + } + } ], + "responses" : { + "204" : { + "description" : "Service deleted" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Service not found" + }, + "default" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Service" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Return no content", + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "Retrieve Service", + "operationId" : "getServiceById_1", + "parameters" : [ { + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Service found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Service not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Service" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns service according to serviceId", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/additionalinfo" : { + "get" : { + "description" : "Get all Additional Information under service", + "operationId" : "getAllServiceAdditionalInformationLabel", + "parameters" : [ { + "description" : "service id to update with new property", + "in" : "path", + "name" : "serviceId", + "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" : "createServiceAdditionalInformationLabel", + "parameters" : [ { + "description" : "service id to update with new property", + "in" : "path", + "name" : "serviceId", + "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/services/{serviceId}/additionalinfo/{labelId}" : { + "delete" : { + "description" : "Create Additional Information Label and Value", + "operationId" : "deleteServiceAdditionalInformationLabel", + "parameters" : [ { + "description" : "service id to update with new property", + "in" : "path", + "name" : "serviceId", + "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" : "getServiceAdditionalInformationLabel", + "parameters" : [ { + "description" : "service id to update with new property", + "in" : "path", + "name" : "serviceId", + "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" : "updateServiceAdditionalInformationLabel", + "parameters" : [ { + "description" : "service id to update with new property", + "in" : "path", + "name" : "serviceId", + "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" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated Additional Inforamtion property", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/artifacts" : { + "post" : { + "description" : "Create Artifact", + "operationId" : "loadInformationArtifact", + "parameters" : [ { + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "json describe the artifact", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Resource created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Artifact 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 ArtifactDefinition", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/artifacts/api/{artifactId}" : { + "delete" : { + "description" : "Delete Api Artifact", + "operationId" : "deleteApiArtifact", + "parameters" : [ { + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "Content-MD5", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "Api Artifact deleted" + }, + "403" : { + "description" : "Restricted operation" + }, + "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 ArtifactDefinition", + "tags" : [ "SDCE-2 APIs" ] + }, + "post" : { + "description" : "Update Api Artifact", + "operationId" : "updateApiArtifact", + "parameters" : [ { + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "Content-MD5", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "json describe the artifact", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Api Artifact Updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "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 ArtifactDefinition", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/artifacts/{artifactId}" : { + "delete" : { + "description" : "Delete Artifact", + "operationId" : "deleteInformationalArtifact", + "parameters" : [ { + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Service artifact deleted" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "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 delete artifact", + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "Download service Artifact in Base64", + "operationId" : "downloadServiceArtifactBase64", + "parameters" : [ { + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Service artifact downloaded" + }, + "404" : { + "description" : "Service/Artifact 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 downloaded artifact", + "tags" : [ "SDCE-2 APIs" ] + }, + "post" : { + "description" : "Update Artifact", + "operationId" : "updateInformationArtifact", + "parameters" : [ { + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "json describe the artifact", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Service artifact created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated artifact", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/attributes" : { + "get" : { + "description" : "Get Service Attribute", + "operationId" : "getAttributeListInService", + "parameters" : [ { + "description" : "service id of attribute", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "attribute" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Service attribute 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 attribute list of service", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/capabilities" : { + "post" : { + "description" : "Create Capabilities on service", + "operationId" : "createCapabilitiesOnService", + "parameters" : [ { + "description" : "Service Id", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Capability to create", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Create Capabilities" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Capability 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" : "Create Capabilities on service", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update Capabilities on service", + "operationId" : "updateCapabilitiesOnService", + "parameters" : [ { + "description" : "Component Id", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Capabilities to update", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Update Capabilities" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CapabilityDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Update Capabilities on service", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/capabilities/{capabilityId}" : { + "delete" : { + "description" : "Delete capability from service", + "operationId" : "deleteCapabilityOnService", + "parameters" : [ { + "description" : "capability Id", + "in" : "path", + "name" : "capabilityId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Service Id", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Delete capability" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CapabilityDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Delete capability from service", + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "Get Capability from service", + "operationId" : "getCapabilityOnService", + "parameters" : [ { + "description" : "Service Id", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Capability Id", + "in" : "path", + "name" : "capabilityId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "GET Capability" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CapabilityDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "GET Capability from service", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/consumption/{serviceInstanceId}" : { + "post" : { + "description" : "Service consumption on operation", + "operationId" : "addInputToServiceOperation", + "parameters" : [ { + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "serviceInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Service Consumption Data", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Service property created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Service property 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 consumption data", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/consumption/{serviceInstanceId}/interfaces/{interfaceId}/operations/{operationId}/inputs" : { + "get" : { + "operationId" : "getInputsListOfOperation", + "parameters" : [ { + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "serviceInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "interfaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "operationId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "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/services/{serviceId}/distribution/{did}/markDeployed" : { + "post" : { + "description" : "Mark distribution as deployed", + "operationId" : "markDistributionAsDeployed", + "parameters" : [ { + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "did", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Service was marked as deployed" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Service is not available" + }, + "404" : { + "description" : "Requested service was not found" + }, + "409" : { + "description" : "Restricted operation" + }, + "500" : { + "description" : "Internal Server Error. Please try again later." + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "relevant audit record will be created", + "tags" : [ "SDCE-5 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/distribution/{env}/activate" : { + "post" : { + "description" : "Activate distribution", + "operationId" : "activateDistribution", + "parameters" : [ { + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "env", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "404" : { + "description" : "Requested service was not found" + }, + "409" : { + "description" : "Service cannot be distributed due to missing deployment artifacts" + }, + "500" : { + "description" : "Internal Server Error. Please try again later." + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "activate distribution", + "tags" : [ "SDCE-5 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/interfaceOperations" : { + "post" : { + "description" : "Create Interface Operations on Service", + "operationId" : "createInterfaceOperationsOnService", + "parameters" : [ { + "description" : "Service Id", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Interface Operations to create", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Create Interface Operations on Service" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Service not found" + }, + "409" : { + "description" : "Interface Operation already exist" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/InterfaceDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Create Interface Operations on Service", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update Interface Operations on Service", + "operationId" : "updateInterfaceOperationsOnService", + "parameters" : [ { + "description" : "Service Id", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Interface Operations to update", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Update Interface Operations on Service" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Service not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/InterfaceDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Update Interface Operations on Service", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/interfaces/{interfaceId}/operations/{operationId}" : { + "delete" : { + "description" : "Delete Interface Operation from Service", + "operationId" : "deleteInterfaceOperationsFromService", + "parameters" : [ { + "description" : "Service Id", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Interface Id", + "in" : "path", + "name" : "interfaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Operation Id", + "in" : "path", + "name" : "operationId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Delete Interface Operation from Service" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Service not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/InterfaceDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Delete Interface Operation from Service", + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "Get Interface Operation from Service", + "operationId" : "getInterfaceOperationsFromService", + "parameters" : [ { + "description" : "Service Id", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Interface Id", + "in" : "path", + "name" : "interfaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Operation Id", + "in" : "path", + "name" : "operationId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Get Interface Operation from Service" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Service not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/InterfaceDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "GET Interface Operation from Service", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/linksMap" : { + "get" : { + "description" : "Retrieve Service component relations map", + "operationId" : "getServiceComponentRelationMap", + "parameters" : [ { + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Service found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Service not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServiceRelations" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns service components relations", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/metadata" : { + "put" : { + "description" : "Update Service Metadata", + "operationId" : "updateServiceMetadata", + "parameters" : [ { + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "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" : "Service Updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Service" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated service", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/paths" : { + "post" : { + "description" : "Create Forwarding Path", + "operationId" : "createForwardingPath", + "parameters" : [ { + "description" : "Service Id", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Forwarding Path to create", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Create Forwarding Path" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Forwarding Path already exist" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Service" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Create Forwarding Path", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update Forwarding Path", + "operationId" : "updateForwardingPath", + "parameters" : [ { + "description" : "Service Id", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Update Path to create", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Update Forwarding Path" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Forwarding Path already exist" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Service" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Update Forwarding Path", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/paths/{forwardingPathId}" : { + "delete" : { + "description" : "Delete Forwarding Path", + "operationId" : "deleteForwardingPath", + "parameters" : [ { + "description" : "Forwarding Path Id", + "in" : "path", + "name" : "forwardingPathId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Service Id", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Delete Forwarding Path" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Forwarding Path already exist" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Service" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Delete Forwarding Path", + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "Get Forwarding Path", + "operationId" : "getForwardingPath", + "parameters" : [ { + "description" : "Service Id", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Forwarding Path Id", + "in" : "path", + "name" : "forwardingPathId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Forwarding Path to create", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Get Forwarding Path" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Forwarding Path already exist" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ForwardingPathDataDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "GET Forwarding Path", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/properties" : { + "get" : { + "description" : "Get Service Property", + "operationId" : "getPropertyListInService", + "parameters" : [ { + "description" : "service id of property", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "property" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Service property 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 property list of service", + "tags" : [ "SDCE-2 APIs" ] + }, + "post" : { + "description" : "Create Service Property", + "operationId" : "createPropertyInService", + "parameters" : [ { + "description" : "service id to update with new property", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Service property to be created", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Service property created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Service property 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 service property", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update Service Property", + "operationId" : "updatePropertyInService", + "parameters" : [ { + "description" : "service id to update with new property", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Service property to update", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Service property updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated property", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/properties/{propertyId}" : { + "delete" : { + "description" : "Delete Service Property", + "operationId" : "deletePropertyInService", + "parameters" : [ { + "description" : "service id of property", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Property id to delete", + "in" : "path", + "name" : "propertyId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "deleted property" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Service property 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 deleted property", + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "Get Service Property", + "operationId" : "getPropertyInService", + "parameters" : [ { + "description" : "service id of property", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "property id to get", + "in" : "path", + "name" : "propertyId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "property" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Service property 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 property of service", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/requirements" : { + "post" : { + "description" : "Create requirements on service", + "operationId" : "createRequirementsOnService", + "parameters" : [ { + "description" : "Service Id", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Requirements to create", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Create Requirements" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Requirement 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" : "Create requirements on service", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update requirements on service", + "operationId" : "updateRequirementsOnService", + "parameters" : [ { + "description" : "Component Id", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Requirements to update", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Update requirements" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Update requirements on service", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/requirements/{requirementId}" : { + "delete" : { + "description" : "Delete requirement from service", + "operationId" : "deleteRequirementsOnService", + "parameters" : [ { + "description" : "Service Id", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Requirement Id", + "in" : "path", + "name" : "requirementId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Delete Requirements" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Delete requirement from service", + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "Get requirement from service", + "operationId" : "getRequirementsOnService", + "parameters" : [ { + "description" : "Service Id", + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Requirement Id", + "in" : "path", + "name" : "requirementId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "GET Requirements" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "GET requirement from service", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceId}/tempUrlToBeDeleted" : { + "post" : { + "operationId" : "tempUrlToBeDeleted", + "parameters" : [ { + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "500" : { + "description" : "Internal Server Error. Please try again later." + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceName}/{version}" : { + "delete" : { + "description" : "Delete Service By Name And Version", + "operationId" : "deleteServiceByNameAndVersion", + "parameters" : [ { + "in" : "path", + "name" : "serviceName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "Service deleted" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Service not found" + }, + "default" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns no content", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/services/{serviceUUID}/distribution" : { + "get" : { + "description" : "Retrieve Distributions", + "operationId" : "getServiceById", + "parameters" : [ { + "in" : "path", + "name" : "serviceUUID", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Service found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Service not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DistributionStatusListResponse" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns list bases on the information extracted from Auditing Records according to service uuid", + "tags" : [ "SDCE-5 APIs" ] + } + }, + "/v1/catalog/toggle" : { + "get" : { + "description" : "Get all Toggleable features", + "operationId" : "getAllFeatures", + "responses" : { + "200" : { + "description" : "Success" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Toggleable features 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 list of toggleable features", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/toggle/state/{state}" : { + "put" : { + "description" : "Update all feature toggle state", + "operationId" : "setAllFeatures", + "parameters" : [ { + "in" : "path", + "name" : "state", + "required" : true, + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "description" : "Success" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Toggleable features not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Update all feature status", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/toggle/{featureName}/state" : { + "get" : { + "description" : "Get Toggleable feature state", + "operationId" : "getToggleableFeature", + "parameters" : [ { + "in" : "path", + "name" : "featureName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Success" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Toggleable feature 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 one toggleable feature state", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/toggle/{featureName}/state/{state}" : { + "put" : { + "description" : "Update feature toggle state", + "operationId" : "updateFeatureState", + "parameters" : [ { + "in" : "path", + "name" : "featureName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "state", + "required" : true, + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "description" : "Success" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Toggleable features not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Update feature status", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/upload/resource/import" : { + "post" : { + "description" : "Import node types from a TOSCA yaml, along with the types metadata", + "operationId" : "bulkImport", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object", + "properties" : { + "createNewVersion" : { + "type" : "boolean", + "default" : true, + "description" : "The model name to associate the node types to" + }, + "nodeTypeMetadataJson" : { + "$ref" : "#/components/schemas/NodeTypesMetadataList" + }, + "nodeTypesYaml" : { + "type" : "object", + "description" : "The node types TOSCA definition yaml" + } + }, + "required" : [ "nodeTypeMetadataJson", "nodeTypesYaml" ] + } + } + } + }, + "responses" : { + "201" : { + "description" : "Resources created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "One of the resources already exists" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Creates node types from a TOSCA yaml file", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/upload/{resourceAuthority}" : { + "post" : { + "description" : "Create Resource from yaml", + "operationId" : "uploadMultipart", + "parameters" : [ { + "description" : "validValues: normative-resource / user-resource", + "in" : "path", + "name" : "resourceAuthority", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "multipart", "user-resource", "user-resource-ui-import" ] + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "createNewVersion", + "schema" : { + "type" : "boolean", + "default" : true + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object", + "properties" : { + "resourceMetadata" : { + "type" : "string", + "description" : "resourceMetadata" + }, + "resourceZip" : { + "$ref" : "#/components/schemas/FormDataContentDisposition" + } + } + } + } + } + }, + "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" : { + "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 resource", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/uploadType/annotationtypes" : { + "post" : { + "description" : "Create AnnotationTypes from yaml", + "operationId" : "uploadAnnotationTypes", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object", + "properties" : { + "annotationTypesZip" : { + "type" : "string", + "format" : "binary", + "description" : "FileInputStream" + } + } + } + } + } + }, + "responses" : { + "201" : { + "description" : "annotation types created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "annotation types 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 annotation types", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/uploadType/artifactTypes" : { + "post" : { + "description" : "Create Tosca Artifact types from yaml", + "operationId" : "uploadArtifactTypes", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object", + "properties" : { + "artifactsZip" : { + "type" : "string", + "format" : "binary", + "description" : "Zip file containing a yaml with the TOSCA artifact types definition" + }, + "includeToModelImport" : { + "type" : "boolean", + "description" : "A flag to add types to the default imports" + }, + "model" : { + "type" : "string", + "description" : "model name" + } + } + } + } + } + }, + "responses" : { + "201" : { + "description" : "Tosca Artifact types created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Tosca Artifact Type 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 Tosca artifact types", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/uploadType/capability" : { + "post" : { + "description" : "Create Capability Type from yaml", + "operationId" : "uploadCapabilityType", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object", + "properties" : { + "capabilityTypeZip" : { + "type" : "string", + "format" : "binary", + "description" : "FileInputStream" + }, + "includeToModelImport" : { + "type" : "boolean", + "description" : "includeToModelImport" + }, + "model" : { + "type" : "string", + "description" : "model" + } + } + } + } + } + }, + "responses" : { + "201" : { + "description" : "Capability Type created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Capability Type 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 Capability Type", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/uploadType/categories" : { + "post" : { + "description" : "Create Categories from yaml", + "operationId" : "uploadCategories", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object", + "properties" : { + "categoriesZip" : { + "type" : "string", + "format" : "binary", + "description" : "FileInputStream" + } + } + } + } + } + }, + "responses" : { + "201" : { + "description" : "Categories created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Category 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 categories", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/uploadType/datatypes" : { + "post" : { + "description" : "Create Categories from yaml", + "operationId" : "uploadDataTypes", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object", + "properties" : { + "dataTypesZip" : { + "type" : "string", + "format" : "binary", + "description" : "FileInputStream" + }, + "includeToModelImport" : { + "type" : "boolean", + "description" : "includeToModelImport" + }, + "model" : { + "type" : "string", + "description" : "model" + } + } + } + } + } + }, + "responses" : { + "201" : { + "description" : "Data types created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Data types 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 data types", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/uploadType/grouptypes" : { + "post" : { + "description" : "Create GroupTypes from yaml", + "operationId" : "uploadGroupTypes", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object", + "properties" : { + "groupTypesZip" : { + "type" : "string", + "format" : "binary", + "description" : "FileInputStream" + }, + "includeToModelImport" : { + "type" : "boolean", + "description" : "includeToModelImport" + }, + "model" : { + "type" : "string", + "description" : "model" + }, + "toscaTypeMetadata" : { + "type" : "string", + "description" : "toscaTypeMetadata" + } + } + } + } + } + }, + "responses" : { + "201" : { + "description" : "group types created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "group types 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 group types", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/uploadType/interfaceLifecycle" : { + "post" : { + "description" : "Create Interface Lyfecycle Type from yaml", + "operationId" : "uploadInterfaceLifecycleType", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object", + "properties" : { + "includeToModelImport" : { + "type" : "boolean", + "description" : "includeToModelImport" + }, + "interfaceLifecycleTypeZip" : { + "type" : "string", + "format" : "binary", + "description" : "FileInputStream" + }, + "model" : { + "type" : "string", + "description" : "model" + } + } + } + } + } + }, + "responses" : { + "201" : { + "description" : "Interface Lifecycle Type created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Interface Lifecycle Type 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 Interface Lifecycle Type", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/uploadType/policytypes" : { + "post" : { + "description" : "Create PolicyTypes from yaml", + "operationId" : "uploadPolicyTypes", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object", + "properties" : { + "includeToModelImport" : { + "type" : "boolean", + "description" : "includeToModelImport" + }, + "model" : { + "type" : "string", + "description" : "model" + }, + "policyTypesZip" : { + "type" : "string", + "format" : "binary", + "description" : "FileInputStream" + }, + "toscaTypeMetadata" : { + "type" : "string", + "description" : "toscaTypeMetadata" + } + } + } + } + } + }, + "responses" : { + "201" : { + "description" : "policy types created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "policy types 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 policy types", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/uploadType/relationship" : { + "post" : { + "description" : "Create Relationship Type from yaml", + "operationId" : "uploadRelationshipType", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object", + "properties" : { + "includeToModelImport" : { + "type" : "boolean", + "description" : "includeToModelImport" + }, + "model" : { + "type" : "string", + "description" : "model" + }, + "relationshipTypeZip" : { + "type" : "string", + "format" : "binary", + "description" : "FileInputStream" + } + } + } + } + } + }, + "responses" : { + "201" : { + "description" : "Relationship Type created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Relationship Type 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 Relationship Type", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{assetType}/{uuid}/interfaces/{interfaceUUID}/operations/{operationUUID}/artifacts/{artifactUUID}" : { + "post" : { + "description" : "uploads of artifact to component operation workflow", + "operationId" : "uploadInterfaceOperationArtifact", + "parameters" : [ { + "description" : "Asset type", + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The uuid of the asset as published in the metadata", + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The uuid of the interface", + "in" : "path", + "name" : "interfaceUUID", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The uuid of the operation", + "in" : "path", + "name" : "operationUUID", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The uuid of the artifact", + "in" : "path", + "name" : "artifactUUID", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "Content-MD5", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + } + } + }, + "description" : "Artifact uploaded" + }, + "400" : { + "description" : "Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301" + }, + "404" : { + "description" : "Specified resource is not found - SVC4063" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "uploads of artifact to component operation workflow", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/latestversion/notabstract" : { + "get" : { + "description" : "Get Component Requirments And Capabilities", + "operationId" : "getLatestVersionNotAbstractCheckoutComponents", + "parameters" : [ { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "internalComponentType", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "componentUids", + "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" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns Requirments And Capabilities according to componentId", + "tags" : [ "SDCE-2 APIs" ] + }, + "post" : { + "description" : "Get Component Requirments And Capabilities", + "operationId" : "getLatestVersionNotAbstractCheckoutComponentsByBody", + "parameters" : [ { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "internalComponentType", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "description" : "Consumer 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" : "Returns Requirments And Capabilities according to componentId", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/latestversion/notabstract/metadata" : { + "get" : { + "description" : "Get Component uid only", + "operationId" : "getLatestVersionNotAbstractCheckoutComponentsIdesOnly", + "parameters" : [ { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "internalComponentType", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "componentModel", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "includeNormativeExtensionModels", + "schema" : { + "type" : "boolean" + } + }, { + "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 componentId", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/automatedupgrade" : { + "post" : { + "description" : "Autometed upgrade", + "operationId" : "autometedUpgrade", + "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" : "json describes upgrade request", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Component found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component 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" : "....", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/interfaceOperation" : { + "put" : { + "description" : "Update Interface Operation", + "operationId" : "updateComponentInstanceInterfaceOperation", + "parameters" : [ { + "description" : "valid values: resources / services", + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + }, { + "description" : "Component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Component Instance Id", + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Update Interface Operation" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Update Interface Operation on ComponentInstance", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/{constraintType}/nodeFilter" : { + "post" : { + "description" : "Add Component Filter Constraint", + "operationId" : "addComponentFilterConstraint", + "parameters" : [ { + "description" : "Component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Component Instance Id", + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "valid values: resources / services", + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + }, { + "description" : "Constraint type. Valid values: properties / capabilities", + "in" : "path", + "name" : "constraintType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "properties", "capabilities" ] + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "UIConstraint data", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Create Component Filter" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "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" + } + } + } + } + } + } + } + } + } + }, + "summary" : "Add Component Filter Constraint", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/{constraintType}/{constraintIndex}/nodeFilter" : { + "delete" : { + "description" : "Delete Component Filter Constraint", + "operationId" : "deleteComponentFilterConstraint", + "parameters" : [ { + "description" : "Component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Component Instance Id", + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Constraint Index", + "in" : "path", + "name" : "constraintIndex", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "description" : "valid values: resources / services", + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + }, { + "description" : "Constraint type. Valid values: properties / capabilities", + "in" : "path", + "name" : "constraintType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "properties", "capabilities" ] + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Delete Component Filter Constraint" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "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" + } + } + } + } + } + } + } + } + } + }, + "summary" : "Delete Component Filter Constraint", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update Component Filter Constraint", + "operationId" : "updateComponentFilterConstraint", + "parameters" : [ { + "description" : "Component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Component Instance Id", + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "valid values: resources / services", + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + }, { + "description" : "Constraint type. Valid values: properties / capabilities", + "in" : "path", + "name" : "constraintType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "properties", "capabilities" ] + } + }, { + "description" : "Constraint Index", + "in" : "path", + "name" : "constraintIndex", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "UIConstraint data", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Create Component Filter" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "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" + } + } + } + } + } + } + } + } + } + }, + "summary" : "Update Component Filter Constraint", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/componentInstances" : { + "get" : { + "description" : "Get Component instances", + "operationId" : "getComponentInstancesFilteredByPropertiesAndInputs", + "parameters" : [ { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "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", + "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 input", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/create/outputs" : { + "post" : { + "description" : "Create outputs on service", + "operationId" : "createMultipleOutputs", + "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 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", + "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 policies 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 policies list", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/dataType/{dataTypeName}" : { + "delete" : { + "description" : "Delete data type from service", + "operationId" : "deleteDataType", + "parameters" : [ { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "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" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "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", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "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" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "inputId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Service Input to be deleted", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Input deleted" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Input 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" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/delete/{outputId}/output" : { + "delete" : { + "description" : "Delete output from service", + "operationId" : "deleteOutput", + "parameters" : [ { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "outputId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Service Output to be deleted", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Output deleted" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Output not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Delete service output", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/dependencies" : { + "get" : { + "description" : "Autometed upgrade", + "operationId" : "getComponentDependencies", + "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" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "description" : "Consumer 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" : { + "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" : "....", + "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", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/requirmentsCapabilities" : { + "get" : { + "description" : "Get Component Requirments And Capabilities", + "operationId" : "getRequirementAndCapabilities", + "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" + } + } ], + "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}/resource/interfaceOperation" : { + "post" : { + "description" : "Create Interface Operation", + "operationId" : "createInterfaceOperationInResource", + "parameters" : [ { + "description" : "valid values: resources", + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources" ] + } + }, { + "description" : "Component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Create Interface Operation" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Create Interface Operation on ComponentInstance", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}" : { + "post" : { + "description" : "Add Component Substitution Filter Constraint", + "operationId" : "addSubstitutionFilter", + "parameters" : [ { + "description" : "Component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "valid value: resources / services", + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "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", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "UIConstraint data", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Add Substitution Filter Constraint" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "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" + } + } + } + } + } + } + } + } + } + }, + "summary" : "Add Component Substitution Filter Constraint", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update Component Substitution Filter Constraint", + "operationId" : "updateSubstitutionFilters", + "parameters" : [ { + "description" : "Component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "valid value: resources / services", + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "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", + "name" : "USER_ID", + "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" + }, + "403" : { + "description" : "Restricted operation" + }, + "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" + } + } + } + } + } + } + } + } + } + }, + "summary" : "Update Component Substitution Filter Constraint", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}/{constraintIndex}" : { + "delete" : { + "description" : "Delete Component Substitution Filter Constraint", + "operationId" : "deleteSubstitutionFilterConstraint", + "parameters" : [ { + "description" : "Component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Constraint Index", + "in" : "path", + "name" : "constraintIndex", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "description" : "valid value: resources / services", + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "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", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Delete Substitution Filter Constraint" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "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" + } + } + } + } + } + } + } + } + } + }, + "summary" : "Delete Component Substitution Filter Constraint", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update Component Substitution Filter Constraint", + "operationId" : "updateSubstitutionFilter", + "parameters" : [ { + "description" : "Constraint Index", + "in" : "path", + "name" : "constraintIndex", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "description" : "Component Id", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The component type", + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "services", "resources" ] + } + }, { + "description" : "Constraint type. Valid values: properties / capabilities", + "in" : "path", + "name" : "constraintType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "properties", "capabilities" ] + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UIConstraint" + } + } + }, + "description" : "Filter constraint information", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Update Substitution Filter Constraint" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "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" + } + } + } + } + } + } + } + } + } + }, + "summary" : "Update Component Substitution Filter Constraint", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{componentType}/{componentUuid}/conformanceLevelValidation" : { + "get" : { + "description" : "Validate Component Conformance Level", + "operationId" : "conformanceLevelValidation", + "parameters" : [ { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentUuid", + "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 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" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactGroupType", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Component artifacts" + }, + "404" : { + "description" : "Resource/Artifact 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 artifacts", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/batchDeleteResourceInstances" : { + "post" : { + "description" : "Batch Delete ResourceInstances", + "operationId" : "batchDeleteResourceInstances", + "parameters" : [ { + "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" + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "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" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupDefinition" + } + } + }, + "description" : "GroupDefinition", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Group updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "component / group Not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated Group", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupType}" : { + "post" : { + "description" : "Create group ", + "operationId" : "createGroup", + "parameters" : [ { + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "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" : [ { + "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" : { + "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" : "Component not found" + }, + "500" : { + "description" : "Internal Error" + }, + "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 group id", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/members" : { + "post" : { + "description" : "Update group members ", + "operationId" : "updateGroupMembers", + "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" : { + "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" : { + "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" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "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" + }, + "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" : { + "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 forwarding paths to delete", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}" : { + "delete" : { + "description" : "Delete Policy", + "operationId" : "deletePolicy", + "parameters" : [ { + "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" ] + } + }, { + "in" : "path", + "name" : "policyId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "USER_ID of modifier user", + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "Policy was deleted" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "component / policy 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" : "No body", + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "Get Policy", + "operationId" : "getPolicy", + "parameters" : [ { + "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" ] + } + }, { + "in" : "path", + "name" : "policyId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "USER_ID of modifier user", + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Policy was found" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "component / policy 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 Policy", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update Policy metadata", + "operationId" : "updatePolicy", + "parameters" : [ { + "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" ] + } + }, { + "in" : "path", + "name" : "policyId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "USER_ID of modifier user", + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "PolicyDefinition", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Policy 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" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated Policy", + "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", + "parameters" : [ { + "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" ] + } + }, { + "in" : "path", + "name" : "policyId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "USER_ID of modifier user", + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "PolicyDefinition", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Policy properties 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" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated Policy", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/targets" : { + "post" : { + "description" : "update policy targets", + "operationId" : "updatePolicyTargets", + "parameters" : [ { + "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" ] + } + }, { + "in" : "path", + "name" : "policyId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "USER_ID of modifier user", + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PolicyTargetDTO" + } + } + } + } + }, + "responses" : { + "201" : { + "description" : "Policy target updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated Policy", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/undeclare" : { + "put" : { + "description" : "undeclare Policy", + "operationId" : "undeclarePolicy", + "parameters" : [ { + "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" ] + } + }, { + "in" : "path", + "name" : "policyId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "USER_ID of modifier user", + "in" : "header", + "name" : "USER_ID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "Policy was undeclared" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "component / policy 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" : "No body", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyTypeName}" : { + "post" : { + "description" : "Create Policy", + "operationId" : "createPolicy", + "parameters" : [ { + "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" ] + } + }, { + "in" : "path", + "name" : "policyTypeName", + "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" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component not found" + }, + "409" : { + "description" : "Policy 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 Policy", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/relationId/{relationId}" : { + "get" : { + "description" : "Get relation", + "operationId" : "getRelationById", + "parameters" : [ { + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "relationId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "relation found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Relation 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 relation metadata according to relationId", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance" : { + "post" : { + "description" : "Create ComponentInstance", + "operationId" : "createComponentInstance", + "parameters" : [ { + "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" : "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" : { + "201" : { + "description" : "Component created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Component instance 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 ComponentInstance", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/associate" : { + "post" : { + "description" : "Associate RI to RI", + "operationId" : "associateRIToRI", + "parameters" : [ { + "description" : "unique id of the container component", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "allowed values are resources /services / products", + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services", "products" ] + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "RelationshipInfo", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Relationship created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Missing information" + }, + "409" : { + "description" : "Relationship 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 RelationshipInfo", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/batchDissociate" : { + "put" : { + "description" : "Batch Dissociate RI from RI", + "operationId" : "batchDissociateRIFromRI", + "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, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "RelationshipInfo", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Relationship deleted" + }, + "400" : { + "description" : "Invalid Content / Missing Content" + }, + "403" : { + "description" : "Missing Information" + }, + "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 RelationShip Info", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/createAndAssociate" : { + "post" : { + "description" : "Create RI and associate RI to RI", + "operationId" : "createAndAssociateRIToRI", + "parameters" : [ { + "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", "products" ] + } + } ], + "responses" : { + "201" : { + "description" : "RI created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Relationship 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 RI and RelationshipInfo", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/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" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services", "products" ] + } + }, { + "description" : "unique id of the container component", + "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" : "RelationshipInfo", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Relationship deleted" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Missing information" + }, + "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 RelationshipInfo", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/multipleComponentInstance" : { + "post" : { + "description" : "Update resource instance multiple component", + "operationId" : "updateMultipleComponentInstance", + "parameters" : [ { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "valid values: resources / services / products", + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services", "products" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Component Instance JSON Array", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Resource instance updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated resource instance", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}" : { + "post" : { + "description" : "Update resource instance", + "operationId" : "updateComponentInstanceMetadata", + "parameters" : [ { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "valid values: resources / services / products", + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services", "products" ] + } + } ], + "responses" : { + "200" : { + "description" : "Resource instance updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated resource instance", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts" : { + "post" : { + "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" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "json describe the artifact", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Artifact updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated artifact", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}" : { + "delete" : { + "description" : "Delete Resource Instance artifact", + "operationId" : "deleteComponentInstanceArtifact", + "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", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "json describe the artifact", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Artifact updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "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 artifact", + "tags" : [ "SDCE-2 APIs" ] + }, + "post" : { + "description" : "Update Resource Instance artifact payload", + "operationId" : "updateComponentInstanceArtifact", + "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", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "json describe the artifact", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Artifact updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated artifact", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}/heatParams" : { + "post" : { + "description" : "Update Resource Instance HEAT_ENV parameters", + "operationId" : "updateRIArtifact", + "parameters" : [ { + "description" : "valid values: resources / services", + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "json describe the artifact", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Artifact updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated artifact", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/attributes" : { + "post" : { + "description" : "Update resource instance attribute", + "operationId" : "updateResourceInstanceAttribute", + "parameters" : [ { + "description" : "service id", + "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" : "resource instance id", + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "id of user initiating the operation", + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Component Instance Properties JSON Array", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Resource instance created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated resource instance property", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/changeVersion" : { + "post" : { + "description" : "Update resource instance", + "operationId" : "changeResourceInstanceVersion", + "parameters" : [ { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "valid values: resources / services", + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + } ], + "responses" : { + "201" : { + "description" : "Resource instance created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated resource instance", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/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, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "groupInstId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "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" : { + "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 artifacts metadata according to groupInstId", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}/property" : { + "post" : { + "description" : "Update resource instance property", + "operationId" : "updateGroupInstanceProperty", + "parameters" : [ { + "description" : "service id", + "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" : "resource instance id", + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "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", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Resource instance created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated resource instance property", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/inputs" : { + "post" : { + "description" : "Update resource instance property", + "operationId" : "updateResourceInstanceInput", + "parameters" : [ { + "description" : "service id", + "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" : "resource instance id", + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "id of user initiating the operation", + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Component Instance Properties JSON Array", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Resource instance created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated resource instance property", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/properties" : { + "post" : { + "description" : "Update resource instance property", + "operationId" : "updateResourceInstanceProperties", + "parameters" : [ { + "description" : "service id", + "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" : "resource instance id", + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "id of user initiating the operation", + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Component Instance Properties JSON Array", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Resource instance created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated resource instance property", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property/{propertyId}" : { + "delete" : { + "description" : "Update resource instance", + "operationId" : "deleteResourceInstanceProperty", + "parameters" : [ { + "description" : "service id", + "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" : "resource instance id", + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "property id", + "in" : "path", + "name" : "propertyId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "id of user initiating the operation", + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Resource instance created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "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 resource instance property", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{resourceInstanceId}" : { + "delete" : { + "description" : "Delete ResourceInstance", + "operationId" : "deleteResourceInstance", + "parameters" : [ { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "resourceInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "valid values: resources / services / products", + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services", "products" ] + } + } ], + "responses" : { + "201" : { + "description" : "ResourceInstance deleted" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "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 delete resourceInstance", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/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, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "ResourceInstance artifact downloaded" + }, + "404" : { + "description" : "ResourceInstance/Artifact 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 downloaded artifact", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifactsByType/{artifactGroupType}" : { + "get" : { + "description" : "Get component Artifacts", + "operationId" : "getComponentInstanceArtifacts", + "parameters" : [ { + "description" : "valid values: resources / services", + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactGroupType", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Component artifacts" + }, + "404" : { + "description" : "Resource/Artifact 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 artifacts", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/update/inputs" : { + "post" : { + "description" : "Update resource inputs", + "operationId" : "updateComponentInputs", + "parameters" : [ { + "description" : "valid values: resources / services", + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + }, { + "in" : "path", + "name" : "componentId", + "required" : true, + "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" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated input", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/attributes" : { + "get" : { + "description" : "Get component instance attributes", + "operationId" : "getInstanceAttributesById", + "parameters" : [ { + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "containerComponentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceUniqueId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Attributes found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component/Component Instance - 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 component instance attributes", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/capability" : { + "put" : { + "description" : "Update Component Instance Capability", + "operationId" : "updateInstanceRequirement", + "parameters" : [ { + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "containerComponentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceUniqueId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentInstanceCapabilityUpdateModel" + } + } + }, + "description" : "Component instance capability to update", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Resource instance capability successfully updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component/Component Instance/Capability not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated Component Instance Capability", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/capability/{capabilityType}/capabilityName/{capabilityName}/ownerId/{ownerId}/properties" : { + "get" : { + "description" : "Get component instance capability properties", + "operationId" : "getInstanceCapabilityPropertiesById", + "parameters" : [ { + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "containerComponentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceUniqueId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "capabilityType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "capabilityName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "ownerId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Properties found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component/Component Instance/Capability - not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns component instance capability properties", + "tags" : [ "SDCE-2 APIs" ] + }, + "put" : { + "description" : "Update Instance Capabilty Property", + "operationId" : "updateInstanceCapabilityProperty", + "parameters" : [ { + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "containerComponentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceUniqueId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "capabilityType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "capabilityName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "ownerId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Instance capabilty property to update", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Resource instance capabilty property updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component/Component Instance/Capability - not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated property", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/properties" : { + "get" : { + "description" : "Get component instance properties", + "operationId" : "getInstancePropertiesById", + "parameters" : [ { + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "containerComponentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceUniqueId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Properties found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component/Component Instance - 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 component instance properties", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/requirement/{capabilityType}/requirementName/{requirementName}" : { + "put" : { + "description" : "Update Instance Requirement", + "operationId" : "updateInstanceRequirement_1", + "parameters" : [ { + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "containerComponentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceUniqueId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "capabilityType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "requirementName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Instance capabilty requirement to update", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Resource instance requirement updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Component/Component Instance/Requirement - not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated requirement", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy" : { + "post" : { + "description" : "Create service proxy", + "operationId" : "createServiceProxy", + "parameters" : [ { + "in" : "path", + "name" : "containerComponentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "valid values: resources / services", + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "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" : { + "201" : { + "description" : "Service proxy created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Service proxy 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 service proxy", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}" : { + "delete" : { + "description" : "Delete service proxy", + "operationId" : "deleteServiceProxy", + "parameters" : [ { + "in" : "path", + "name" : "containerComponentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "serviceProxyId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "valid values: resources / services / products", + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + } ], + "responses" : { + "201" : { + "description" : "Service proxy deleted" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "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 delete service proxy", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}/changeVersion/{newServiceId}" : { + "post" : { + "description" : "Update service proxy with new version", + "operationId" : "changeServiceProxyVersion", + "parameters" : [ { + "in" : "path", + "name" : "containerComponentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "serviceProxyId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "valid values: resources / services", + "in" : "path", + "name" : "containerComponentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + } ], + "responses" : { + "201" : { + "description" : "Service proxy created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "allowedMethods" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "cookies" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "expiry" : { + "type" : "string", + "format" : "date-time" + }, + "httpOnly" : { + "type" : "boolean" + }, + "maxAge" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "secure" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + } + } + } + }, + "date" : { + "type" : "string", + "format" : "date-time" + }, + "entity" : { + "type" : "object" + }, + "entityTag" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "weak" : { + "type" : "boolean" + } + } + }, + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "language" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string" + }, + "displayCountry" : { + "type" : "string" + }, + "displayLanguage" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "displayScript" : { + "type" : "string" + }, + "displayVariant" : { + "type" : "string" + }, + "extensionKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "iso3Country" : { + "type" : "string" + }, + "iso3Language" : { + "type" : "string" + }, + "language" : { + "type" : "string" + }, + "script" : { + "type" : "string" + }, + "unicodeLocaleAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "unicodeLocaleKeys" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "variant" : { + "type" : "string" + } + } + }, + "lastModified" : { + "type" : "string", + "format" : "date-time" + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "links" : { + "type" : "array", + "items" : { + "type" : "object", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "type" : "object" + } + } + }, + "uniqueItems" : true + }, + "location" : { + "type" : "string", + "format" : "uri" + }, + "mediaType" : { + "type" : "object", + "properties" : { + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "subtype" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "wildcardSubtype" : { + "type" : "boolean" + }, + "wildcardType" : { + "type" : "boolean" + } + } + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "statusInfo" : { + "type" : "object", + "properties" : { + "family" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] + }, + "reasonPhrase" : { + "type" : "string" + }, + "statusCode" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "stringHeaders" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated service proxy", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalog/{containerComponentType}/{serviceId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}" : { + "put" : { + "description" : "Update Group Instance Property Values", + "operationId" : "updateGroupInstancePropertyValues", + "parameters" : [ { + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "groupInstanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Group instance object to be Updated", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Group Instance Property Values Updated" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Service" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns updated group instance", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/catalogUpdateTime" : { + "get" : { + "description" : "Retrieve previus and current catalog update time", + "operationId" : "getCatalogUpdateTime", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Retrieve previus and current catalog update time" + }, + "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" : "Retrieve previus and current catalog update time", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/categories/{componentType}" : { + "get" : { + "description" : "Retrieve the list of all resource/service/product categories/sub-categories/groupings", + "operationId" : "getComponentCategories", + "parameters" : [ { + "description" : "allowed values are resources / services/ products", + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services", "products" ] + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Returns categories Ok" + }, + "400" : { + "description" : "Invalid component type" + }, + "403" : { + "description" : "Missing information" + }, + "409" : { + "description" : "Restricted operation" + }, + "500" : { + "description" : "Internal Server Error" + }, + "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" : "Retrieve the list of all resource/service/product categories/sub-categories/groupings.", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/category/{componentType}" : { + "post" : { + "description" : "Create new component category", + "operationId" : "createComponentCategory", + "parameters" : [ { + "description" : "allowed values are resources /services / products", + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services", "products" ] + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Category to be created", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Category created" + }, + "400" : { + "description" : "Invalid category data" + }, + "403" : { + "description" : "USER_ID header is missing" + }, + "409" : { + "description" : "Category already exists / User not permitted to perform the action" + }, + "500" : { + "description" : "General Error" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Create new component category", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/category/{componentType}/{categoryId}/subCategory" : { + "post" : { + "description" : "Create new component sub-category", + "operationId" : "createComponentSubCategory", + "parameters" : [ { + "description" : "allowed values are resources / products", + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "products" ] + } + }, { + "description" : "Parent category unique ID", + "in" : "path", + "name" : "categoryId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Subcategory to be created. \ne.g. {\"name\":\"Resource-subcat\"}", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Subcategory created" + }, + "400" : { + "description" : "Invalid subcategory data" + }, + "403" : { + "description" : "USER_ID header is missing" + }, + "404" : { + "description" : "Parent category wasn't found" + }, + "409" : { + "description" : "Subcategory already exists / User not permitted to perform the action" + }, + "500" : { + "description" : "General Error" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Create new component sub-category for existing category", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/category/{componentType}/{categoryId}/subCategory/{subCategoryId}/grouping" : { + "post" : { + "description" : "Create new component grouping", + "operationId" : "createComponentGrouping", + "parameters" : [ { + "description" : "allowed values are products", + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "products" ] + } + }, { + "description" : "Parent category unique ID", + "in" : "path", + "name" : "categoryId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Parent sub-category unique ID", + "in" : "path", + "name" : "subCategoryId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Subcategory to be created", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Grouping created" + }, + "400" : { + "description" : "Invalid grouping data" + }, + "403" : { + "description" : "USER_ID header is missing" + }, + "404" : { + "description" : "Parent category or subcategory were not found" + }, + "409" : { + "description" : "Grouping already exists / User not permitted to perform the action" + }, + "500" : { + "description" : "General Error" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Create new component grouping for existing sub-category", + "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", + "operationId" : "deleteComponentCategory", + "parameters" : [ { + "in" : "path", + "name" : "categoryUniqueId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "Category deleted" + }, + "403" : { + "description" : "USER_ID header is missing" + }, + "404" : { + "description" : "Category not found" + }, + "409" : { + "description" : "User not permitted to perform the action" + }, + "500" : { + "description" : "General Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Category" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Delete component category", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}" : { + "delete" : { + "description" : "Delete component category", + "operationId" : "deleteComponentSubCategory", + "parameters" : [ { + "in" : "path", + "name" : "categoryUniqueId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "subCategoryUniqueId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "Category deleted" + }, + "403" : { + "description" : "USER_ID header is missing" + }, + "404" : { + "description" : "Category not found" + }, + "409" : { + "description" : "User not permitted to perform the action" + }, + "500" : { + "description" : "General Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Category" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Delete component category", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}/grouping/{groupingUniqueId}" : { + "delete" : { + "description" : "Delete component category", + "operationId" : "deleteComponentGrouping", + "parameters" : [ { + "in" : "path", + "name" : "categoryUniqueId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "subCategoryUniqueId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "groupingUniqueId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "Category deleted" + }, + "403" : { + "description" : "USER_ID header is missing" + }, + "404" : { + "description" : "Category not found" + }, + "409" : { + "description" : "User not permitted to perform the action" + }, + "500" : { + "description" : "General Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Category" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Delete component category", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/consumers" : { + "post" : { + "description" : "Consumer credentials", + "operationId" : "createConsumer", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "Consumer Object to be created", + "required" : true + }, + "responses" : { + "201" : { + "description" : "Consumer credentials created" + }, + "400" : { + "description" : "Invalid content / Missing content" + }, + "403" : { + "description" : "Restricted operation" + }, + "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 ECOMP consumer credentials", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/consumers/{consumerId}" : { + "delete" : { + "description" : "Deletes Consumer", + "operationId" : "deleteConsumer", + "parameters" : [ { + "in" : "path", + "name" : "consumerId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "Consumer deleted" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Consumer not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ConsumerDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns deleted consumer according to ConsumerID", + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "Retrieve Consumer", + "operationId" : "getConsumer", + "parameters" : [ { + "in" : "path", + "name" : "consumerId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Consumer found" + }, + "403" : { + "description" : "Restricted operation" + }, + "404" : { + "description" : "Consumer not found" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ConsumerDefinition" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns consumer according to ConsumerID", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/ecompPortalMenu" : { + "get" : { + "description" : "Retrieve ecomp portal menu - MOC", + "operationId" : "getListOfCsars", + "responses" : { + "200" : { + "description" : "Retrieve ecomp portal menu" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/User" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Retrieve ecomp portal menu", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/followed" : { + "get" : { + "description" : "Retrieve all followed", + "operationId" : "getFollowedResourcesServices", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Returns followed Ok" + }, + "404" : { + "description" : "User not found" + }, + "500" : { + "description" : "Internal Server Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/User" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Retrieve all followed", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/inactiveComponents/{componentType}" : { + "delete" : { + "operationId" : "deleteMarkedResources", + "parameters" : [ { + "in" : "path", + "name" : "componentType", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "*/*" : { } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/propertyScopes" : { + "get" : { + "description" : "Retrieve all propertyScopes", + "operationId" : "getPropertyScopes", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Returns propertyScopes Ok" + }, + "404" : { + "description" : "No propertyScopes were found" + }, + "500" : { + "description" : "Internal Server Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/User" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Retrieve all propertyScopes", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/screen" : { + "get" : { + "description" : "Retrieve catalog resources and services", + "operationId" : "getCatalogComponents", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "excludeTypes", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "PRODUCT", "SERVICE", "VF", "VFC", "CP", "VL", "Configuration", "VFCMT", "CVFC", "PNF", "CR", "ServiceProxy", "ServiceSubstitution" ] + } + } + } ], + "responses" : { + "200" : { + "description" : "Returns resources and services Ok" + }, + "404" : { + "description" : "User not found" + }, + "500" : { + "description" : "Internal Server Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/User" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Retrieve catalog resources and services", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/setup/ui" : { + "get" : { + "description" : "Retrieve all artifactTypes, ui configuration and sdc version", + "operationId" : "getConfCategoriesAndVersion_1", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Returns artifactTypes, ui configuration and sdc version Ok" + }, + "404" : { + "description" : "No artifactTypes were found/no ui configuration were found/no sdc version were found" + }, + "500" : { + "description" : "Internal Server Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/User" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Retrieve all artifactTypes, ui configuration and sdc version", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/tags" : { + "get" : { + "description" : "Retrieve all tags", + "operationId" : "getTags", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Returns tags Ok" + }, + "404" : { + "description" : "No tags were found" + }, + "500" : { + "description" : "Internal Server Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/User" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Retrieve all tags", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/user" : { + "post" : { + "description" : "add user", + "operationId" : "createUser", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User" + } + } + }, + "description" : "json describe the user", + "required" : true + }, + "responses" : { + "201" : { + "description" : "New user created" + }, + "400" : { + "description" : "Invalid Content." + }, + "403" : { + "description" : "Missing information" + }, + "405" : { + "description" : "Method Not Allowed" + }, + "409" : { + "description" : "User already exists" + }, + "500" : { + "description" : "Internal Server Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/User" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Provision new user", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/user/admins" : { + "get" : { + "description" : "retrieve all administrators", + "operationId" : "getAdminsUser", + "responses" : { + "200" : { + "description" : "Returns user Ok" + }, + "405" : { + "description" : "Method Not Allowed" + }, + "500" : { + "description" : "Internal Server Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/User" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns all administrators", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/user/authorize" : { + "get" : { + "description" : "authorize", + "operationId" : "authorize", + "parameters" : [ { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "HTTP_CSP_FIRSTNAME", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "HTTP_CSP_LASTNAME", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "HTTP_CSP_EMAIL", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Returns user Ok" + }, + "403" : { + "description" : "Restricted Access" + }, + "500" : { + "description" : "Internal Server Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/User" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "authorize user", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/user/users" : { + "get" : { + "description" : "Retrieve the list of all active ASDC users or only group of users having specific roles.", + "operationId" : "getUsersList", + "parameters" : [ { + "description" : "Any active user's USER_ID ", + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "description" : "TESTER,DESIGNER,PRODUCT_STRATEGIST,OPS,PRODUCT_MANAGER,GOVERNOR, ADMIN OR all users by not typing anything", + "in" : "query", + "name" : "roles", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Returns users Ok" + }, + "204" : { + "description" : "No provisioned ASDC users of requested role" + }, + "400" : { + "description" : "Missing content" + }, + "403" : { + "description" : "Restricted Access" + }, + "500" : { + "description" : "Internal Server Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/User" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns list of users with the specified roles, or all of users in the case of empty 'roles' header", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/user/{userId}" : { + "delete" : { + "description" : "delete user", + "operationId" : "deActivateUser", + "parameters" : [ { + "description" : "userId of user to get", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Update deleted OK" + }, + "400" : { + "description" : "Invalid Content." + }, + "403" : { + "description" : "Missing information" + }, + "404" : { + "description" : "User not found" + }, + "405" : { + "description" : "Method Not Allowed" + }, + "409" : { + "description" : "Restricted operation" + }, + "500" : { + "description" : "Internal Server Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/User" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Delete user", + "tags" : [ "SDCE-2 APIs" ] + }, + "get" : { + "description" : "retrieve user details", + "operationId" : "get", + "parameters" : [ { + "description" : "userId of user to get", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Returns user Ok" + }, + "404" : { + "description" : "User not found" + }, + "405" : { + "description" : "Method Not Allowed" + }, + "500" : { + "description" : "Internal Server Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/User" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns user details according to userId", + "tags" : [ "SDCE-2 APIs" ] + } + }, + "/v1/user/{userId}/role" : { + "get" : { + "description" : "retrieve user role", + "operationId" : "getRole", + "parameters" : [ { + "description" : "userId of user to get", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Returns user role Ok" + }, + "404" : { + "description" : "User not found" + }, + "405" : { + "description" : "Method Not Allowed" + }, + "500" : { + "description" : "Internal Server Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Returns user role according to userId", + "tags" : [ "SDCE-2 APIs" ] + }, + "post" : { + "description" : "update user role", + "operationId" : "updateUserRole", + "parameters" : [ { + "description" : "userId of user to get", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UserRole" + } + } + }, + "description" : "json describe the update role", + "required" : true + }, + "responses" : { + "200" : { + "description" : "Update user OK" + }, + "400" : { + "description" : "Invalid Content." + }, + "403" : { + "description" : "Missing information/Restricted operation" + }, + "404" : { + "description" : "User not found" + }, + "405" : { + "description" : "Method Not Allowed" + }, + "409" : { + "description" : "User already exists" + }, + "500" : { + "description" : "Internal Server Error" + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/User" + } + } + } + } + } + }, + "servers" : [ { + "url" : "/sdc2/rest", + "variables" : { } + } ], + "summary" : "Update user role", + "tags" : [ "SDCE-2 APIs" ] + } + } + }, + "components" : { + "schemas" : { + "AdditionalInfoParameterInfo" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "key" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "AdditionalInformationDefinition" : { + "type" : "object", + "properties" : { + "creationTime" : { + "type" : "integer", + "format" : "int64" + }, + "empty" : { + "type" : "boolean" + }, + "lastCreatedCounter" : { + "type" : "integer", + "format" : "int32" + }, + "modificationTime" : { + "type" : "integer", + "format" : "int64" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parameters" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AdditionalInfoParameterInfo" + } + }, + "parentUniqueId" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "Annotation" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + } + }, + "type" : { + "type" : "string" + } + } + }, + "ApplicationL1CacheCatalogInfo" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean" + }, + "productsSizeInCache" : { + "type" : "integer", + "format" : "int32" + }, + "resourcesSizeInCache" : { + "type" : "integer", + "format" : "int32" + }, + "servicesSizeInCache" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "ApplicationL1CacheConfig" : { + "type" : "object", + "properties" : { + "datatypes" : { + "$ref" : "#/components/schemas/ApplicationL1CacheInfo" + } + } + }, + "ApplicationL1CacheInfo" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean" + }, + "firstRunDelay" : { + "type" : "integer", + "format" : "int32" + }, + "pollIntervalInSec" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "ApplicationL2CacheConfig" : { + "type" : "object", + "properties" : { + "catalogL1Cache" : { + "$ref" : "#/components/schemas/ApplicationL1CacheCatalogInfo" + }, + "enabled" : { + "type" : "boolean" + }, + "queue" : { + "$ref" : "#/components/schemas/QueueInfo" + } + } + }, + "ArtifactConfiguration" : { + "type" : "object", + "properties" : { + "acceptedTypes" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "categories" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "DEPLOYMENT", "LIFE_CYCLE", "SERVICE_API", "TOSCA", "OTHER" ] + } + }, + "componentTypes" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "RESOURCE", "SERVICE", "RESOURCE_INSTANCE", "SERVICE_INSTANCE" ] + } + }, + "resourceTypes" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string" + } + } + }, + "ArtifactDataDefinition" : { + "type" : "object", + "properties" : { + "apiUrl" : { + "type" : "string" + }, + "artifactChecksum" : { + "type" : "string" + }, + "artifactCreator" : { + "type" : "string" + }, + "artifactDisplayName" : { + "type" : "string" + }, + "artifactGroupType" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "DEPLOYMENT", "LIFE_CYCLE", "SERVICE_API", "TOSCA", "OTHER" ] + }, + "artifactLabel" : { + "type" : "string" + }, + "artifactName" : { + "type" : "string" + }, + "artifactRef" : { + "type" : "string" + }, + "artifactRepository" : { + "type" : "string" + }, + "artifactType" : { + "type" : "string" + }, + "artifactUUID" : { + "type" : "string" + }, + "artifactVersion" : { + "type" : "string" + }, + "creationDate" : { + "type" : "integer", + "format" : "int64" + }, + "creatorFullName" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "duplicated" : { + "type" : "boolean" + }, + "empty" : { + "type" : "boolean" + }, + "esId" : { + "type" : "string" + }, + "generated" : { + "type" : "boolean" + }, + "generatedFromId" : { + "type" : "string" + }, + "heatEnvType" : { + "type" : "boolean" + }, + "heatParameters" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HeatParameterDataDefinition" + } + }, + "heatParamsUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "isFromCsar" : { + "type" : "boolean" + }, + "lastUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "mandatory" : { + "type" : "boolean" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "payloadUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + } + }, + "requiredArtifacts" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "serviceApi" : { + "type" : "boolean" + }, + "timeout" : { + "type" : "integer", + "format" : "int32" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "updaterFullName" : { + "type" : "string" + }, + "userIdCreator" : { + "type" : "string" + }, + "userIdLastUpdater" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ArtifactDefinition" : { + "type" : "object", + "properties" : { + "apiUrl" : { + "type" : "string" + }, + "artifactChecksum" : { + "type" : "string" + }, + "artifactCreator" : { + "type" : "string" + }, + "artifactDisplayName" : { + "type" : "string" + }, + "artifactGroupType" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "DEPLOYMENT", "LIFE_CYCLE", "SERVICE_API", "TOSCA", "OTHER" ] + }, + "artifactLabel" : { + "type" : "string" + }, + "artifactName" : { + "type" : "string" + }, + "artifactRef" : { + "type" : "string" + }, + "artifactRepository" : { + "type" : "string" + }, + "artifactType" : { + "type" : "string" + }, + "artifactUUID" : { + "type" : "string" + }, + "artifactVersion" : { + "type" : "string" + }, + "creationDate" : { + "type" : "integer", + "format" : "int64" + }, + "creatorFullName" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "duplicated" : { + "type" : "boolean" + }, + "empty" : { + "type" : "boolean" + }, + "esId" : { + "type" : "string" + }, + "generated" : { + "type" : "boolean" + }, + "generatedFromId" : { + "type" : "string" + }, + "heatEnvType" : { + "type" : "boolean" + }, + "heatParamUpdated" : { + "type" : "boolean" + }, + "heatParameters" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HeatParameterDataDefinition" + } + }, + "heatParamsUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "isFromCsar" : { + "type" : "boolean" + }, + "lastUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "listHeatParameters" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HeatParameterDefinition" + } + }, + "mandatory" : { + "type" : "boolean" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "payload" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte" + }, + "writeOnly" : true + }, + "payloadData" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte" + } + }, + "payloadUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + } + }, + "requiredArtifacts" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "serviceApi" : { + "type" : "boolean" + }, + "timeout" : { + "type" : "integer", + "format" : "int32" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "updaterFullName" : { + "type" : "string" + }, + "userIdCreator" : { + "type" : "string" + }, + "userIdLastUpdater" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "AttributeDefinition" : { + "type" : "object", + "properties" : { + "attributeId" : { + "type" : "string" + }, + "defaultValue" : { + "type" : "string" + }, + "definition" : { + "type" : "boolean" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "entry_schema" : { + "$ref" : "#/components/schemas/EntrySchema" + }, + "getOutputAttribute" : { + "type" : "boolean" + }, + "getOutputValues" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GetOutputValueDataDefinition" + } + }, + "get_default" : { + "type" : "object" + }, + "instanceUniqueId" : { + "type" : "string" + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "outputId" : { + "type" : "string" + }, + "outputPath" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentUniqueId" : { + "type" : "string" + }, + "schema" : { + "$ref" : "#/components/schemas/SchemaDefinition" + }, + "schemaType" : { + "type" : "string" + }, + "status" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "BasicAuthConfig" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean" + }, + "excludedUrls" : { + "type" : "string" + }, + "userName" : { + "type" : "string" + }, + "userPass" : { + "type" : "string" + } + } + }, + "BeMonitoringConfig" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean" + }, + "isProxy" : { + "type" : "boolean" + }, + "probeIntervalInSeconds" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "CINodeFilterDataDefinition" : { + "type" : "object", + "properties" : { + "capabilities" : { + "$ref" : "#/components/schemas/ListDataDefinitionRequirementNodeFilterCapabilityDataDefinition" + }, + "empty" : { + "type" : "boolean" + }, + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "properties" : { + "$ref" : "#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition" + }, + "tosca_id" : { + "type" : "object" + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "CadiFilterParams" : { + "type" : "object", + "properties" : { + "aafLocateUrl" : { + "type" : "string" + }, + "aaf_env" : { + "type" : "string" + }, + "aaf_id" : { + "type" : "string" + }, + "aaf_password" : { + "type" : "string" + }, + "aaf_url" : { + "type" : "string" + }, + "aft_ENVIRONMENT" : { + "type" : "string" + }, + "aft_LATITUDE" : { + "type" : "string" + }, + "aft_LONGITUDE" : { + "type" : "string" + }, + "cadiX509Issuers" : { + "type" : "string" + }, + "cadi_keyfile" : { + "type" : "string" + }, + "cadi_loglevel" : { + "type" : "string" + }, + "cadi_truststore" : { + "type" : "string" + }, + "cadi_truststore_password" : { + "type" : "string" + }, + "csp_domain" : { + "type" : "string" + }, + "hostname" : { + "type" : "string" + } + } + }, + "CapabilityDataDefinition" : { + "type" : "object", + "properties" : { + "capabilitySources" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "external" : { + "type" : "boolean" + }, + "externalName" : { + "type" : "string" + }, + "leftOccurrences" : { + "type" : "string" + }, + "maxOccurrences" : { + "type" : "string" + }, + "minOccurrences" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "ownerName" : { + "type" : "string" + }, + "ownerType" : { + "type" : "string", + "enum" : [ "GROUP", "COMPONENT_INSTANCE", "RESOURCE" ] + }, + "parentName" : { + "type" : "string" + }, + "path" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "previousName" : { + "type" : "string" + }, + "source" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "validSourceTypes" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "version" : { + "type" : "string" + } + } + }, + "CapabilityDefinition" : { + "type" : "object", + "properties" : { + "capabilitySources" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "external" : { + "type" : "boolean" + }, + "externalName" : { + "type" : "string" + }, + "leftOccurrences" : { + "type" : "string" + }, + "maxOccurrences" : { + "type" : "string" + }, + "minOccurrences" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "ownerName" : { + "type" : "string" + }, + "ownerType" : { + "type" : "string", + "enum" : [ "GROUP", "COMPONENT_INSTANCE", "RESOURCE" ] + }, + "ownerTypeIfEmpty" : { + "type" : "string", + "enum" : [ "GROUP", "COMPONENT_INSTANCE", "RESOURCE" ], + "writeOnly" : true + }, + "parentName" : { + "type" : "string" + }, + "path" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "previousName" : { + "type" : "string" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceProperty" + } + }, + "source" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "validSourceTypes" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "version" : { + "type" : "string" + } + } + }, + "CapabilityRequirementRelationship" : { + "type" : "object", + "properties" : { + "capability" : { + "$ref" : "#/components/schemas/CapabilityDataDefinition" + }, + "operations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OperationUi" + } + }, + "relation" : { + "$ref" : "#/components/schemas/RelationshipInfo" + }, + "requirement" : { + "$ref" : "#/components/schemas/RequirementDataDefinition" + } + } + }, + "CassandrConfig" : { + "type" : "object", + "properties" : { + "authenticate" : { + "type" : "boolean" + }, + "cassandraHosts" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "cassandraPort" : { + "type" : "integer", + "format" : "int32" + }, + "keySpaces" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/KeyspaceConfig" + } + }, + "localDataCenter" : { + "type" : "string" + }, + "maxWaitSeconds" : { + "type" : "integer", + "format" : "int32" + }, + "password" : { + "type" : "string" + }, + "reconnectTimeout" : { + "type" : "integer", + "format" : "int64" + }, + "socketConnectTimeout" : { + "type" : "integer", + "format" : "int32" + }, + "socketReadTimeout" : { + "type" : "integer", + "format" : "int32" + }, + "ssl" : { + "type" : "boolean" + }, + "truststorePassword" : { + "type" : "string" + }, + "truststorePath" : { + "type" : "string" + }, + "username" : { + "type" : "string" + } + } + }, + "CatalogComponent" : { + "type" : "object", + "properties" : { + "categories" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CategoryDefinition" + } + }, + "categoryNormalizedName" : { + "type" : "string" + }, + "componentType" : { + "type" : "string", + "enum" : [ "RESOURCE", "SERVICE", "RESOURCE_INSTANCE", "PRODUCT", "SERVICE_INSTANCE" ] + }, + "description" : { + "type" : "string" + }, + "distributionStatus" : { + "type" : "string" + }, + "icon" : { + "type" : "string" + }, + "invariantUUID" : { + "type" : "string" + }, + "isHighestVersion" : { + "type" : "boolean" + }, + "lastUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "lastUpdaterUserId" : { + "type" : "string" + }, + "lifecycleState" : { + "type" : "string" + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "resourceType" : { + "type" : "string" + }, + "subCategoryNormalizedName" : { + "type" : "string" + }, + "systemName" : { + "type" : "string" + }, + "tags" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "uniqueId" : { + "type" : "string" + }, + "uuid" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "Category" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + } + } + }, + "CategoryBaseTypeConfig" : { + "type" : "object", + "properties" : { + "baseTypes" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "defaultBaseType" : { + "type" : "string" + }, + "required" : { + "type" : "boolean" + } + } + }, + "CategoryDefinition" : { + "type" : "object", + "properties" : { + "displayName" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "icons" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "metadataKeys" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MetadataKeyDataDefinition" + } + }, + "models" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "name" : { + "type" : "string" + }, + "normalizedName" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "subcategories" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubCategoryDefinition" + } + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "useServiceSubstitutionForNestedServices" : { + "type" : "boolean" + }, + "version" : { + "type" : "string" + } + } + }, + "CleanComponentsConfiguration" : { + "type" : "object", + "properties" : { + "cleanIntervalInMinutes" : { + "type" : "integer", + "format" : "int64" + }, + "componentsToClean" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "ComponentInstance" : { + "type" : "object", + "properties" : { + "actualComponentUid" : { + "type" : "string" + }, + "artifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + }, + "attributeValueCounter" : { + "type" : "integer", + "format" : "int32" + }, + "attributes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AttributeDefinition" + } + }, + "capabilities" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CapabilityDefinition" + } + } + }, + "componentMetadataForSupportLog" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "componentName" : { + "type" : "string" + }, + "componentUid" : { + "type" : "string" + }, + "componentVersion" : { + "type" : "string" + }, + "createdFrom" : { + "type" : "string", + "enum" : [ "UI", "CSAR" ] + }, + "createdFromCsar" : { + "type" : "boolean" + }, + "creationTime" : { + "type" : "integer", + "format" : "int64" + }, + "customizationUUID" : { + "type" : "string" + }, + "deploymentArtifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + }, + "description" : { + "type" : "string" + }, + "directives" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "empty" : { + "type" : "boolean" + }, + "groupInstances" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupInstance" + } + }, + "icon" : { + "type" : "string" + }, + "inputValueCounter" : { + "type" : "integer", + "format" : "int32" + }, + "inputs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/InputDefinition" + } + }, + "instanceCount" : { + "type" : "string" + }, + "interfaces" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "invariantName" : { + "type" : "string" + }, + "isProxy" : { + "type" : "boolean" + }, + "maxOccurrences" : { + "type" : "string" + }, + "minOccurrences" : { + "type" : "string" + }, + "modificationTime" : { + "type" : "integer", + "format" : "int64" + }, + "name" : { + "type" : "string" + }, + "nodeFilter" : { + "$ref" : "#/components/schemas/CINodeFilterDataDefinition" + }, + "normalizedName" : { + "type" : "string" + }, + "originArchived" : { + "type" : "boolean" + }, + "originType" : { + "type" : "string", + "enum" : [ "PRODUCT", "SERVICE", "VF", "VFC", "CP", "VL", "Configuration", "VFCMT", "CVFC", "PNF", "CR", "ServiceProxy", "ServiceSubstitution" ] + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "posX" : { + "type" : "string" + }, + "posY" : { + "type" : "string" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDefinition" + } + }, + "propertyValueCounter" : { + "type" : "integer", + "format" : "int32" + }, + "requirements" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementDefinition" + } + } + }, + "serviceSubstitution" : { + "type" : "boolean" + }, + "sourceModelInvariant" : { + "type" : "string" + }, + "sourceModelName" : { + "type" : "string" + }, + "sourceModelUid" : { + "type" : "string" + }, + "sourceModelUuid" : { + "type" : "string" + }, + "toscaArtifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ToscaArtifactDataDefinition" + } + }, + "toscaComponentName" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ComponentInstanceAttribute" : { + "type" : "object", + "properties" : { + "attributeId" : { + "type" : "string" + }, + "componentInstanceId" : { + "type" : "string" + }, + "componentInstanceName" : { + "type" : "string" + }, + "defaultValue" : { + "type" : "string" + }, + "definition" : { + "type" : "boolean" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "entry_schema" : { + "$ref" : "#/components/schemas/EntrySchema" + }, + "getOutputAttribute" : { + "type" : "boolean" + }, + "getOutputValues" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GetOutputValueDataDefinition" + } + }, + "get_default" : { + "type" : "object" + }, + "instanceUniqueId" : { + "type" : "string" + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "outputId" : { + "type" : "string" + }, + "outputPath" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentUniqueId" : { + "type" : "string" + }, + "path" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "rules" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyRule" + } + }, + "schema" : { + "$ref" : "#/components/schemas/SchemaDefinition" + }, + "schemaType" : { + "type" : "string" + }, + "status" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "value" : { + "type" : "string" + }, + "valueUniqueUid" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "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" : { + "annotations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Annotation" + } + }, + "annotationsToInput" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Annotation" + }, + "writeOnly" : true + }, + "componentInstanceId" : { + "type" : "string" + }, + "componentInstanceName" : { + "type" : "string" + }, + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyConstraint" + } + }, + "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" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "path" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceProperty" + } + }, + "propertyConstraints" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "propertyId" : { + "type" : "string" + }, + "required" : { + "type" : "boolean" + }, + "rules" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyRule" + } + }, + "schema" : { + "$ref" : "#/components/schemas/SchemaDefinition" + }, + "schemaProperty" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + }, + "schemaType" : { + "type" : "string" + }, + "status" : { + "type" : "string" + }, + "subPropertyInputPath" : { + "type" : "string" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "valueUniqueUid" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ComponentInstanceInterface" : { + "type" : "object", + "properties" : { + "creationDate" : { + "type" : "integer", + "format" : "int64" + }, + "definition" : { + "type" : "boolean" + }, + "derivedFrom" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "inputs" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/InputDataDefinition" + } + }, + "interfaceId" : { + "type" : "string" + }, + "interfaceInstanceDataDefinition" : { + "$ref" : "#/components/schemas/InterfaceInstanceDataDefinition" + }, + "lastUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "model" : { + "type" : "string" + }, + "operations" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/OperationDataDefinition" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "toscaResourceName" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "version" : { + "type" : "string" + } + } + }, + "ComponentInstanceOutput" : { + "type" : "object", + "properties" : { + "attribute" : { + "$ref" : "#/components/schemas/ComponentInstanceAttribute" + }, + "attributeId" : { + "type" : "string" + }, + "componentInstanceId" : { + "type" : "string" + }, + "componentInstanceName" : { + "type" : "string" + }, + "defaultValue" : { + "type" : "string" + }, + "definition" : { + "type" : "boolean" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "entry_schema" : { + "$ref" : "#/components/schemas/EntrySchema" + }, + "getOutputAttribute" : { + "type" : "boolean" + }, + "getOutputValues" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GetOutputValueDataDefinition" + } + }, + "get_default" : { + "type" : "object" + }, + "instanceUniqueId" : { + "type" : "string" + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "outputId" : { + "type" : "string" + }, + "outputPath" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentUniqueId" : { + "type" : "string" + }, + "path" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "rules" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyRule" + } + }, + "schema" : { + "$ref" : "#/components/schemas/SchemaDefinition" + }, + "schemaType" : { + "type" : "string" + }, + "status" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "value" : { + "type" : "string" + }, + "valueUniqueUid" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ComponentInstanceProperty" : { + "type" : "object", + "properties" : { + "annotations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Annotation" + } + }, + "componentInstanceId" : { + "type" : "string" + }, + "componentInstanceName" : { + "type" : "string" + }, + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyConstraint" + } + }, + "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" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "path" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "propertyConstraints" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "propertyId" : { + "type" : "string" + }, + "required" : { + "type" : "boolean" + }, + "rules" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyRule" + } + }, + "schema" : { + "$ref" : "#/components/schemas/SchemaDefinition" + }, + "schemaProperty" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + }, + "schemaType" : { + "type" : "string" + }, + "status" : { + "type" : "string" + }, + "subPropertyInputPath" : { + "type" : "string" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "valueUniqueUid" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "Configuration" : { + "type" : "object", + "properties" : { + "aafAuthNeeded" : { + "type" : "boolean" + }, + "aafNamespace" : { + "type" : "string" + }, + "additionalInformationMaxNumberOfKeys" : { + "type" : "integer", + "format" : "int32" + }, + "appVersion" : { + "type" : "string" + }, + "applicationL1Cache" : { + "$ref" : "#/components/schemas/ApplicationL1CacheConfig" + }, + "applicationL2Cache" : { + "$ref" : "#/components/schemas/ApplicationL2CacheConfig" + }, + "artifactGeneratorConfig" : { + "type" : "string" + }, + "artifacts" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ArtifactConfiguration" + } + }, + "artifactsIndex" : { + "type" : "string" + }, + "authCookie" : { + "$ref" : "#/components/schemas/CookieConfig" + }, + "autoHealingOwner" : { + "type" : "string" + }, + "basicAuth" : { + "$ref" : "#/components/schemas/BasicAuthConfig" + }, + "beContext" : { + "type" : "string" + }, + "beFqdn" : { + "type" : "string" + }, + "beHttpPort" : { + "type" : "integer", + "format" : "int32" + }, + "beProtocol" : { + "type" : "string" + }, + "beSslPort" : { + "type" : "integer", + "format" : "int32" + }, + "cadiFilterParams" : { + "$ref" : "#/components/schemas/CadiFilterParams" + }, + "cassandraConfig" : { + "$ref" : "#/components/schemas/CassandrConfig" + }, + "cleanComponentsConfiguration" : { + "$ref" : "#/components/schemas/CleanComponentsConfiguration" + }, + "componentAllowedInstanceTypes" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "componentInstanceCounterDelimiter" : { + "type" : "string" + }, + "consumerBusinessLogic" : { + "type" : "boolean" + }, + "csarFormat" : { + "$ref" : "#/components/schemas/CsarFormat" + }, + "dataValidatorFilterExcludedUrls" : { + "type" : "string" + }, + "defaultImports" : { + "type" : "array", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "definedResourceNamespace" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "deleteLockTimeoutInSeconds" : { + "type" : "integer", + "format" : "int32" + }, + "deploymentResourceArtifacts" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "deploymentResourceInstanceArtifacts" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "directives" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "disableAudit" : { + "type" : "boolean" + }, + "dmaapConsumerConfiguration" : { + "$ref" : "#/components/schemas/DmaapConsumerConfiguration" + }, + "dmaapProducerConfiguration" : { + "$ref" : "#/components/schemas/DmaapProducerConfiguration" + }, + "dmeConfiguration" : { + "$ref" : "#/components/schemas/DmeConfiguration" + }, + "ecompPortal" : { + "$ref" : "#/components/schemas/EcompPortalConfig" + }, + "enableAutoHealing" : { + "type" : "boolean" + }, + "environmentContext" : { + "$ref" : "#/components/schemas/EnvironmentContext" + }, + "excludeResourceCategory" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "excludeResourceType" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "excludeServiceCategory" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "excludedGroupTypesMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + }, + "excludedPolicyTypesMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + }, + "externalCsarStore" : { + "$ref" : "#/components/schemas/ExternalCsarStore" + }, + "gabConfig" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GabConfig" + } + }, + "genericAssetNodeTypes" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "globalCsarImports" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "healthStatusExclude" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "heatArtifactDeploymentTimeout" : { + "$ref" : "#/components/schemas/HeatDeploymentArtifactTimeout" + }, + "heatEnvArtifactFooter" : { + "type" : "string" + }, + "heatEnvArtifactHeader" : { + "type" : "string" + }, + "heatTranslatorPath" : { + "type" : "string" + }, + "identificationHeaderFields" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "informationalResourceArtifacts" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "informationalServiceArtifacts" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "janusGraphCfgFile" : { + "type" : "string" + }, + "janusGraphHealthCheckReadTimeout" : { + "type" : "integer", + "format" : "int64" + }, + "janusGraphInMemoryGraph" : { + "type" : "boolean" + }, + "janusGraphLockTimeout" : { + "type" : "integer", + "format" : "int64" + }, + "janusGraphMigrationKeySpaceCfgFile" : { + "type" : "string" + }, + "janusGraphReconnectIntervalInSeconds" : { + "type" : "integer", + "format" : "int64" + }, + "licenseTypes" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "maxDeleteComponents" : { + "type" : "integer", + "format" : "int32" + }, + "minToscaConformanceLevel" : { + "type" : "string" + }, + "neo4j" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "onboarding" : { + "$ref" : "#/components/schemas/OnboardingConfig" + }, + "permittedAncestors" : { + "type" : "string" + }, + "protocols" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "released" : { + "type" : "string", + "format" : "date-time" + }, + "resourceNodeTypes" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + } + }, + "resourceTypes" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "resourcesForUpgrade" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, + "serviceApiArtifacts" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "serviceBaseNodeTypes" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/CategoryBaseTypeConfig" + } + }, + "skipUpgradeFailedVfs" : { + "type" : "boolean" + }, + "skipUpgradeVSPs" : { + "type" : "boolean" + }, + "startMigrationFrom" : { + "type" : "integer", + "format" : "int32" + }, + "supportAllottedResourcesAndProxy" : { + "type" : "boolean" + }, + "switchoverDetector" : { + "$ref" : "#/components/schemas/SwitchoverDetectorConfig" + }, + "systemMonitoring" : { + "$ref" : "#/components/schemas/BeMonitoringConfig" + }, + "toscaArtifacts" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "toscaConformanceLevel" : { + "type" : "string" + }, + "toscaFilesDir" : { + "type" : "string" + }, + "toscaValidators" : { + "$ref" : "#/components/schemas/ToscaValidatorsConfig" + }, + "uebHealthCheckReadTimeout" : { + "type" : "integer", + "format" : "int64" + }, + "uebHealthCheckReconnectIntervalInSeconds" : { + "type" : "integer", + "format" : "int64" + }, + "unLoggedUrls" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "users" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "version" : { + "type" : "string" + }, + "vfModuleProperties" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/VfModuleProperty" + } + }, + "workloadContext" : { + "type" : "string" + } + } + }, + "Constraint" : { + "type" : "object", + "properties" : { + "equal" : { + "type" : "object" + }, + "greater_or_equal" : { + "type" : "object" + }, + "greater_than" : { + "type" : "object" + }, + "in_range" : { + "type" : "array", + "items" : { + "type" : "object" + } + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "less_or_equal" : { + "type" : "object" + }, + "less_than" : { + "type" : "object" + }, + "max_length" : { + "type" : "integer", + "format" : "int32" + }, + "min_length" : { + "type" : "integer", + "format" : "int32" + }, + "pattern" : { + "type" : "object" + }, + "valid_values" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + } + }, + "ConsumerDefinition" : { + "type" : "object", + "properties" : { + "consumerDetailsLastupdatedtime" : { + "type" : "integer", + "format" : "int64" + }, + "consumerLastAuthenticationTime" : { + "type" : "integer", + "format" : "int64" + }, + "consumerName" : { + "type" : "string" + }, + "consumerPassword" : { + "type" : "string" + }, + "consumerSalt" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "lastModfierAtuid" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "CookieConfig" : { + "type" : "object", + "properties" : { + "cookieName" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "excludedUrls" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "httpOnly" : { + "type" : "boolean" + }, + "isHttpOnly" : { + "type" : "boolean", + "writeOnly" : true + }, + "maxSessionTimeOut" : { + "type" : "integer", + "format" : "int64" + }, + "onboardingExcludedUrls" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "path" : { + "type" : "string" + }, + "redirectURL" : { + "type" : "string" + }, + "securityKey" : { + "type" : "string" + }, + "sessionIdleTimeOut" : { + "type" : "integer", + "format" : "int64" + } + } + }, + "Credential" : { + "type" : "object", + "properties" : { + "password" : { + "type" : "string" + }, + "username" : { + "type" : "string" + } + } + }, + "Credentials" : { + "type" : "object", + "properties" : { + "accessKey" : { + "type" : "string" + }, + "secretKey" : { + "type" : "string" + } + } + }, + "CsarFormat" : { + "type" : "object", + "properties" : { + "defaultFormat" : { + "type" : "string" + } + } + }, + "DataTypeDataDefinition" : { + "type" : "object", + "properties" : { + "creationTime" : { + "type" : "integer", + "format" : "int64" + }, + "derivedFromName" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "model" : { + "type" : "string" + }, + "modificationTime" : { + "type" : "integer", + "format" : "int64" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "propertiesData" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + } + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "DataTypeDefinition" : { + "type" : "object", + "properties" : { + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyConstraint" + } + }, + "creationTime" : { + "type" : "integer", + "format" : "int64" + }, + "derivedFrom" : { + "$ref" : "#/components/schemas/DataTypeDefinition" + }, + "derivedFromName" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "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" + } + }, + "propertiesData" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + } + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "DistributionStatusInfo" : { + "type" : "object", + "properties" : { + "errorReason" : { + "type" : "string" + }, + "omfComponentID" : { + "type" : "string" + }, + "status" : { + "type" : "string" + }, + "timestamp" : { + "type" : "string" + }, + "url" : { + "type" : "string" + } + } + }, + "DistributionStatusListResponse" : { + "type" : "object", + "properties" : { + "distributionStatusList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DistributionStatusInfo" + } + } + } + }, + "DmaapConsumerConfiguration" : { + "type" : "object", + "properties" : { + "active" : { + "type" : "boolean" + }, + "aftDme2ClientIgnoreSslConfig" : { + "type" : "boolean" + }, + "aftDme2ClientKeystore" : { + "type" : "string" + }, + "aftDme2ClientKeystorePassword" : { + "type" : "string" + }, + "aftDme2ClientSslCertAlias" : { + "type" : "string" + }, + "aftDme2ConnectionTimeoutMs" : { + "type" : "integer", + "format" : "int32" + }, + "aftDme2ReadTimeoutMs" : { + "type" : "integer", + "format" : "int32" + }, + "aftDme2RoundtripTimeoutMs" : { + "type" : "integer", + "format" : "int32" + }, + "aftDme2SslEnable" : { + "type" : "boolean" + }, + "aftEnvironment" : { + "type" : "string" + }, + "consumerGroup" : { + "type" : "string" + }, + "consumerId" : { + "type" : "string" + }, + "contenttype" : { + "type" : "string" + }, + "credential" : { + "$ref" : "#/components/schemas/Credential" + }, + "dme2TraceOn" : { + "type" : "boolean" + }, + "dme2preferredRouterFilePath" : { + "type" : "string" + }, + "environment" : { + "type" : "string" + }, + "hosts" : { + "type" : "string" + }, + "latitude" : { + "type" : "number", + "format" : "double" + }, + "limit" : { + "type" : "integer", + "format" : "int32" + }, + "longitude" : { + "type" : "number", + "format" : "double" + }, + "partner" : { + "type" : "string" + }, + "pollingInterval" : { + "type" : "integer", + "format" : "int32" + }, + "protocol" : { + "type" : "string" + }, + "routeOffer" : { + "type" : "string" + }, + "serviceName" : { + "type" : "string" + }, + "timeLimitForNotificationHandleMs" : { + "type" : "integer", + "format" : "int32" + }, + "timeoutMs" : { + "type" : "integer", + "format" : "int32" + }, + "topic" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "DmaapProducerConfiguration" : { + "type" : "object", + "properties" : { + "active" : { + "type" : "boolean" + }, + "aftDme2ClientIgnoreSslConfig" : { + "type" : "boolean" + }, + "aftDme2ClientKeystore" : { + "type" : "string" + }, + "aftDme2ClientKeystorePassword" : { + "type" : "string" + }, + "aftDme2ClientSslCertAlias" : { + "type" : "string" + }, + "aftDme2ConnectionTimeoutMs" : { + "type" : "integer", + "format" : "int32" + }, + "aftDme2ReadTimeoutMs" : { + "type" : "integer", + "format" : "int32" + }, + "aftDme2RoundtripTimeoutMs" : { + "type" : "integer", + "format" : "int32" + }, + "aftDme2SslEnable" : { + "type" : "boolean" + }, + "aftEnvironment" : { + "type" : "string" + }, + "consumerGroup" : { + "type" : "string" + }, + "consumerId" : { + "type" : "string" + }, + "contenttype" : { + "type" : "string" + }, + "credential" : { + "$ref" : "#/components/schemas/Credential" + }, + "dme2TraceOn" : { + "type" : "boolean" + }, + "dme2preferredRouterFilePath" : { + "type" : "string" + }, + "environment" : { + "type" : "string" + }, + "hosts" : { + "type" : "string" + }, + "latitude" : { + "type" : "number", + "format" : "double" + }, + "limit" : { + "type" : "integer", + "format" : "int32" + }, + "longitude" : { + "type" : "number", + "format" : "double" + }, + "partner" : { + "type" : "string" + }, + "pollingInterval" : { + "type" : "integer", + "format" : "int32" + }, + "protocol" : { + "type" : "string" + }, + "routeOffer" : { + "type" : "string" + }, + "serviceName" : { + "type" : "string" + }, + "timeLimitForNotificationHandleMs" : { + "type" : "integer", + "format" : "int32" + }, + "timeoutMs" : { + "type" : "integer", + "format" : "int32" + }, + "topic" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "DmeConfiguration" : { + "type" : "object", + "properties" : { + "lookupUriFormat" : { + "type" : "string" + } + } + }, + "EcompPortalConfig" : { + "type" : "object", + "properties" : { + "defaultFunctionalMenu" : { + "type" : "string" + }, + "healthCheckUri" : { + "type" : "string" + }, + "host" : { + "type" : "string" + }, + "pollingInterval" : { + "type" : "integer", + "format" : "int32" + }, + "port" : { + "type" : "integer", + "format" : "int32" + }, + "protocol" : { + "type" : "string" + }, + "timeoutMs" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "Endpoint" : { + "type" : "object", + "properties" : { + "host" : { + "type" : "string" + }, + "port" : { + "type" : "integer", + "format" : "int32" + }, + "secure" : { + "type" : "boolean" + } + } + }, + "EntrySchema" : { + "type" : "object", + "properties" : { + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Constraint" + } + }, + "description" : { + "type" : "string" + }, + "type" : { + "type" : "string" + } + } + }, + "EnvironmentContext" : { + "type" : "object", + "properties" : { + "defaultValue" : { + "type" : "string" + }, + "validValues" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "ExternalCsarStore" : { + "type" : "object", + "properties" : { + "credentials" : { + "$ref" : "#/components/schemas/Credentials" + }, + "endpoint" : { + "$ref" : "#/components/schemas/Endpoint" + }, + "storageType" : { + "type" : "string" + }, + "tempPath" : { + "type" : "string" + }, + "uploadPartSize" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "FormDataContentDisposition" : { + "type" : "object", + "properties" : { + "creationDate" : { + "type" : "string", + "format" : "date-time" + }, + "fileName" : { + "type" : "string" + }, + "modificationDate" : { + "type" : "string", + "format" : "date-time" + }, + "name" : { + "type" : "string" + }, + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "readDate" : { + "type" : "string", + "format" : "date-time" + }, + "size" : { + "type" : "integer", + "format" : "int64" + }, + "type" : { + "type" : "string" + } + } + }, + "ForwardingPathDataDefinition" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string" + }, + "destinationPortNumber" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "pathElements" : { + "$ref" : "#/components/schemas/ListDataDefinitionForwardingPathElementDataDefinition" + }, + "protocol" : { + "type" : "string" + }, + "toscaResourceName" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ForwardingPathElementDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "fromCP" : { + "type" : "string" + }, + "fromCPOriginId" : { + "type" : "string" + }, + "fromNode" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "toCP" : { + "type" : "string" + }, + "toCPOriginId" : { + "type" : "string" + }, + "toNode" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "GabConfig" : { + "type" : "object", + "properties" : { + "artifactType" : { + "type" : "string" + }, + "pathsAndNamesDefinitions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PathsAndNamesDefinition" + } + } + } + }, + "GenericArtifactQueryInfo" : { + "type" : "object", + "properties" : { + "artifactUniqueId" : { + "type" : "string" + }, + "fields" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "parentId" : { + "type" : "string" + } + } + }, + "GetInputValueDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "getInputIndex" : { + "$ref" : "#/components/schemas/GetInputValueDataDefinition" + }, + "indexValue" : { + "type" : "integer", + "format" : "int32" + }, + "inputId" : { + "type" : "string" + }, + "inputName" : { + "type" : "string" + }, + "inputType" : { + "type" : "string" + }, + "list" : { + "type" : "boolean" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "propName" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "GetOutputValueDataDefinition" : { + "type" : "object", + "properties" : { + "attribName" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "getOutputIndex" : { + "$ref" : "#/components/schemas/GetOutputValueDataDefinition" + }, + "indexValue" : { + "type" : "integer", + "format" : "int32" + }, + "list" : { + "type" : "boolean" + }, + "outputId" : { + "type" : "string" + }, + "outputName" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "GetPolicyValueDataDefinition" : { + "type" : "object", + "properties" : { + "origPropertyValue" : { + "type" : "string" + }, + "policyId" : { + "type" : "string" + }, + "propertyName" : { + "type" : "string" + } + } + }, + "GroupDefinition" : { + "type" : "object", + "properties" : { + "artifacts" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "artifactsUuid" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "capabilities" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CapabilityDefinition" + } + } + }, + "createdFrom" : { + "type" : "string", + "enum" : [ "UI", "CSAR" ] + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "groupUUID" : { + "type" : "string" + }, + "invariantName" : { + "type" : "string" + }, + "invariantUUID" : { + "type" : "string" + }, + "members" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "name" : { + "type" : "string" + }, + "normalizedName" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + } + }, + "propertyValueCounter" : { + "type" : "integer", + "format" : "int32" + }, + "type" : { + "type" : "string" + }, + "typeUid" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userDefined" : { + "type" : "boolean" + }, + "version" : { + "type" : "string" + }, + "vspOriginated" : { + "type" : "boolean" + } + } + }, + "GroupInfo" : { + "type" : "object", + "properties" : { + "changePriorityBody" : { + "type" : "string" + }, + "changePriorityUrl" : { + "type" : "string" + } + } + }, + "GroupInstance" : { + "type" : "object", + "properties" : { + "artifacts" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "artifactsUuid" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "creationTime" : { + "type" : "integer", + "format" : "int64" + }, + "customizationUUID" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "groupInstanceArtifacts" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "groupInstanceArtifactsUuid" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "groupName" : { + "type" : "string" + }, + "groupUUID" : { + "type" : "string" + }, + "groupUid" : { + "type" : "string" + }, + "invariantUUID" : { + "type" : "string" + }, + "modificationTime" : { + "type" : "integer", + "format" : "int64" + }, + "name" : { + "type" : "string" + }, + "normalizedName" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "posX" : { + "type" : "string" + }, + "posY" : { + "type" : "string" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + } + }, + "propertyValueCounter" : { + "type" : "integer", + "format" : "int32" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "GroupProperty" : { + "type" : "object", + "properties" : { + "annotations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Annotation" + } + }, + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyConstraint" + } + }, + "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" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "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" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "valueUniqueUid" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "GroupTypeDefinition" : { + "type" : "object", + "properties" : { + "capabilities" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/CapabilityDefinition" + } + }, + "creationTime" : { + "type" : "integer", + "format" : "int64" + }, + "derivedFrom" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "highestVersion" : { + "type" : "boolean" + }, + "icon" : { + "type" : "string" + }, + "members" : { + "type" : "array", + "items" : { + "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" + } + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "GroupingDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "normalizedName" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "HeatDeploymentArtifactTimeout" : { + "type" : "object", + "properties" : { + "defaultMinutes" : { + "type" : "integer", + "format" : "int32" + }, + "maxMinutes" : { + "type" : "integer", + "format" : "int32" + }, + "minMinutes" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "HeatParameterDataDefinition" : { + "type" : "object", + "properties" : { + "currentValue" : { + "type" : "string" + }, + "defaultValue" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "HeatParameterDefinition" : { + "type" : "object", + "properties" : { + "currentValue" : { + "type" : "string" + }, + "defaultValue" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "InputDataDefinition" : { + "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" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "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" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "InputDefinition" : { + "type" : "object", + "properties" : { + "annotations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Annotation" + } + }, + "annotationsToInput" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Annotation" + }, + "writeOnly" : true + }, + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyConstraint" + } + }, + "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" + }, + "inputs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceInput" + } + }, + "instanceUniqueId" : { + "type" : "string" + }, + "isDeclaredListInput" : { + "type" : "boolean" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceProperty" + } + }, + "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" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "InterfaceDefinition" : { + "type" : "object", + "properties" : { + "creationDate" : { + "type" : "integer", + "format" : "int64" + }, + "definition" : { + "type" : "boolean" + }, + "derivedFrom" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "inputs" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/InputDataDefinition" + } + }, + "lastUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "model" : { + "type" : "string" + }, + "operations" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/OperationDataDefinition" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "toscaResourceName" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "version" : { + "type" : "string" + } + } + }, + "InterfaceInstanceDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "inputs" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "operations" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/OperationInstance" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "KeyspaceConfig" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "replicationInfo" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "replicationStrategy" : { + "type" : "string" + } + } + }, + "ListDataDefinitionForwardingPathElementDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "listToscaDataDefinition" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ForwardingPathElementDataDefinition" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ListDataDefinitionOperationInputDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "listToscaDataDefinition" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OperationInputDefinition" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ListDataDefinitionOperationOutputDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "listToscaDataDefinition" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OperationOutputDefinition" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ListDataDefinitionPropertyFilterDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "listToscaDataDefinition" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyFilterDataDefinition" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ListDataDefinitionRequirementNodeFilterCapabilityDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "listToscaDataDefinition" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementNodeFilterCapabilityDataDefinition" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ListDataDefinitionRequirementSubstitutionFilterCapabilityDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "listToscaDataDefinition" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementSubstitutionFilterCapabilityDataDefinition" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ListDataDefinitionSubstitutionFilterPropertyDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "listToscaDataDefinition" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubstitutionFilterPropertyDataDefinition" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "MetadataKeyDataDefinition" : { + "type" : "object", + "properties" : { + "defaultValue" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "mandatory" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "validValues" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "version" : { + "type" : "string" + } + } + }, + "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" : [ "modelType", "name" ] + }, + "NameIdPair" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + }, + "properties" : { + "empty" : { + "type" : "boolean" + }, + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + } + } + }, + "NameIdPairWrapper" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + }, + "properties" : { + "data" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + }, + "properties" : { + "empty" : { + "type" : "boolean" + }, + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + } + } + }, + "empty" : { + "type" : "boolean" + }, + "id" : { + "type" : "string" + }, + "nameIdPair" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + }, + "properties" : { + "empty" : { + "type" : "boolean" + }, + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + } + } + } + } + }, + "NodeTypeMetadata" : { + "type" : "object", + "properties" : { + "categories" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CategoryDefinition" + } + }, + "contactId" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "icon" : { + "type" : "string" + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "normative" : { + "type" : "boolean" + }, + "resourceIconPath" : { + "type" : "string" + }, + "resourceType" : { + "type" : "string" + }, + "resourceVendorModelNumber" : { + "type" : "string" + }, + "tags" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "toscaName" : { + "type" : "string" + }, + "vendorName" : { + "type" : "string" + }, + "vendorRelease" : { + "type" : "string" + } + } + }, + "NodeTypesMetadataList" : { + "type" : "object", + "properties" : { + "nodeMetadataList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NodeTypeMetadata" + } + } + } + }, + "OnboardingConfig" : { + "type" : "object", + "properties" : { + "getLatestVspPackageUri" : { + "type" : "string" + }, + "getLatestVspUri" : { + "type" : "string" + }, + "getVspPackageUri" : { + "type" : "string" + }, + "getVspUri" : { + "type" : "string" + }, + "healthCheckUri" : { + "type" : "string" + }, + "host" : { + "type" : "string" + }, + "port" : { + "type" : "integer", + "format" : "int32" + }, + "protocol" : { + "type" : "string" + } + } + }, + "OperationDataDefinition" : { + "type" : "object", + "properties" : { + "creationDate" : { + "type" : "integer", + "format" : "int64" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "implementation" : { + "$ref" : "#/components/schemas/ArtifactDataDefinition" + }, + "inputs" : { + "$ref" : "#/components/schemas/ListDataDefinitionOperationInputDefinition" + }, + "lastUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "name" : { + "type" : "string" + }, + "outputs" : { + "$ref" : "#/components/schemas/ListDataDefinitionOperationOutputDefinition" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + }, + "workflowAssociationType" : { + "type" : "string" + }, + "workflowId" : { + "type" : "string" + }, + "workflowName" : { + "type" : "string" + }, + "workflowVersion" : { + "type" : "string" + }, + "workflowVersionId" : { + "type" : "string" + } + } + }, + "OperationImplementation" : { + "type" : "object", + "properties" : { + "dependencies" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "primary" : { + "type" : "string" + } + } + }, + "OperationInputDefinition" : { + "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" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "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" + }, + "source" : { + "type" : "string" + }, + "sourceProperty" : { + "type" : "string" + }, + "status" : { + "type" : "string" + }, + "subPropertyInputPath" : { + "type" : "string" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "toscaDefaultValue" : { + "type" : "string" + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "OperationInstance" : { + "type" : "object", + "properties" : { + "implementation" : { + "$ref" : "#/components/schemas/OperationImplementation" + }, + "inputs" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + } + } + }, + "OperationOutputDefinition" : { + "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" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "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" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "OperationUi" : { + "type" : "object", + "properties" : { + "implementation" : { + "type" : "object" + }, + "inputs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyAssignmentUi" + } + }, + "interfaceType" : { + "type" : "string" + }, + "operationType" : { + "type" : "string" + } + } + }, + "OutputDefinition" : { + "type" : "object", + "properties" : { + "attribute" : { + "$ref" : "#/components/schemas/ComponentInstanceAttribute" + }, + "attributeId" : { + "type" : "string" + }, + "defaultValue" : { + "type" : "string" + }, + "definition" : { + "type" : "boolean" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "entry_schema" : { + "$ref" : "#/components/schemas/EntrySchema" + }, + "getOutputAttribute" : { + "type" : "boolean" + }, + "getOutputValues" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GetOutputValueDataDefinition" + } + }, + "get_default" : { + "type" : "object" + }, + "instanceUniqueId" : { + "type" : "string" + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "outputId" : { + "type" : "string" + }, + "outputPath" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentUniqueId" : { + "type" : "string" + }, + "schema" : { + "$ref" : "#/components/schemas/SchemaDefinition" + }, + "schemaType" : { + "type" : "string" + }, + "status" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "PathsAndNamesDefinition" : { + "type" : "object", + "properties" : { + "friendlyName" : { + "type" : "string" + }, + "path" : { + "type" : "string" + }, + "searchable" : { + "type" : "boolean" + } + } + }, + "PolicyDefinition" : { + "type" : "object", + "properties" : { + "annotations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Annotation" + } + }, + "componentName" : { + "type" : "string" + }, + "defaultValue" : { + "type" : "string" + }, + "definition" : { + "type" : "boolean" + }, + "derivedFrom" : { + "type" : "string" + }, + "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" + }, + "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" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "targets" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "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" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "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" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "PropertyDefinition" : { + "type" : "object", + "properties" : { + "annotations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Annotation" + } + }, + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyConstraint" + } + }, + "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" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "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" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "PropertyDefinitionDto" : { + "type" : "object", + "properties" : { + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyConstraint" + } + }, + "defaultValue" : { + "type" : "object" + }, + "description" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "required" : { + "type" : "boolean" + }, + "schemaType" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "value" : { + "type" : "object" + } + } + }, + "PropertyFilterConstraintDataDefinition" : { + "type" : "object", + "properties" : { + "capabilityName" : { + "type" : "string" + }, + "operator" : { + "type" : "string", + "enum" : [ "EQUAL", "IN_RANGE", "GREATER_THAN", "GREATER_OR_EQUAL", "LESS_OR_EQUAL", "LENGTH", "MIN_LENGTH", "MAX_LENGTH", "VALID_VALUES", "LESS_THAN", "PATTERN", "SCHEMA" ] + }, + "propertyName" : { + "type" : "string" + }, + "targetType" : { + "type" : "string", + "enum" : [ "CAPABILITY", "PROPERTY" ] + }, + "value" : { + "type" : "object" + }, + "valueType" : { + "type" : "string", + "enum" : [ "STATIC", "GET_PROPERTY", "GET_INPUT", "GET_ATTRIBUTE", "YAML", "CONCAT" ] + } + } + }, + "PropertyFilterDataDefinition" : { + "type" : "object", + "properties" : { + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyFilterConstraintDataDefinition" + } + }, + "empty" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "PropertyRule" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "rule" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "QueueInfo" : { + "type" : "object", + "properties" : { + "numberOfCacheWorkers" : { + "type" : "integer", + "format" : "int32" + }, + "syncIntervalInSecondes" : { + "type" : "integer", + "format" : "int32" + }, + "waitOnShutDownInMinutes" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "RelationshipImpl" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string" + } + } + }, + "RelationshipInfo" : { + "type" : "object", + "properties" : { + "capability" : { + "type" : "string" + }, + "capabilityOwnerId" : { + "type" : "string" + }, + "capabilityUid" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "relationship" : { + "$ref" : "#/components/schemas/RelationshipImpl" + }, + "relationships" : { + "$ref" : "#/components/schemas/RelationshipImpl" + }, + "requirement" : { + "type" : "string" + }, + "requirementOwnerId" : { + "type" : "string" + }, + "requirementUid" : { + "type" : "string" + } + } + }, + "ReplaceVNFInfo" : { + "type" : "object", + "properties" : { + "abstractResourceUniqueId" : { + "type" : "string" + }, + "realVNFComponentInstance" : { + "$ref" : "#/components/schemas/ComponentInstance" + }, + "serviceUniqueId" : { + "type" : "string" + } + } + }, + "RequirementCapabilityRelDef" : { + "type" : "object", + "properties" : { + "fromNode" : { + "type" : "string" + }, + "originUI" : { + "type" : "boolean" + }, + "relationships" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CapabilityRequirementRelationship" + } + }, + "toNode" : { + "type" : "string" + }, + "uid" : { + "type" : "string" + } + } + }, + "RequirementDataDefinition" : { + "type" : "object", + "properties" : { + "capability" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "external" : { + "type" : "boolean" + }, + "externalName" : { + "type" : "string" + }, + "leftOccurrences" : { + "type" : "string" + }, + "maxOccurrences" : { + "type" : "string" + }, + "minOccurrences" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "node" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "ownerName" : { + "type" : "string" + }, + "parentName" : { + "type" : "string" + }, + "path" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "previousName" : { + "type" : "string" + }, + "relationship" : { + "type" : "string" + }, + "source" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "RequirementDefinition" : { + "type" : "object", + "properties" : { + "capability" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "external" : { + "type" : "boolean" + }, + "externalName" : { + "type" : "string" + }, + "leftOccurrences" : { + "type" : "string" + }, + "maxOccurrences" : { + "type" : "string" + }, + "minOccurrences" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "node" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "ownerName" : { + "type" : "string" + }, + "parentName" : { + "type" : "string" + }, + "path" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "previousName" : { + "type" : "string" + }, + "relationship" : { + "type" : "string" + }, + "source" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "RequirementNodeFilterCapabilityDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "properties" : { + "$ref" : "#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition" + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "RequirementSubstitutionFilterCapabilityDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "properties" : { + "$ref" : "#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition" + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "Resource" : { + "type" : "object", + "properties" : { + "abstract" : { + "type" : "boolean" + }, + "actualComponentType" : { + "type" : "string" + }, + "additionalInformation" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AdditionalInformationDefinition" + } + }, + "allArtifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + }, + "allVersions" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "archiveTime" : { + "type" : "integer", + "format" : "int64" + }, + "archived" : { + "type" : "boolean" + }, + "artifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + }, + "attributes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AttributeDefinition" + } + }, + "capabilities" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CapabilityDefinition" + } + } + }, + "categories" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CategoryDefinition" + } + }, + "categorySpecificMetadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "componentInstances" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstance" + } + }, + "componentInstancesAttributes" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceAttribute" + } + } + }, + "componentInstancesInputs" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceInput" + } + } + }, + "componentInstancesInterfaces" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceInterface" + } + } + }, + "componentInstancesOutputs" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceOutput" + } + } + }, + "componentInstancesProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceProperty" + } + } + }, + "componentInstancesRelations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementCapabilityRelDef" + } + }, + "componentMetadataForSupportLog" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "RESOURCE", "SERVICE", "RESOURCE_INSTANCE", "PRODUCT", "SERVICE_INSTANCE" ] + }, + "conformanceLevel" : { + "type" : "string" + }, + "contactId" : { + "type" : "string" + }, + "cost" : { + "type" : "string" + }, + "creationDate" : { + "type" : "integer", + "format" : "int64" + }, + "creatorFullName" : { + "type" : "string" + }, + "creatorUserId" : { + "type" : "string" + }, + "csarUUID" : { + "type" : "string" + }, + "csarVersion" : { + "type" : "string" + }, + "csarVersionId" : { + "type" : "string" + }, + "dataTypes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataTypeDefinition" + } + }, + "deploymentArtifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + }, + "derivedFrom" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "derivedFromGenericInfo" : { + "$ref" : "#/components/schemas/Resource" + }, + "derivedFromGenericType" : { + "type" : "string" + }, + "derivedFromGenericVersion" : { + "type" : "string" + }, + "derivedFromMapOfIdToName" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "derivedList" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : { + "type" : "string" + }, + "groups" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupDefinition" + } + }, + "highestVersion" : { + "type" : "boolean" + }, + "icon" : { + "type" : "string" + }, + "importedToscaChecksum" : { + "type" : "string" + }, + "inputs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/InputDefinition" + } + }, + "interfaces" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/InterfaceDefinition" + } + }, + "invariantUUID" : { + "type" : "string" + }, + "isDeleted" : { + "type" : "boolean" + }, + "lastUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "lastUpdaterFullName" : { + "type" : "string" + }, + "lastUpdaterUserId" : { + "type" : "string" + }, + "licenseType" : { + "type" : "string" + }, + "lifecycleState" : { + "type" : "string", + "enum" : [ "CERTIFIED", "NOT_CERTIFIED_CHECKIN", "NOT_CERTIFIED_CHECKOUT" ] + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "nodeFilterComponents" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/CINodeFilterDataDefinition" + } + }, + "normalizedName" : { + "type" : "string" + }, + "outputs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OutputDefinition" + } + }, + "policies" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PolicyDefinition" + } + }, + "projectCode" : { + "type" : "string" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDefinition" + } + }, + "requirements" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementDefinition" + } + } + }, + "resourceType" : { + "type" : "string", + "enum" : [ "VFC", "VF", "CR", "CP", "PNF", "CVFC", "VL", "VFCMT", "Configuration", "ServiceProxy", "ABSTRACT", "SERVICE" ] + }, + "resourceVendorModelNumber" : { + "type" : "string" + }, + "service" : { + "type" : "boolean" + }, + "specificComponetTypeArtifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + }, + "writeOnly" : true + }, + "state" : { + "type" : "string", + "enum" : [ "CERTIFIED", "NOT_CERTIFIED_CHECKIN", "NOT_CERTIFIED_CHECKOUT" ], + "writeOnly" : true + }, + "substitutionFilter" : { + "$ref" : "#/components/schemas/SubstitutionFilterDataDefinition" + }, + "systemName" : { + "type" : "string" + }, + "tags" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "topologyTemplate" : { + "type" : "boolean" + }, + "toscaArtifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + }, + "toscaResourceName" : { + "type" : "string" + }, + "toscaType" : { + "type" : "string" + }, + "toscaVersion" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "uuid" : { + "type" : "string" + }, + "vendorName" : { + "type" : "string" + }, + "vendorRelease" : { + "type" : "string" + }, + "version" : { + "type" : "string" + }, + "vspArchived" : { + "type" : "boolean" + } + } + }, + "SchemaDefinition" : { + "type" : "object", + "properties" : { + "constraints" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "derivedFrom" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + } + }, + "property" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "Service" : { + "type" : "object", + "properties" : { + "abstract" : { + "type" : "boolean", + "writeOnly" : true + }, + "actualComponentType" : { + "type" : "string" + }, + "additionalInformation" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AdditionalInformationDefinition" + } + }, + "allArtifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + }, + "allVersions" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "archiveTime" : { + "type" : "integer", + "format" : "int64" + }, + "archived" : { + "type" : "boolean" + }, + "artifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + }, + "attributes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AttributeDefinition" + } + }, + "capabilities" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CapabilityDefinition" + } + } + }, + "categories" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CategoryDefinition" + } + }, + "categorySpecificMetadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "componentInstances" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstance" + } + }, + "componentInstancesAttributes" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceAttribute" + } + } + }, + "componentInstancesInputs" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceInput" + } + } + }, + "componentInstancesInterfaces" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceInterface" + } + } + }, + "componentInstancesOutputs" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceOutput" + } + } + }, + "componentInstancesProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceProperty" + } + } + }, + "componentInstancesRelations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementCapabilityRelDef" + } + }, + "componentMetadataForSupportLog" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "RESOURCE", "SERVICE", "RESOURCE_INSTANCE", "PRODUCT", "SERVICE_INSTANCE" ] + }, + "conformanceLevel" : { + "type" : "string" + }, + "contactId" : { + "type" : "string" + }, + "creationDate" : { + "type" : "integer", + "format" : "int64" + }, + "creatorFullName" : { + "type" : "string" + }, + "creatorUserId" : { + "type" : "string" + }, + "csarUUID" : { + "type" : "string" + }, + "csarVersion" : { + "type" : "string" + }, + "dataTypes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataTypeDefinition" + } + }, + "deploymentArtifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + }, + "derivedFromGenericInfo" : { + "$ref" : "#/components/schemas/Resource" + }, + "derivedFromGenericType" : { + "type" : "string" + }, + "derivedFromGenericVersion" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "distributionStatus" : { + "type" : "string", + "enum" : [ "DISTRIBUTION_NOT_APPROVED", "DISTRIBUTED" ] + }, + "ecompGeneratedNaming" : { + "type" : "boolean" + }, + "environmentContext" : { + "type" : "string" + }, + "forwardingPaths" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ForwardingPathDataDefinition" + } + }, + "groups" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupDefinition" + } + }, + "highestVersion" : { + "type" : "boolean" + }, + "icon" : { + "type" : "string" + }, + "importedToscaChecksum" : { + "type" : "string" + }, + "inputs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/InputDefinition" + } + }, + "instantiationType" : { + "type" : "string" + }, + "interfaces" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/InterfaceDefinition" + } + }, + "invariantUUID" : { + "type" : "string" + }, + "isDeleted" : { + "type" : "boolean" + }, + "lastUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "lastUpdaterFullName" : { + "type" : "string" + }, + "lastUpdaterUserId" : { + "type" : "string" + }, + "lifecycleState" : { + "type" : "string", + "enum" : [ "CERTIFIED", "NOT_CERTIFIED_CHECKIN", "NOT_CERTIFIED_CHECKOUT" ] + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "namingPolicy" : { + "type" : "string" + }, + "nodeFilterComponents" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/CINodeFilterDataDefinition" + } + }, + "normalizedName" : { + "type" : "string" + }, + "outputs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OutputDefinition" + } + }, + "policies" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PolicyDefinition" + } + }, + "projectCode" : { + "type" : "string" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDefinition" + } + }, + "requirements" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementDefinition" + } + } + }, + "service" : { + "type" : "boolean" + }, + "serviceApiArtifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + }, + "serviceFunction" : { + "type" : "string" + }, + "serviceRole" : { + "type" : "string" + }, + "serviceType" : { + "type" : "string" + }, + "serviceVendorModelNumber" : { + "type" : "string", + "writeOnly" : true + }, + "specificComponetTypeArtifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + }, + "writeOnly" : true + }, + "state" : { + "type" : "string", + "enum" : [ "CERTIFIED", "NOT_CERTIFIED_CHECKIN", "NOT_CERTIFIED_CHECKOUT" ], + "writeOnly" : true + }, + "substituteCandidate" : { + "type" : "boolean" + }, + "substitutionFilter" : { + "$ref" : "#/components/schemas/SubstitutionFilterDataDefinition" + }, + "systemName" : { + "type" : "string" + }, + "tags" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "topologyTemplate" : { + "type" : "boolean" + }, + "toscaArtifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + }, + "toscaServiceName" : { + "type" : "string" + }, + "toscaType" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "uuid" : { + "type" : "string" + }, + "vendorName" : { + "type" : "string", + "writeOnly" : true + }, + "vendorRelease" : { + "type" : "string", + "writeOnly" : true + }, + "version" : { + "type" : "string" + }, + "vspArchived" : { + "type" : "boolean" + } + } + }, + "ServiceRelations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NameIdPairWrapper" + }, + "properties" : { + "empty" : { + "type" : "boolean" + }, + "relations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NameIdPairWrapper" + }, + "uniqueItems" : true + } + } + }, + "SubCategoryDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "groupings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupingDefinition" + } + }, + "icons" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "metadataKeys" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MetadataKeyDataDefinition" + } + }, + "name" : { + "type" : "string" + }, + "normalizedName" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "SubPropertyToscaFunction" : { + "type" : "object", + "properties" : { + "subPropertyPath" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + } + } + }, + "SubstitutionFilterDataDefinition" : { + "type" : "object", + "properties" : { + "capabilities" : { + "$ref" : "#/components/schemas/ListDataDefinitionRequirementSubstitutionFilterCapabilityDataDefinition" + }, + "empty" : { + "type" : "boolean" + }, + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "properties" : { + "$ref" : "#/components/schemas/ListDataDefinitionSubstitutionFilterPropertyDataDefinition" + }, + "tosca_id" : { + "type" : "object" + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "SubstitutionFilterPropertyDataDefinition" : { + "type" : "object", + "properties" : { + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyFilterConstraintDataDefinition" + } + }, + "empty" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "SwitchoverDetectorConfig" : { + "type" : "object", + "properties" : { + "beResolveAttempts" : { + "type" : "integer", + "format" : "int32" + }, + "beVip" : { + "type" : "string" + }, + "changePriorityPassword" : { + "type" : "string" + }, + "changePriorityUser" : { + "type" : "string" + }, + "enabled" : { + "type" : "boolean" + }, + "feResolveAttempts" : { + "type" : "integer", + "format" : "int32" + }, + "feVip" : { + "type" : "string" + }, + "getgBeFqdn" : { + "type" : "string" + }, + "getgFeFqdn" : { + "type" : "string" + }, + "groups" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/GroupInfo" + } + }, + "interval" : { + "type" : "integer", + "format" : "int64" + }, + "publishNetworkBody" : { + "type" : "string" + }, + "publishNetworkUrl" : { + "type" : "string" + } + } + }, + "ToscaArtifactDataDefinition" : { + "type" : "object", + "properties" : { + "file" : { + "type" : "string" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "type" : { + "type" : "string" + } + } + }, + "ToscaFunction" : { + "type" : "object", + "properties" : { + "jsonObjectValue" : { + "type" : "object" + }, + "type" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE", "CONCAT", "YAML", "STRING" ] + }, + "value" : { + "type" : "string" + } + } + }, + "ToscaGetFunctionDataDefinition" : { + "type" : "object", + "properties" : { + "functionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "propertyName" : { + "type" : "string" + }, + "propertyPathFromSource" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "propertySource" : { + "type" : "string", + "enum" : [ "SELF", "INSTANCE" ] + }, + "propertyUniqueId" : { + "type" : "string" + }, + "sourceName" : { + "type" : "string" + }, + "sourceUniqueId" : { + "type" : "string" + }, + "type" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE", "CONCAT", "YAML", "STRING" ] + } + } + }, + "ToscaValidatorsConfig" : { + "type" : "object", + "properties" : { + "stringMaxLength" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "UIConstraint" : { + "type" : "object", + "properties" : { + "capabilityName" : { + "type" : "string" + }, + "constraintOperator" : { + "type" : "string" + }, + "servicePropertyName" : { + "type" : "string" + }, + "sourceName" : { + "type" : "string" + }, + "sourceType" : { + "type" : "string" + }, + "value" : { + "type" : "object" + } + } + }, + "User" : { + "type" : "object", + "properties" : { + "email" : { + "type" : "string" + }, + "firstName" : { + "type" : "string" + }, + "fullName" : { + "type" : "string" + }, + "lastLoginTime" : { + "type" : "integer", + "format" : "int64" + }, + "lastName" : { + "type" : "string" + }, + "role" : { + "type" : "string" + }, + "status" : { + "type" : "string", + "enum" : [ "ACTIVE", "INACTIVE" ] + }, + "userId" : { + "type" : "string" + } + } + }, + "UserRole" : { + "type" : "object", + "properties" : { + "role" : { + "type" : "string", + "enum" : [ "ADMIN", "TESTER", "DESIGNER", "PRODUCT_MANAGER", "PRODUCT_STRATEGIST" ] + } + } + }, + "VfModuleProperty" : { + "type" : "object", + "properties" : { + "forBaseModule" : { + "type" : "string" + }, + "forNonBaseModule" : { + "type" : "string" + } + } + } + } + } +}
\ No newline at end of file diff --git a/docs/openapi/openapi-sdce-2-sdce-5.yaml b/docs/openapi/openapi-sdce-2-sdce-5.yaml new file mode 100644 index 0000000000..84427af781 --- /dev/null +++ b/docs/openapi/openapi-sdce-2-sdce-5.yaml @@ -0,0 +1,38830 @@ +openapi: 3.0.1 +info: + contact: + email: onap-discuss@lists.onap.org + name: ONAP + url: https://onap.readthedocs.io + description: SDC API for designing services and resources (SDCE-2) and distributing + services (SDCE-5) + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0 + title: "SPC API: SDCE-2 and SDCE-5" + version: "1.0" +servers: +- description: SDCE-2 and SDCE-5 APIs + url: /sdc +paths: + /actuator/prometheus: + get: + description: Gets the prometheus micrometer application metrics + operationId: prometheus + parameters: + - description: The Accept header to determine the output content type + in: header + name: Accept + schema: + type: string + responses: + default: + content: + '*/*': + schema: + type: string + description: default response + servers: + - url: /sdc2/rest + variables: {} + summary: Prometheus Micrometer Metrics + tags: + - SDCE-2 APIs + /config/get: + get: + description: Retrieve configuration + operationId: getConfig_1 + responses: + "200": + content: + application/json: + schema: + type: string + description: OK + servers: + - url: /sdc2/rest + variables: {} + tags: + - SDCE-2 APIs + /configmgr/get: + get: + operationId: getConfig + parameters: + - in: query + name: type + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: string + description: default response + servers: + - url: /sdc2/rest + variables: {} + tags: + - SDCE-2 APIs + /configmgr/set1: + post: + operationId: setConfig1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Configuration' + responses: + default: + content: + text/plain: + schema: + type: string + description: default response + servers: + - url: /sdc2/rest + variables: {} + tags: + - SDCE-2 APIs + /configmgr/set2: + post: + operationId: setConfig2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Configuration' + responses: + default: + content: + text/plain: {} + description: default response + servers: + - url: /sdc2/rest + variables: {} + tags: + - SDCE-2 APIs + /configmgr/setput1: + put: + operationId: setConfig3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Configuration' + responses: + default: + content: + text/plain: + schema: + type: string + description: default response + servers: + - url: /sdc2/rest + variables: {} + tags: + - SDCE-2 APIs + /configmgr/setput2: + put: + operationId: setConfig4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Configuration' + responses: + default: + content: + text/plain: {} + description: default response + servers: + - url: /sdc2/rest + variables: {} + tags: + - SDCE-2 APIs + /healthCheck: + get: + description: Return aggregate BE health check of SDC BE components + operationId: getHealthCheck + responses: + "200": + description: SDC BE components are all up + "500": + description: One or more SDC BE components are down + default: + content: + application/json: + schema: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: return BE health check + tags: + - SDCE-2 APIs + /v1/artifactTypes: + get: + description: Retrieve all artifactTypes + operationId: getArtifactTypes + parameters: + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Returns artifactTypes Ok + "404": + description: No artifactTypes were found + "500": + description: Internal Server Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + servers: + - url: /sdc2/rest + variables: {} + summary: Retrieve all artifactTypes + tags: + - SDCE-2 APIs + /v1/catalog/allDataTypes: + get: + description: Get data types + operationId: getAllDataTypesFromAllModels + parameters: + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: allDataTypes + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Data 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 all data types from all models + tags: + - SDCE-2 APIs + /v1/catalog/archive: + get: + description: Get all Archived Components + operationId: getArchivedComponents + parameters: + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Success + "400": + description: Bad request + "403": + description: Restricted operation + "500": + description: Internal Error + default: + content: + application/json: + schema: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Get all Archived Components + tags: + - SDCE-2 APIs + /v1/catalog/artifactTypes: + get: + description: Get Tosca ArtifactTypes + operationId: getAllToscaArtifactTypes + parameters: + - description: Model name + in: query + name: model + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Listing successful + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Tosca Artifact Types not found + default: + content: + '*/*': + 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 tosca artifact types + tags: + - SDCE-2 APIs + /v1/catalog/audit-records/{componentType}/{componentUniqueId}: + get: + description: get component audit records + operationId: getComponentAuditRecords + parameters: + - in: path + name: componentType + required: true + schema: + type: string + - in: path + name: componentUniqueId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Service found + "403": + description: Restricted operation + 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: get audit records for a service or a resource + tags: + - SDCE-2 APIs + /v1/catalog/capabilityTypes: + get: + description: Get capability types + operationId: getAllCapabilityTypesServlet + parameters: + - in: header + name: USER_ID + schema: + type: string + - description: model + in: query + name: model + schema: + type: string + responses: + "200": + description: capabilityTypes + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Capability 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 capability types + tags: + - SDCE-2 APIs + /v1/catalog/data-types/{dataTypeUid}: + get: + description: Get data types + operationId: fetchDataType + parameters: + - in: header + name: USER_ID + schema: + type: string + - in: path + name: dataTypeUid + required: true + schema: + type: string + responses: + "200": + description: Data type found + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Data types not found + default: + content: + application/json: + schema: + $ref: '#/components/schemas/DataTypeDataDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns data types + tags: + - SDCE-2 APIs + /v1/catalog/data-types/{id}/properties: + get: + description: Get a data type properties + operationId: fetchProperties + parameters: + - description: The data type id + in: path + name: id + required: true + schema: + type: string + responses: + "200": + description: "Data type found, properties may be empty" + "403": + description: Restricted operation + "404": + description: Data type not found + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PropertyDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns the data type properties + tags: + - SDCE-2 APIs + post: + description: Create a property in the given data type + operationId: createProperty + parameters: + - description: The data type id + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PropertyDefinitionDto' + description: Property to add + required: true + responses: + "201": + description: Property created in the data type + "400": + description: Invalid payload + "403": + description: Restricted operation + "404": + description: Data type not found + "409": + description: Property already exists in the data type + default: + content: + application/json: + schema: + $ref: '#/components/schemas/PropertyDefinitionDto' + servers: + - url: /sdc2/rest + variables: {} + summary: Create a property in the given data type + tags: + - SDCE-2 APIs + /v1/catalog/dataTypes: + get: + description: Get data types + operationId: getAllDataTypesServlet + parameters: + - in: header + name: USER_ID + schema: + type: string + - description: model + in: query + name: model + schema: + type: string + responses: + "200": + description: datatypes + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Data 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 data types + tags: + - SDCE-2 APIs + /v1/catalog/directives: + get: + description: Retrieve all Directives values from configuration file + operationId: getConfCategoriesAndVersion + parameters: + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Returns Directive values from configuration file Ok + "404": + description: Directive not found + "500": + description: Internal Server Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + summary: Retrieve all Directives + tags: + - SDCE-2 APIs + /v1/catalog/gab/searchFor: + post: + description: Search json paths inside the yaml + operationId: searchFor + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GenericArtifactQueryInfo' + description: Generic Artifact search model + required: true + responses: + "200": + description: Returned yaml entries + "400": + description: Invalid content / Missing content + 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 found entries of json paths + tags: + - SDCE-2 APIs + /v1/catalog/groupTypes: + get: + description: 'Get group types ' + operationId: getGroupTypes + parameters: + - in: header + name: USER_ID + schema: + type: string + - 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 + responses: + "200": + description: group types found + "400": + description: "field name invalid type/length, characters; mandatory field\ + \ is absent, already exists (name)" + "403": + description: Restricted operation + "500": + description: Internal Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/GroupTypeDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns group types + tags: + - SDCE-2 APIs + /v1/catalog/handleException: + get: + description: Handle exception + operationId: sendError + responses: + "500": + 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 + description: Internal Error + servers: + - url: /sdc2/rest + variables: {} + tags: + - SDCE-2 APIs + /v1/catalog/interfaceLifecycleTypes: + get: + description: Get interface lifecycle types + operationId: getInterfaceLifecycleTypes + parameters: + - in: header + name: USER_ID + schema: + type: string + - description: model + in: query + name: model + 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/lock: + post: + description: Toggle disable locking + operationId: toggleDisableLocking + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: boolean + description: Disable Locking + responses: + "200": + description: Disable locking successfully updated + "500": + description: Update disable locking failed + default: + content: + application/json: + schema: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + tags: + - SDCE-2 APIs + /v1/catalog/model: + get: + description: List all the existing TOSCA models + operationId: listModels + parameters: + - in: header + name: USER_ID + schema: + type: string + - in: query + name: modelType + schema: + type: string + responses: + "200": + description: Listing successful + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Model' + servers: + - url: /sdc2/rest + variables: {} + summary: List TOSCA models + tags: + - SDCE-2 APIs + post: + description: "Create a TOSCA model, along with its imports files" + operationId: createModel + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + model: + $ref: '#/components/schemas/ModelCreateRequest' + modelImportsZip: + type: object + description: the model TOSCA imports zipped + required: + - model + - modelImportsZip + responses: + "201": + description: Model created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Model already exists + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Create a TOSCA model + tags: + - SDCE-2 APIs + /v1/catalog/model/imports: + put: + description: Update a model TOSCA imports + operationId: updateModelImports + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + modelImportsZip: + type: object + description: the model TOSCA imports zipped + modelName: + type: string + description: model to be created + required: + - modelImportsZip + - modelName + responses: + "204": + description: Model imports updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Model not found + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Update a model TOSCA imports + tags: + - SDCE-2 APIs + /v1/catalog/nodeTypes: + get: + description: Get node types + operationId: getAllNodeTypesServlet + parameters: + - in: header + name: USER_ID + schema: + type: string + - description: model + in: query + name: model + schema: + type: string + responses: + "200": + description: nodeTypes + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Node 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 node types + tags: + - SDCE-2 APIs + /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: + - 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/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: policy types found + "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' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns policy types + tags: + - SDCE-2 APIs + /v1/catalog/relationshipTypes: + get: + description: Get relationship types + operationId: getAllRelationshipTypesServlet + parameters: + - in: header + name: USER_ID + schema: + type: string + - description: model + in: query + name: model + schema: + type: string + responses: + "200": + description: relationshipTypes + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Relationship 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 relationship types + tags: + - SDCE-2 APIs + /v1/catalog/resources: + post: + description: Create Resource + operationId: createResource + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + 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' + 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}/interfaceOperation: + put: + description: Update Interface Operation + operationId: updateResourceInterfaceOperation + parameters: + - description: Component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: Update Interface Operation + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Update Interface Operation on ComponentInstance + 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 + - description: "Optional parameter to determine the delete action: DELETE, which\ + \ will permanently delete the Resource from the system or MARK_AS_DELETE,\ + \ which will logically mark the Resource as deleted. Default action is to\ + \ MARK_AS_DELETE" + in: query + name: deleteAction + schema: + type: string + enum: + - MARK_AS_DELETE + - DELETE + 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 + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated Additional Inforamtion property + tags: + - SDCE-2 APIs + /v1/catalog/resources/{resourceId}/artifacts: + post: + description: Create Artifact + operationId: loadArtifact + parameters: + - in: path + name: resourceId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: json describe the artifact + required: true + responses: + "201": + description: Resource created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Artifact 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 ArtifactDefinition + tags: + - SDCE-2 APIs + /v1/catalog/resources/{resourceId}/artifacts/{artifactId}: + delete: + description: Delete Artifact + operationId: deleteArtifact + parameters: + - in: path + name: resourceId + required: true + schema: + type: string + - in: path + name: artifactId + required: true + schema: + type: string + responses: + "201": + description: Resource created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + 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 delete artifact + tags: + - SDCE-2 APIs + get: + description: Download resource Artifact in Base64 + operationId: downloadResourceArtifactBase64 + parameters: + - in: path + name: resourceId + required: true + schema: + type: string + - in: path + name: artifactId + required: true + schema: + type: string + responses: + "200": + description: Resource artifact downloaded + "404": + description: Resource/Artifact 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 downloaded artifact + tags: + - SDCE-2 APIs + post: + description: Update Artifact + operationId: updateArtifact + parameters: + - in: path + name: resourceId + required: true + schema: + type: string + - in: path + name: artifactId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: json describe the artifact + required: true + responses: + "201": + description: Resource created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated artifact + tags: + - SDCE-2 APIs + /v1/catalog/resources/{resourceId}/attributes: + get: + description: Get Resource Attribute + operationId: getAttributeListInResource + parameters: + - description: resource id of attribute + in: path + name: resourceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: attribute + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Resource attribute 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 attribute list of resource + tags: + - SDCE-2 APIs + post: + description: Create Resource Attribute + operationId: createAttribute + parameters: + - description: resource id to update with new attribute + 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: Resource attribute to be created + required: true + responses: + "201": + description: Resource property created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Resource attribute 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 resource attribute + tags: + - SDCE-2 APIs + /v1/catalog/resources/{resourceId}/attributes/{attributeId}: + delete: + description: Create Resource Attribute + operationId: deleteAttribute + parameters: + - description: resource id of attribute + in: path + name: resourceId + required: true + schema: + type: string + - description: Attribute id to delete + in: path + name: attributeId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "204": + description: deleted attribute + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Resource property 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 deleted attribute + tags: + - SDCE-2 APIs + put: + description: Update Resource Attribute + operationId: updateAttribute + parameters: + - description: resource id to update with new attribute + in: path + name: resourceId + required: true + schema: + type: string + - description: attribute id to update + in: path + name: attributeId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Resource attribute to update + required: true + responses: + "200": + description: Resource attribute updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated attribute + tags: + - SDCE-2 APIs + /v1/catalog/resources/{resourceId}/capabilities: + post: + description: Create Capabilities on resource + operationId: createCapabilitiesOnResource + parameters: + - description: Resource Id + 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: Capability to create + required: true + responses: + "201": + description: Create Capabilities + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Capability 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: Create Capabilities on resource + tags: + - SDCE-2 APIs + put: + description: Update Capabilities on resource + operationId: updateCapabilitiesOnResource + parameters: + - description: Component Id + 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: Capabilities to update + required: true + responses: + "201": + description: Update Capabilities + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CapabilityDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Update Capabilities on resource + tags: + - SDCE-2 APIs + /v1/catalog/resources/{resourceId}/capabilities/{capabilityId}: + delete: + description: Delete capability from resource + operationId: deleteCapabilityOnResource + parameters: + - description: capability Id + in: path + name: capabilityId + required: true + schema: + type: string + - description: Resource Id + in: path + name: resourceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: Delete capability + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CapabilityDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Delete capability from resource + tags: + - SDCE-2 APIs + get: + description: Get Capability from resource + operationId: getCapabilityOnResource + parameters: + - description: Resource Id + in: path + name: resourceId + required: true + schema: + type: string + - description: Capability Id + in: path + name: capabilityId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: GET Capability + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CapabilityDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: GET Capability from resource + tags: + - SDCE-2 APIs + /v1/catalog/resources/{resourceId}/interfaceOperations: + post: + description: Create Interface Operations on Resource + operationId: createInterfaceOperationsOnResource + parameters: + - description: Resource Id + 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: Interface Operations to create + required: true + responses: + "201": + description: Create Interface Operations on Resource + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Resource not found + "409": + description: Interface Operation already exist + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Create Interface Operations on Resource + tags: + - SDCE-2 APIs + put: + description: Update Interface Operations on Resource + operationId: updateInterfaceOperationsOnResource + parameters: + - description: Resource Id + 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: Interface Operations to update + required: true + responses: + "201": + description: Update Interface Operations on Resource + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Resource not found + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Update Interface Operations on Resource + tags: + - SDCE-2 APIs + /v1/catalog/resources/{resourceId}/interfaces/{interfaceId}/operations/{operationId}: + delete: + description: Delete Interface Operation from Resource + operationId: deleteInterfaceOperationsFromResource + parameters: + - description: Resource Id + in: path + name: resourceId + required: true + schema: + type: string + - description: Interface Id + in: path + name: interfaceId + required: true + schema: + type: string + - description: Operation Id + in: path + name: operationId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: Delete Interface Operation from Resource + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Resource not found + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Delete Interface Operation from Resource + tags: + - SDCE-2 APIs + get: + description: Get Interface Operation from Resource + operationId: getInterfaceOperationsFromResource + parameters: + - description: Resource Id + in: path + name: resourceId + required: true + schema: + type: string + - description: Interface Id + in: path + name: interfaceId + required: true + schema: + type: string + - description: Operation Id + in: path + name: operationId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: Delete Interface Operation from Resource + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Resource not found + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: GET Interface Operation from Resource + tags: + - SDCE-2 APIs + /v1/catalog/resources/{resourceId}/metadata: + put: + description: Update Resource Metadata + operationId: updateResourceMetadata + parameters: + - 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: Resource metadata to be updated + required: true + responses: + "200": + description: Resource metadata updated + "400": + description: Invalid content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Resource' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated resource metadata + tags: + - SDCE-2 APIs + /v1/catalog/resources/{resourceId}/properties: + get: + description: Get Resource Property + operationId: getPropertyListInResource + parameters: + - description: resource id of property + in: path + name: resourceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: property + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Resource property 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 property list of resource + tags: + - SDCE-2 APIs + post: + description: Create Resource Property + operationId: createPropertyInResource + 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: Resource property to be created + required: true + responses: + "201": + description: Resource property created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Resource property 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 service property + tags: + - SDCE-2 APIs + put: + description: Update Resource Property + operationId: updatePropertyInResource + 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: Resource property to update + required: true + responses: + "200": + description: Resource property updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated property + tags: + - SDCE-2 APIs + /v1/catalog/resources/{resourceId}/properties/{propertyId}: + delete: + description: Delete Resource Property + operationId: deletePropertyInResource + parameters: + - description: resource id of property + in: path + name: resourceId + required: true + schema: + type: string + - description: Property id to delete + in: path + name: propertyId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "204": + description: deleted property + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Resource property 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 deleted property + tags: + - SDCE-2 APIs + get: + description: Get Resource Property + operationId: getPropertyInResource + parameters: + - description: resource id of property + in: path + name: resourceId + required: true + schema: + type: string + - description: property id to get + in: path + name: propertyId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: property + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Resource property 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 property of resource + tags: + - SDCE-2 APIs + /v1/catalog/resources/{resourceId}/requirements: + post: + description: Create requirements on resource + operationId: createRequirementsOnResource + parameters: + - description: Resource Id + 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: Requirement to create + required: true + responses: + "201": + description: Create requirements + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: requirement 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: Create requirements on resource + tags: + - SDCE-2 APIs + put: + description: Update Requirements on resource + operationId: updateRequirementsOnResource + parameters: + - description: Component Id + 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: Requirements to update + required: true + responses: + "201": + description: Update Requirements + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RequirementDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Update Requirements on resource + tags: + - SDCE-2 APIs + /v1/catalog/resources/{resourceId}/requirements/{requirementId}: + delete: + description: Delete requirements from resource + operationId: deleteRequirementsFromResource + parameters: + - description: Resource Id + in: path + name: resourceId + required: true + schema: + type: string + - description: requirement Id + in: path + name: requirementId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: Delete requirement + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RequirementDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Delete requirements from resource + tags: + - SDCE-2 APIs + get: + description: Get Requirement from resource + operationId: getRequirementsFromResource + parameters: + - description: Resource Id + in: path + name: resourceId + required: true + schema: + type: string + - description: Requirement Id + in: path + name: requirementId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: GET requirement + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RequirementDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: GET Requirement from resource + tags: + - SDCE-2 APIs + /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts: + post: + description: Create Artifact and Attach to interface + operationId: loadArtifactToInterface + parameters: + - in: path + name: resourceId + required: true + schema: + type: string + - in: path + name: interfaceType + required: true + schema: + type: string + - in: path + name: operation + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + - in: header + name: Content-MD5 + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: json describe the artifact + required: true + responses: + "201": + description: Resource created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Artifact 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 resource + tags: + - SDCE-2 APIs + /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts/{artifactId}: + delete: + description: delete Artifact from interface + operationId: deleteArtifactToInterface + parameters: + - in: path + name: resourceId + required: true + schema: + type: string + - in: path + name: interfaceType + required: true + schema: + type: string + - in: path + name: operation + required: true + schema: + type: string + - in: path + name: artifactId + required: true + schema: + type: string + responses: + "201": + description: delete artifact under interface deleted + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Artifact 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: delete matching artifact from interface + tags: + - SDCE-2 APIs + post: + description: update Artifact Attach to interface + operationId: updateArtifactToInterface + parameters: + - in: path + name: resourceId + required: true + schema: + type: string + - in: path + name: interfaceType + required: true + schema: + type: string + - in: path + name: operation + required: true + schema: + type: string + - in: path + name: artifactId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + - in: header + name: Content-MD5 + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: json describe the artifact + required: true + responses: + "201": + description: delete artifact under interface deleted + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Artifact 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: updates artifact by interface + tags: + - SDCE-2 APIs + /v1/catalog/resources/{resourceName}/{version}: + delete: + description: Delete Resource By Name And Version + operationId: deleteResourceByNameAndVersion + parameters: + - in: path + name: resourceName + required: true + schema: + type: string + - in: path + name: version + required: true + schema: + type: string + responses: + "204": + description: Resource deleted + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Resource not found + default: + content: + '*/*': + schema: + type: array + items: + $ref: '#/components/schemas/Resource' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns no content + tags: + - SDCE-2 APIs + /v1/catalog/services: + post: + description: Create Service + operationId: createService + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Service object to be created + required: true + responses: + "201": + description: Service created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Service already exist + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Service' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns created service + tags: + - SDCE-2 APIs + /v1/catalog/services/distribution/{did}: + get: + description: Retrieve Distributions + operationId: getListOfDistributionStatuses + parameters: + - in: path + name: did + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Service found + "403": + description: Restricted operation + "404": + description: Status not found + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DistributionStatusListResponse' + servers: + - url: /sdc2/rest + variables: {} + summary: Return the list of distribution status objects + tags: + - SDCE-5 APIs + /v1/catalog/services/importService: + post: + description: Import Service + operationId: importNsService + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Service object to be imported + required: true + responses: + "201": + description: Service created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Service already exist + servers: + - url: /sdc2/rest + variables: {} + summary: Returns imported service + tags: + - SDCE-2 APIs + /v1/catalog/services/replaceVNF: + post: + description: Replace new VNF based on the existing VNF + operationId: replaceVNF + 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: string + description: Resource object to be created + required: true + responses: + "200": + content: + '*/*': + schema: + type: array + items: + $ref: '#/components/schemas/ReplaceVNFInfo' + description: ECOMP component is authenticated and list of Catalog Assets + Metadata is returned + "400": + description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "404": + description: "Error: Requested '%1' (uuid) resource was not found - SVC4063" + "405": + description: "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "409": + description: Service already exist + "500": + description: The GET request failed either due to internal SDC problem. + ECOMP Component should continue the attempts to get the needed information + - POL5000 + servers: + - url: /sdc2/rest + variables: {} + summary: Return whether the replace VNF is successful + tags: + - SDCE-2 APIs + /v1/catalog/services/serviceName/{serviceName}/serviceVersion/{serviceVersion}: + get: + description: Retrieve Service + operationId: getServiceByNameAndVersion + parameters: + - in: path + name: serviceName + required: true + schema: + type: string + - in: path + name: serviceVersion + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Service found + "403": + description: Restricted operation + "404": + description: Service not found + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Service' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns service according to name and version + tags: + - SDCE-2 APIs + /v1/catalog/services/serviceUUID/{uuid}/importReplaceService: + post: + description: Import Service + operationId: importReplaceService + 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 + - description: The requested asset uuid + in: path + name: uuid + required: true + schema: + type: string + requestBody: + content: + '*/*': + schema: + type: object + properties: + serviceZip: + $ref: '#/components/schemas/FormDataContentDisposition' + serviceZipMetadata: + type: string + description: serviceMetadata + responses: + "201": + description: Service created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Service already exist + servers: + - url: /sdc2/rest + variables: {} + summary: Returns imported service + tags: + - SDCE-2 APIs + /v1/catalog/services/validate-name/{serviceName}: + get: + description: validate service name + operationId: validateServiceName + parameters: + - in: path + name: serviceName + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Service found + "403": + description: Restricted operation + 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: 'checks if the chosen service name is available ' + tags: + - SDCE-2 APIs + /v1/catalog/services/{componentId}/archive: + post: + description: Archive Service + operationId: archiveService + 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: Service not found + "500": + description: Internal Error + default: + content: + application/json: + schema: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Marks a service as archived. Can be restored with restore action + tags: + - SDCE-2 APIs + /v1/catalog/services/{componentId}/copyComponentInstance/{componentInstanceId}: + post: + description: Copy Component Instance + operationId: copyComponentInstance + parameters: + - description: service unique id in pasted canvas + in: path + name: componentId + required: true + schema: + type: string + - in: path + name: componentInstanceId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Data for copying + required: true + responses: + "201": + description: Copy and Paste Success + "400": + description: Invalid Content / Missing content + "403": + description: Restricted Operation + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Service' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated service information + tags: + - SDCE-2 APIs + /v1/catalog/services/{componentId}/restore: + post: + description: Restore Service + operationId: restoreService + 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: Service not found + "500": + description: Internal Error + default: + content: + application/json: + schema: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Restores a service from archive. + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}: + delete: + description: Delete Service + operationId: deleteService + parameters: + - in: path + name: serviceId + required: true + schema: + type: string + - description: "Optional parameter to determine the delete action: DELETE, which\ + \ will permanently delete theService from the system or MARK_AS_DELETE,\ + \ which will logically mark the service as deleted. Default action is to\ + \ MARK_AS_DELETE" + in: query + name: deleteAction + schema: + type: string + enum: + - DELETE + - MARK_AS_DELETE + responses: + "204": + description: Service deleted + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Service not found + default: + content: + '*/*': + schema: + type: array + items: + $ref: '#/components/schemas/Service' + servers: + - url: /sdc2/rest + variables: {} + summary: Return no content + tags: + - SDCE-2 APIs + get: + description: Retrieve Service + operationId: getServiceById_1 + parameters: + - in: path + name: serviceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Service found + "403": + description: Restricted operation + "404": + description: Service not found + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Service' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns service according to serviceId + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/additionalinfo: + get: + description: Get all Additional Information under service + operationId: getAllServiceAdditionalInformationLabel + parameters: + - description: service id to update with new property + in: path + name: serviceId + 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: createServiceAdditionalInformationLabel + parameters: + - description: service id to update with new property + in: path + name: serviceId + 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/services/{serviceId}/additionalinfo/{labelId}: + delete: + description: Create Additional Information Label and Value + operationId: deleteServiceAdditionalInformationLabel + parameters: + - description: service id to update with new property + in: path + name: serviceId + 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: getServiceAdditionalInformationLabel + parameters: + - description: service id to update with new property + in: path + name: serviceId + 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: updateServiceAdditionalInformationLabel + parameters: + - description: service id to update with new property + in: path + name: serviceId + 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 + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated Additional Inforamtion property + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/artifacts: + post: + description: Create Artifact + operationId: loadInformationArtifact + parameters: + - in: path + name: serviceId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: json describe the artifact + required: true + responses: + "201": + description: Resource created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Artifact 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 ArtifactDefinition + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/artifacts/api/{artifactId}: + delete: + description: Delete Api Artifact + operationId: deleteApiArtifact + parameters: + - in: path + name: serviceId + required: true + schema: + type: string + - in: path + name: artifactId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + - in: header + name: Content-MD5 + schema: + type: string + responses: + "204": + description: Api Artifact deleted + "403": + description: Restricted operation + 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 ArtifactDefinition + tags: + - SDCE-2 APIs + post: + description: Update Api Artifact + operationId: updateApiArtifact + parameters: + - in: path + name: serviceId + required: true + schema: + type: string + - in: path + name: artifactId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + - in: header + name: Content-MD5 + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: json describe the artifact + required: true + responses: + "200": + description: Api Artifact Updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + 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 ArtifactDefinition + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/artifacts/{artifactId}: + delete: + description: Delete Artifact + operationId: deleteInformationalArtifact + parameters: + - in: path + name: serviceId + required: true + schema: + type: string + - in: path + name: artifactId + required: true + schema: + type: string + responses: + "201": + description: Service artifact deleted + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + 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 delete artifact + tags: + - SDCE-2 APIs + get: + description: Download service Artifact in Base64 + operationId: downloadServiceArtifactBase64 + parameters: + - in: path + name: serviceId + required: true + schema: + type: string + - in: path + name: artifactId + required: true + schema: + type: string + responses: + "200": + description: Service artifact downloaded + "404": + description: Service/Artifact 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 downloaded artifact + tags: + - SDCE-2 APIs + post: + description: Update Artifact + operationId: updateInformationArtifact + parameters: + - in: path + name: serviceId + required: true + schema: + type: string + - in: path + name: artifactId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: json describe the artifact + required: true + responses: + "201": + description: Service artifact created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated artifact + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/attributes: + get: + description: Get Service Attribute + operationId: getAttributeListInService + parameters: + - description: service id of attribute + in: path + name: serviceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: attribute + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Service attribute 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 attribute list of service + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/capabilities: + post: + description: Create Capabilities on service + operationId: createCapabilitiesOnService + parameters: + - description: Service Id + in: path + name: serviceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Capability to create + required: true + responses: + "201": + description: Create Capabilities + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Capability 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: Create Capabilities on service + tags: + - SDCE-2 APIs + put: + description: Update Capabilities on service + operationId: updateCapabilitiesOnService + parameters: + - description: Component Id + in: path + name: serviceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Capabilities to update + required: true + responses: + "201": + description: Update Capabilities + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CapabilityDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Update Capabilities on service + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/capabilities/{capabilityId}: + delete: + description: Delete capability from service + operationId: deleteCapabilityOnService + parameters: + - description: capability Id + in: path + name: capabilityId + required: true + schema: + type: string + - description: Service Id + in: path + name: serviceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: Delete capability + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CapabilityDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Delete capability from service + tags: + - SDCE-2 APIs + get: + description: Get Capability from service + operationId: getCapabilityOnService + parameters: + - description: Service Id + in: path + name: serviceId + required: true + schema: + type: string + - description: Capability Id + in: path + name: capabilityId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: GET Capability + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CapabilityDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: GET Capability from service + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/consumption/{serviceInstanceId}: + post: + description: Service consumption on operation + operationId: addInputToServiceOperation + parameters: + - in: path + name: serviceId + required: true + schema: + type: string + - in: path + name: serviceInstanceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Service Consumption Data + required: true + responses: + "201": + description: Service property created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Service property 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 consumption data + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/consumption/{serviceInstanceId}/interfaces/{interfaceId}/operations/{operationId}/inputs: + get: + operationId: getInputsListOfOperation + parameters: + - in: path + name: serviceId + required: true + schema: + type: string + - in: path + name: serviceInstanceId + required: true + schema: + type: string + - in: path + name: interfaceId + required: true + schema: + type: string + - in: path + name: operationId + required: true + schema: + type: string + - 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/services/{serviceId}/distribution/{did}/markDeployed: + post: + description: Mark distribution as deployed + operationId: markDistributionAsDeployed + parameters: + - in: path + name: serviceId + required: true + schema: + type: string + - in: path + name: did + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Service was marked as deployed + "400": + description: Invalid content / Missing content + "403": + description: Service is not available + "404": + description: Requested service was not found + "409": + description: Restricted operation + "500": + description: Internal Server Error. Please try again later. + servers: + - url: /sdc2/rest + variables: {} + summary: relevant audit record will be created + tags: + - SDCE-5 APIs + /v1/catalog/services/{serviceId}/distribution/{env}/activate: + post: + description: Activate distribution + operationId: activateDistribution + parameters: + - in: path + name: serviceId + required: true + schema: + type: string + - in: path + name: env + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: OK + "404": + description: Requested service was not found + "409": + description: Service cannot be distributed due to missing deployment artifacts + "500": + description: Internal Server Error. Please try again later. + servers: + - url: /sdc2/rest + variables: {} + summary: activate distribution + tags: + - SDCE-5 APIs + /v1/catalog/services/{serviceId}/interfaceOperations: + post: + description: Create Interface Operations on Service + operationId: createInterfaceOperationsOnService + parameters: + - description: Service Id + in: path + name: serviceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Interface Operations to create + required: true + responses: + "201": + description: Create Interface Operations on Service + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Service not found + "409": + description: Interface Operation already exist + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Create Interface Operations on Service + tags: + - SDCE-2 APIs + put: + description: Update Interface Operations on Service + operationId: updateInterfaceOperationsOnService + parameters: + - description: Service Id + in: path + name: serviceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Interface Operations to update + required: true + responses: + "201": + description: Update Interface Operations on Service + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Service not found + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Update Interface Operations on Service + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/interfaces/{interfaceId}/operations/{operationId}: + delete: + description: Delete Interface Operation from Service + operationId: deleteInterfaceOperationsFromService + parameters: + - description: Service Id + in: path + name: serviceId + required: true + schema: + type: string + - description: Interface Id + in: path + name: interfaceId + required: true + schema: + type: string + - description: Operation Id + in: path + name: operationId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: Delete Interface Operation from Service + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Service not found + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Delete Interface Operation from Service + tags: + - SDCE-2 APIs + get: + description: Get Interface Operation from Service + operationId: getInterfaceOperationsFromService + parameters: + - description: Service Id + in: path + name: serviceId + required: true + schema: + type: string + - description: Interface Id + in: path + name: interfaceId + required: true + schema: + type: string + - description: Operation Id + in: path + name: operationId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: Get Interface Operation from Service + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Service not found + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: GET Interface Operation from Service + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/linksMap: + get: + description: Retrieve Service component relations map + operationId: getServiceComponentRelationMap + parameters: + - in: path + name: serviceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Service found + "403": + description: Restricted operation + "404": + description: Service not found + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceRelations' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns service components relations + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/metadata: + put: + description: Update Service Metadata + operationId: updateServiceMetadata + parameters: + - in: path + name: serviceId + required: true + schema: + type: string + - 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: Service Updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Service' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated service + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/paths: + post: + description: Create Forwarding Path + operationId: createForwardingPath + parameters: + - description: Service Id + in: path + name: serviceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Forwarding Path to create + required: true + responses: + "201": + description: Create Forwarding Path + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Forwarding Path already exist + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Service' + servers: + - url: /sdc2/rest + variables: {} + summary: Create Forwarding Path + tags: + - SDCE-2 APIs + put: + description: Update Forwarding Path + operationId: updateForwardingPath + parameters: + - description: Service Id + in: path + name: serviceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Update Path to create + required: true + responses: + "201": + description: Update Forwarding Path + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Forwarding Path already exist + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Service' + servers: + - url: /sdc2/rest + variables: {} + summary: Update Forwarding Path + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/paths/{forwardingPathId}: + delete: + description: Delete Forwarding Path + operationId: deleteForwardingPath + parameters: + - description: Forwarding Path Id + in: path + name: forwardingPathId + required: true + schema: + type: string + - description: Service Id + in: path + name: serviceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: Delete Forwarding Path + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Forwarding Path already exist + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Service' + servers: + - url: /sdc2/rest + variables: {} + summary: Delete Forwarding Path + tags: + - SDCE-2 APIs + get: + description: Get Forwarding Path + operationId: getForwardingPath + parameters: + - description: Service Id + in: path + name: serviceId + required: true + schema: + type: string + - description: Forwarding Path Id + in: path + name: forwardingPathId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Forwarding Path to create + required: true + responses: + "201": + description: Get Forwarding Path + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Forwarding Path already exist + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ForwardingPathDataDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: GET Forwarding Path + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/properties: + get: + description: Get Service Property + operationId: getPropertyListInService + parameters: + - description: service id of property + in: path + name: serviceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: property + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Service property 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 property list of service + tags: + - SDCE-2 APIs + post: + description: Create Service Property + operationId: createPropertyInService + parameters: + - description: service id to update with new property + in: path + name: serviceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Service property to be created + required: true + responses: + "201": + description: Service property created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Service property 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 service property + tags: + - SDCE-2 APIs + put: + description: Update Service Property + operationId: updatePropertyInService + parameters: + - description: service id to update with new property + in: path + name: serviceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Service property to update + required: true + responses: + "200": + description: Service property updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated property + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/properties/{propertyId}: + delete: + description: Delete Service Property + operationId: deletePropertyInService + parameters: + - description: service id of property + in: path + name: serviceId + required: true + schema: + type: string + - description: Property id to delete + in: path + name: propertyId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "204": + description: deleted property + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Service property 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 deleted property + tags: + - SDCE-2 APIs + get: + description: Get Service Property + operationId: getPropertyInService + parameters: + - description: service id of property + in: path + name: serviceId + required: true + schema: + type: string + - description: property id to get + in: path + name: propertyId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: property + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Service property 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 property of service + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/requirements: + post: + description: Create requirements on service + operationId: createRequirementsOnService + parameters: + - description: Service Id + in: path + name: serviceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Requirements to create + required: true + responses: + "201": + description: Create Requirements + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Requirement 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: Create requirements on service + tags: + - SDCE-2 APIs + put: + description: Update requirements on service + operationId: updateRequirementsOnService + parameters: + - description: Component Id + in: path + name: serviceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Requirements to update + required: true + responses: + "201": + description: Update requirements + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RequirementDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Update requirements on service + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/requirements/{requirementId}: + delete: + description: Delete requirement from service + operationId: deleteRequirementsOnService + parameters: + - description: Service Id + in: path + name: serviceId + required: true + schema: + type: string + - description: Requirement Id + in: path + name: requirementId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: Delete Requirements + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RequirementDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Delete requirement from service + tags: + - SDCE-2 APIs + get: + description: Get requirement from service + operationId: getRequirementsOnService + parameters: + - description: Service Id + in: path + name: serviceId + required: true + schema: + type: string + - description: Requirement Id + in: path + name: requirementId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: GET Requirements + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RequirementDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: GET requirement from service + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceId}/tempUrlToBeDeleted: + post: + operationId: tempUrlToBeDeleted + parameters: + - in: path + name: serviceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: OK + "500": + description: Internal Server Error. Please try again later. + servers: + - url: /sdc2/rest + variables: {} + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceName}/{version}: + delete: + description: Delete Service By Name And Version + operationId: deleteServiceByNameAndVersion + parameters: + - in: path + name: serviceName + required: true + schema: + type: string + - in: path + name: version + required: true + schema: + type: string + responses: + "204": + description: Service deleted + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Service not found + default: + content: + '*/*': + schema: + type: array + items: + $ref: '#/components/schemas/Resource' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns no content + tags: + - SDCE-2 APIs + /v1/catalog/services/{serviceUUID}/distribution: + get: + description: Retrieve Distributions + operationId: getServiceById + parameters: + - in: path + name: serviceUUID + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Service found + "403": + description: Restricted operation + "404": + description: Service not found + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DistributionStatusListResponse' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns list bases on the information extracted from Auditing Records + according to service uuid + tags: + - SDCE-5 APIs + /v1/catalog/toggle: + get: + description: Get all Toggleable features + operationId: getAllFeatures + responses: + "200": + description: Success + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Toggleable features 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 list of toggleable features + tags: + - SDCE-2 APIs + /v1/catalog/toggle/state/{state}: + put: + description: Update all feature toggle state + operationId: setAllFeatures + parameters: + - in: path + name: state + required: true + schema: + type: boolean + responses: + "200": + description: Success + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Toggleable features not found + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Update all feature status + tags: + - SDCE-2 APIs + /v1/catalog/toggle/{featureName}/state: + get: + description: Get Toggleable feature state + operationId: getToggleableFeature + parameters: + - in: path + name: featureName + required: true + schema: + type: string + responses: + "200": + description: Success + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Toggleable feature 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 one toggleable feature state + tags: + - SDCE-2 APIs + /v1/catalog/toggle/{featureName}/state/{state}: + put: + description: Update feature toggle state + operationId: updateFeatureState + parameters: + - in: path + name: featureName + required: true + schema: + type: string + - in: path + name: state + required: true + schema: + type: boolean + responses: + "200": + description: Success + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Toggleable features not found + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Update feature status + tags: + - SDCE-2 APIs + /v1/catalog/upload/resource/import: + post: + description: "Import node types from a TOSCA yaml, along with the types metadata" + operationId: bulkImport + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + createNewVersion: + type: boolean + default: true + description: The model name to associate the node types to + nodeTypeMetadataJson: + $ref: '#/components/schemas/NodeTypesMetadataList' + nodeTypesYaml: + type: object + description: The node types TOSCA definition yaml + required: + - nodeTypeMetadataJson + - nodeTypesYaml + responses: + "201": + description: Resources created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: One of the resources already exists + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Creates node types from a TOSCA yaml file + tags: + - SDCE-2 APIs + /v1/catalog/upload/{resourceAuthority}: + post: + description: Create Resource from yaml + operationId: uploadMultipart + parameters: + - description: "validValues: normative-resource / user-resource" + in: path + name: resourceAuthority + required: true + schema: + type: string + enum: + - multipart + - user-resource + - user-resource-ui-import + - in: header + name: USER_ID + schema: + type: string + - in: query + name: createNewVersion + schema: + type: boolean + default: true + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + resourceMetadata: + type: string + description: resourceMetadata + resourceZip: + $ref: '#/components/schemas/FormDataContentDisposition' + 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: + 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 resource + tags: + - SDCE-2 APIs + /v1/catalog/uploadType/annotationtypes: + post: + description: Create AnnotationTypes from yaml + operationId: uploadAnnotationTypes + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + annotationTypesZip: + type: string + format: binary + description: FileInputStream + responses: + "201": + description: annotation types created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: annotation types 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 annotation types + tags: + - SDCE-2 APIs + /v1/catalog/uploadType/artifactTypes: + post: + description: Create Tosca Artifact types from yaml + operationId: uploadArtifactTypes + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + artifactsZip: + type: string + format: binary + description: Zip file containing a yaml with the TOSCA artifact + types definition + includeToModelImport: + type: boolean + description: A flag to add types to the default imports + model: + type: string + description: model name + responses: + "201": + description: Tosca Artifact types created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Tosca Artifact Type 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 Tosca artifact types + tags: + - SDCE-2 APIs + /v1/catalog/uploadType/capability: + post: + description: Create Capability Type from yaml + operationId: uploadCapabilityType + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + capabilityTypeZip: + type: string + format: binary + description: FileInputStream + includeToModelImport: + type: boolean + description: includeToModelImport + model: + type: string + description: model + responses: + "201": + description: Capability Type created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Capability Type 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 Capability Type + tags: + - SDCE-2 APIs + /v1/catalog/uploadType/categories: + post: + description: Create Categories from yaml + operationId: uploadCategories + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + categoriesZip: + type: string + format: binary + description: FileInputStream + responses: + "201": + description: Categories created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Category 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 categories + tags: + - SDCE-2 APIs + /v1/catalog/uploadType/datatypes: + post: + description: Create Categories from yaml + operationId: uploadDataTypes + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + dataTypesZip: + type: string + format: binary + description: FileInputStream + includeToModelImport: + type: boolean + description: includeToModelImport + model: + type: string + description: model + responses: + "201": + description: Data types created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Data types 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 data types + tags: + - SDCE-2 APIs + /v1/catalog/uploadType/grouptypes: + post: + description: Create GroupTypes from yaml + operationId: uploadGroupTypes + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + groupTypesZip: + type: string + format: binary + description: FileInputStream + includeToModelImport: + type: boolean + description: includeToModelImport + model: + type: string + description: model + toscaTypeMetadata: + type: string + description: toscaTypeMetadata + responses: + "201": + description: group types created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: group types 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 group types + tags: + - SDCE-2 APIs + /v1/catalog/uploadType/interfaceLifecycle: + post: + description: Create Interface Lyfecycle Type from yaml + operationId: uploadInterfaceLifecycleType + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + includeToModelImport: + type: boolean + description: includeToModelImport + interfaceLifecycleTypeZip: + type: string + format: binary + description: FileInputStream + model: + type: string + description: model + responses: + "201": + description: Interface Lifecycle Type created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Interface Lifecycle Type 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 Interface Lifecycle Type + tags: + - SDCE-2 APIs + /v1/catalog/uploadType/policytypes: + post: + description: Create PolicyTypes from yaml + operationId: uploadPolicyTypes + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + includeToModelImport: + type: boolean + description: includeToModelImport + model: + type: string + description: model + policyTypesZip: + type: string + format: binary + description: FileInputStream + toscaTypeMetadata: + type: string + description: toscaTypeMetadata + responses: + "201": + description: policy types created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: policy types 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 policy types + tags: + - SDCE-2 APIs + /v1/catalog/uploadType/relationship: + post: + description: Create Relationship Type from yaml + operationId: uploadRelationshipType + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + includeToModelImport: + type: boolean + description: includeToModelImport + model: + type: string + description: model + relationshipTypeZip: + type: string + format: binary + description: FileInputStream + responses: + "201": + description: Relationship Type created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Relationship Type 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 Relationship Type + tags: + - SDCE-2 APIs + /v1/catalog/{assetType}/{uuid}/interfaces/{interfaceUUID}/operations/{operationUUID}/artifacts/{artifactUUID}: + post: + description: uploads of artifact to component operation workflow + operationId: uploadInterfaceOperationArtifact + parameters: + - description: Asset type + in: path + name: assetType + required: true + schema: + type: string + - description: The uuid of the asset as published in the metadata + in: path + name: uuid + required: true + schema: + type: string + - description: The uuid of the interface + in: path + name: interfaceUUID + required: true + schema: + type: string + - description: The uuid of the operation + in: path + name: operationUUID + required: true + schema: + type: string + - description: The uuid of the artifact + in: path + name: artifactUUID + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + - in: header + name: Content-MD5 + schema: + type: string + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ArtifactDefinition' + description: Artifact uploaded + "400": + description: Restricted Operation – the user provided does not have role + of Designer or the asset is being used by another designer - SVC4301 + "404": + description: Specified resource is not found - SVC4063 + servers: + - url: /sdc2/rest + variables: {} + summary: uploads of artifact to component operation workflow + tags: + - SDCE-2 APIs + /v1/catalog/{componentType}/latestversion/notabstract: + get: + description: Get Component Requirments And Capabilities + operationId: getLatestVersionNotAbstractCheckoutComponents + parameters: + - in: path + name: componentType + required: true + schema: + type: string + - in: query + name: internalComponentType + schema: + type: string + - in: query + name: componentUids + 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: + $ref: '#/components/schemas/Resource' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns Requirments And Capabilities according to componentId + tags: + - SDCE-2 APIs + post: + description: Get Component Requirments And Capabilities + operationId: getLatestVersionNotAbstractCheckoutComponentsByBody + parameters: + - in: path + name: componentType + required: true + schema: + type: string + - in: query + name: internalComponentType + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + description: Consumer 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: Returns Requirments And Capabilities according to componentId + tags: + - SDCE-2 APIs + /v1/catalog/{componentType}/latestversion/notabstract/metadata: + get: + description: Get Component uid only + operationId: getLatestVersionNotAbstractCheckoutComponentsIdesOnly + parameters: + - in: path + name: componentType + required: true + schema: + type: string + - in: query + name: internalComponentType + schema: + type: string + - in: query + name: componentModel + schema: + type: string + - in: query + name: includeNormativeExtensionModels + schema: + type: boolean + - 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 componentId + tags: + - SDCE-2 APIs + /v1/catalog/{componentType}/{componentId}/automatedupgrade: + post: + description: Autometed upgrade + operationId: autometedUpgrade + 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: json describes upgrade request + required: true + responses: + "200": + description: Component found + "403": + description: Restricted operation + "404": + description: Component 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: '....' + tags: + - SDCE-2 APIs + /v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/interfaceOperation: + put: + description: Update Interface Operation + operationId: updateComponentInstanceInterfaceOperation + parameters: + - description: "valid values: resources / services" + in: path + name: componentType + required: true + schema: + type: string + enum: + - resources + - services + - description: Component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Component Instance Id + in: path + name: componentInstanceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: Update Interface Operation + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Update Interface Operation on ComponentInstance + tags: + - SDCE-2 APIs + /v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/{constraintType}/nodeFilter: + post: + description: Add Component Filter Constraint + operationId: addComponentFilterConstraint + parameters: + - description: Component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Component Instance Id + in: path + name: componentInstanceId + required: true + schema: + type: string + - description: "valid values: resources / services" + in: path + name: componentType + required: true + schema: + type: string + enum: + - resources + - services + - description: "Constraint type. Valid values: properties / capabilities" + in: path + name: constraintType + required: true + schema: + type: string + enum: + - properties + - capabilities + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: UIConstraint data + required: true + responses: + "201": + description: Create Component Filter + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + 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 + summary: Add Component Filter Constraint + tags: + - SDCE-2 APIs + /v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/{constraintType}/{constraintIndex}/nodeFilter: + delete: + description: Delete Component Filter Constraint + operationId: deleteComponentFilterConstraint + parameters: + - description: Component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Component Instance Id + in: path + name: componentInstanceId + required: true + schema: + type: string + - description: Constraint Index + in: path + name: constraintIndex + required: true + schema: + type: integer + format: int32 + - description: "valid values: resources / services" + in: path + name: componentType + required: true + schema: + type: string + enum: + - resources + - services + - description: "Constraint type. Valid values: properties / capabilities" + in: path + name: constraintType + required: true + schema: + type: string + enum: + - properties + - capabilities + - in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: Delete Component Filter Constraint + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + 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 + summary: Delete Component Filter Constraint + tags: + - SDCE-2 APIs + put: + description: Update Component Filter Constraint + operationId: updateComponentFilterConstraint + parameters: + - description: Component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Component Instance Id + in: path + name: componentInstanceId + required: true + schema: + type: string + - description: "valid values: resources / services" + in: path + name: componentType + required: true + schema: + type: string + enum: + - resources + - services + - description: "Constraint type. Valid values: properties / capabilities" + in: path + name: constraintType + required: true + schema: + type: string + enum: + - properties + - capabilities + - description: Constraint Index + in: path + name: constraintIndex + required: true + schema: + type: integer + format: int32 + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: UIConstraint data + required: true + responses: + "201": + description: Create Component Filter + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + 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 + summary: Update Component Filter Constraint + tags: + - SDCE-2 APIs + /v1/catalog/{componentType}/{componentId}/componentInstances: + get: + description: Get Component instances + operationId: getComponentInstancesFilteredByPropertiesAndInputs + parameters: + - in: path + name: componentType + required: true + schema: + type: string + - in: path + name: componentId + required: true + 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 + 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 input + tags: + - SDCE-2 APIs + /v1/catalog/{componentType}/{componentId}/create/outputs: + post: + description: Create outputs on service + operationId: createMultipleOutputs + 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 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 + 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 policies 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 policies list + tags: + - SDCE-2 APIs + /v1/catalog/{componentType}/{componentId}/dataType/{dataTypeName}: + delete: + description: Delete data type from service + operationId: deleteDataType + parameters: + - in: path + name: componentType + required: true + schema: + type: string + - in: path + name: componentId + required: true + schema: + type: string + - in: path + 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: componentId + required: true + schema: + type: string + - 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 + required: true + schema: + type: string + - in: path + name: componentId + required: true + 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: componentId + required: true + schema: + type: string + - in: path + name: inputId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Service Input to be deleted + required: true + responses: + "200": + description: Input deleted + "403": + description: Restricted operation + "404": + description: Input 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 + /v1/catalog/{componentType}/{componentId}/delete/{outputId}/output: + delete: + description: Delete output from service + operationId: deleteOutput + parameters: + - in: path + name: componentType + required: true + schema: + type: string + - in: path + name: componentId + required: true + schema: + type: string + - in: path + name: outputId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Service Output to be deleted + required: true + responses: + "200": + description: Output deleted + "403": + description: Restricted operation + "404": + description: Output not found + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Resource' + servers: + - url: /sdc2/rest + variables: {} + summary: Delete service output + tags: + - SDCE-2 APIs + /v1/catalog/{componentType}/{componentId}/dependencies: + get: + description: Autometed upgrade + operationId: getComponentDependencies + 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: array + items: + type: string + description: Consumer 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: + 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: '....' + 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 + tags: + - SDCE-2 APIs + /v1/catalog/{componentType}/{componentId}/requirmentsCapabilities: + get: + description: Get Component Requirments And Capabilities + operationId: getRequirementAndCapabilities + 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 + 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}/resource/interfaceOperation: + post: + description: Create Interface Operation + operationId: createInterfaceOperationInResource + parameters: + - description: "valid values: resources" + in: path + name: componentType + required: true + schema: + type: string + enum: + - resources + - description: Component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: Create Interface Operation + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Create Interface Operation on ComponentInstance + tags: + - SDCE-2 APIs + /v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}: + post: + description: Add Component Substitution Filter Constraint + operationId: addSubstitutionFilter + parameters: + - description: Component Id + in: path + name: componentId + required: true + schema: + type: string + - description: "valid value: resources / services" + in: path + name: componentType + required: true + schema: + 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 + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: UIConstraint data + required: true + responses: + "201": + description: Add Substitution Filter Constraint + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + 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 + summary: Add Component Substitution Filter Constraint + tags: + - SDCE-2 APIs + put: + description: Update Component Substitution Filter Constraint + operationId: updateSubstitutionFilters + parameters: + - description: Component Id + in: path + name: componentId + required: true + schema: + type: string + - description: "valid value: resources / services" + in: path + name: componentType + required: true + schema: + 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 + name: USER_ID + 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 + "403": + description: Restricted operation + 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 + summary: Update Component Substitution Filter Constraint + tags: + - SDCE-2 APIs + /v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}/{constraintIndex}: + delete: + description: Delete Component Substitution Filter Constraint + operationId: deleteSubstitutionFilterConstraint + parameters: + - description: Component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Constraint Index + in: path + name: constraintIndex + required: true + schema: + type: integer + format: int32 + - description: "valid value: resources / services" + in: path + name: componentType + required: true + schema: + 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 + name: USER_ID + schema: + type: string + responses: + "201": + description: Delete Substitution Filter Constraint + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + 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 + summary: Delete Component Substitution Filter Constraint + tags: + - SDCE-2 APIs + put: + description: Update Component Substitution Filter Constraint + operationId: updateSubstitutionFilter + parameters: + - description: Constraint Index + in: path + name: constraintIndex + required: true + schema: + type: integer + format: int32 + - description: Component Id + in: path + name: componentId + required: true + schema: + type: string + - description: The component type + in: path + name: componentType + required: true + schema: + type: string + enum: + - services + - resources + - description: "Constraint type. Valid values: properties / capabilities" + in: path + name: constraintType + required: true + schema: + type: string + enum: + - properties + - capabilities + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UIConstraint' + description: Filter constraint information + required: true + responses: + "201": + description: Update Substitution Filter Constraint + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + 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 + summary: Update Component Substitution Filter Constraint + tags: + - SDCE-2 APIs + /v1/catalog/{componentType}/{componentUuid}/conformanceLevelValidation: + get: + description: Validate Component Conformance Level + operationId: conformanceLevelValidation + parameters: + - in: path + name: componentType + required: true + schema: + type: string + - in: path + name: componentUuid + 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 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: containerComponentType + required: true + schema: + type: string + enum: + - resources + - services + - in: path + name: componentId + required: true + schema: + type: string + - in: path + name: artifactGroupType + required: true + schema: + type: string + responses: + "200": + description: Component artifacts + "404": + description: Resource/Artifact 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 artifacts + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/batchDeleteResourceInstances: + post: + description: Batch Delete ResourceInstances + operationId: batchDeleteResourceInstances + parameters: + - 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 + - in: path + name: componentId + required: true + schema: + type: string + - in: path + name: groupId + required: true + schema: + type: string + - 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: containerComponentType + required: true + schema: + type: string + - in: path + name: componentId + required: true + schema: + type: string + - in: path + name: groupId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GroupDefinition' + description: GroupDefinition + required: true + responses: + "200": + description: Group updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: component / group Not found + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated Group + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/groups/{groupType}: + post: + description: 'Create group ' + operationId: createGroup + parameters: + - in: path + name: containerComponentType + required: true + schema: + type: string + - in: path + name: componentId + required: true + schema: + 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: + - 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: + "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: Component not found + "500": + description: Internal Error + 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 group id + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/members: + post: + description: 'Update group members ' + operationId: updateGroupMembers + 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: + 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: + 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 + "400": + description: Invalid content / Missing content + "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 + 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: + 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 forwarding paths to delete + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}: + delete: + description: Delete Policy + operationId: deletePolicy + parameters: + - 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 + - in: path + name: policyId + required: true + schema: + type: string + - description: USER_ID of modifier user + in: header + name: USER_ID + required: true + schema: + type: string + responses: + "204": + description: Policy was deleted + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: component / policy 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: No body + tags: + - SDCE-2 APIs + get: + description: Get Policy + operationId: getPolicy + parameters: + - 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 + - in: path + name: policyId + required: true + schema: + type: string + - description: USER_ID of modifier user + in: header + name: USER_ID + required: true + schema: + type: string + responses: + "200": + description: Policy was found + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: component / policy 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 Policy + tags: + - SDCE-2 APIs + put: + description: Update Policy metadata + operationId: updatePolicy + parameters: + - 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 + - in: path + name: policyId + required: true + schema: + type: string + - description: USER_ID of modifier user + in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: PolicyDefinition + required: true + responses: + "200": + description: Policy 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: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated Policy + 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 + parameters: + - 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 + - in: path + name: policyId + required: true + schema: + type: string + - description: USER_ID of modifier user + in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: PolicyDefinition + required: true + responses: + "200": + description: Policy properties 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: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated Policy + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/targets: + post: + description: update policy targets + operationId: updatePolicyTargets + parameters: + - 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 + - in: path + name: policyId + required: true + schema: + type: string + - description: USER_ID of modifier user + in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PolicyTargetDTO' + responses: + "201": + description: Policy target updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated Policy + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/undeclare: + put: + description: undeclare Policy + operationId: undeclarePolicy + parameters: + - 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 + - in: path + name: policyId + required: true + schema: + type: string + - description: USER_ID of modifier user + in: header + name: USER_ID + required: true + schema: + type: string + responses: + "204": + description: Policy was undeclared + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: component / policy 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: No body + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/policies/{policyTypeName}: + post: + description: Create Policy + operationId: createPolicy + parameters: + - 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 + - in: path + name: policyTypeName + 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 + "403": + description: Restricted operation + "404": + description: Component not found + "409": + description: Policy 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 Policy + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/relationId/{relationId}: + get: + description: Get relation + operationId: getRelationById + parameters: + - in: path + name: containerComponentType + required: true + schema: + type: string + - in: path + name: componentId + required: true + schema: + type: string + - in: path + name: relationId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: relation found + "403": + description: Restricted operation + "404": + description: Relation 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 relation metadata according to relationId + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/resourceInstance: + post: + description: Create ComponentInstance + operationId: createComponentInstance + parameters: + - 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: 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: + "201": + description: Component created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Component instance 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 ComponentInstance + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/associate: + post: + description: Associate RI to RI + operationId: associateRIToRI + parameters: + - description: unique id of the container component + in: path + name: componentId + required: true + schema: + type: string + - description: allowed values are resources /services / products + in: path + name: containerComponentType + required: true + schema: + type: string + enum: + - resources + - services + - products + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: RelationshipInfo + required: true + responses: + "201": + description: Relationship created + "400": + description: Invalid content / Missing content + "403": + description: Missing information + "409": + description: Relationship 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 RelationshipInfo + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/batchDissociate: + put: + description: Batch Dissociate RI from RI + operationId: batchDissociateRIFromRI + 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 + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: RelationshipInfo + required: true + responses: + "201": + description: Relationship deleted + "400": + description: Invalid Content / Missing Content + "403": + description: Missing Information + 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 RelationShip Info + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/createAndAssociate: + post: + description: Create RI and associate RI to RI + operationId: createAndAssociateRIToRI + parameters: + - 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 + - products + responses: + "201": + description: RI created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Relationship 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 RI and RelationshipInfo + tags: + - SDCE-2 APIs + /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: containerComponentType + required: true + schema: + type: string + enum: + - resources + - services + - products + - description: unique id of the container component + 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: RelationshipInfo + required: true + responses: + "201": + description: Relationship deleted + "400": + description: Invalid content / Missing content + "403": + description: Missing information + 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 RelationshipInfo + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/multipleComponentInstance: + post: + description: Update resource instance multiple component + operationId: updateMultipleComponentInstance + parameters: + - in: path + name: componentId + required: true + schema: + type: string + - description: "valid values: resources / services / products" + in: path + name: containerComponentType + required: true + schema: + type: string + enum: + - resources + - services + - products + requestBody: + content: + application/json: + schema: + type: string + description: Component Instance JSON Array + required: true + responses: + "200": + description: Resource instance updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated resource instance + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}: + post: + description: Update resource instance + operationId: updateComponentInstanceMetadata + parameters: + - in: path + name: componentId + required: true + schema: + type: string + - in: path + name: componentInstanceId + required: true + schema: + type: string + - description: "valid values: resources / services / products" + in: path + name: containerComponentType + required: true + schema: + type: string + enum: + - resources + - services + - products + responses: + "200": + description: Resource instance updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated resource instance + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts: + post: + 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: containerComponentType + required: true + schema: + type: string + enum: + - resources + - services + - in: path + name: componentId + required: true + schema: + type: string + - in: path + name: componentInstanceId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: json describe the artifact + required: true + responses: + "200": + description: Artifact updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated artifact + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}: + delete: + description: Delete Resource Instance artifact + operationId: deleteComponentInstanceArtifact + 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 + required: true + schema: + type: string + enum: + - resources + - services + - in: path + name: componentId + required: true + schema: + type: string + - in: path + name: componentInstanceId + required: true + schema: + type: string + - in: path + name: artifactId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: json describe the artifact + required: true + responses: + "200": + description: Artifact updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + 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 artifact + tags: + - SDCE-2 APIs + post: + description: Update Resource Instance artifact payload + operationId: updateComponentInstanceArtifact + 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 + required: true + schema: + type: string + enum: + - resources + - services + - in: path + name: componentId + required: true + schema: + type: string + - in: path + name: componentInstanceId + required: true + schema: + type: string + - in: path + name: artifactId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: json describe the artifact + required: true + responses: + "200": + description: Artifact updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated artifact + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}/heatParams: + post: + description: Update Resource Instance HEAT_ENV parameters + operationId: updateRIArtifact + parameters: + - description: "valid values: resources / services" + in: path + name: containerComponentType + required: true + schema: + type: string + enum: + - resources + - services + - in: path + name: componentId + required: true + schema: + type: string + - in: path + name: componentInstanceId + required: true + schema: + type: string + - in: path + name: artifactId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: json describe the artifact + required: true + responses: + "200": + description: Artifact updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated artifact + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/attributes: + post: + description: Update resource instance attribute + operationId: updateResourceInstanceAttribute + parameters: + - description: service id + 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: resource instance id + in: path + name: componentInstanceId + required: true + schema: + type: string + - description: id of user initiating the operation + in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Component Instance Properties JSON Array + required: true + responses: + "201": + description: Resource instance created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated resource instance property + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/changeVersion: + post: + description: Update resource instance + operationId: changeResourceInstanceVersion + parameters: + - in: path + name: componentId + required: true + schema: + type: string + - in: path + name: componentInstanceId + required: true + schema: + type: string + - description: "valid values: resources / services" + in: path + name: containerComponentType + required: true + schema: + type: string + enum: + - resources + - services + responses: + "201": + description: Resource instance created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated resource instance + tags: + - SDCE-2 APIs + /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 + schema: + type: string + - in: path + name: componentInstanceId + required: true + schema: + type: string + - in: path + name: groupInstId + required: true + schema: + type: string + - 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: + 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 artifacts metadata according to groupInstId + tags: + - SDCE-2 APIs + ? /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}/property + : post: + description: Update resource instance property + operationId: updateGroupInstanceProperty + parameters: + - description: service id + 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: resource instance id + in: path + name: componentInstanceId + required: true + 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 + name: USER_ID + schema: + type: string + responses: + "201": + description: Resource instance created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated resource instance property + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/inputs: + post: + description: Update resource instance property + operationId: updateResourceInstanceInput + parameters: + - description: service id + 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: resource instance id + in: path + name: componentInstanceId + required: true + schema: + type: string + - description: id of user initiating the operation + in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Component Instance Properties JSON Array + required: true + responses: + "201": + description: Resource instance created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated resource instance property + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/properties: + post: + description: Update resource instance property + operationId: updateResourceInstanceProperties + parameters: + - description: service id + 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: resource instance id + in: path + name: componentInstanceId + required: true + schema: + type: string + - description: id of user initiating the operation + in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Component Instance Properties JSON Array + required: true + responses: + "201": + description: Resource instance created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated resource instance property + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property/{propertyId}: + delete: + description: Update resource instance + operationId: deleteResourceInstanceProperty + parameters: + - description: service id + 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: resource instance id + in: path + name: componentInstanceId + required: true + schema: + type: string + - description: property id + in: path + name: propertyId + required: true + schema: + type: string + - description: id of user initiating the operation + in: header + name: USER_ID + schema: + type: string + responses: + "201": + description: Resource instance created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + 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 resource instance property + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{resourceInstanceId}: + delete: + description: Delete ResourceInstance + operationId: deleteResourceInstance + parameters: + - in: path + name: componentId + required: true + schema: + type: string + - in: path + name: resourceInstanceId + required: true + schema: + type: string + - description: "valid values: resources / services / products" + in: path + name: containerComponentType + required: true + schema: + type: string + enum: + - resources + - services + - products + responses: + "201": + description: ResourceInstance deleted + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + 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 delete resourceInstance + tags: + - SDCE-2 APIs + /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 + schema: + type: string + - in: path + name: componentInstanceId + required: true + schema: + type: string + - in: path + name: artifactId + required: true + schema: + type: string + responses: + "200": + description: ResourceInstance artifact downloaded + "404": + description: ResourceInstance/Artifact 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 downloaded artifact + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifactsByType/{artifactGroupType}: + get: + description: Get component Artifacts + operationId: getComponentInstanceArtifacts + parameters: + - description: "valid values: resources / services" + in: path + name: containerComponentType + required: true + schema: + type: string + enum: + - resources + - services + - in: path + name: componentId + required: true + schema: + type: string + - in: path + name: componentInstanceId + required: true + schema: + type: string + - in: path + name: artifactGroupType + required: true + schema: + type: string + responses: + "200": + description: Component artifacts + "404": + description: Resource/Artifact 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 artifacts + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{componentId}/update/inputs: + post: + description: Update resource inputs + operationId: updateComponentInputs + parameters: + - description: "valid values: resources / services" + in: path + name: containerComponentType + required: true + schema: + type: string + enum: + - resources + - services + - in: path + name: componentId + required: true + 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 + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated input + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/attributes: + get: + description: Get component instance attributes + operationId: getInstanceAttributesById + parameters: + - in: path + name: containerComponentType + required: true + schema: + type: string + - in: path + name: containerComponentId + required: true + schema: + type: string + - in: path + name: componentInstanceUniqueId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Attributes found + "403": + description: Restricted operation + "404": + description: Component/Component Instance - 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 component instance attributes + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/capability: + put: + description: Update Component Instance Capability + operationId: updateInstanceRequirement + parameters: + - in: path + name: containerComponentType + required: true + schema: + type: string + - in: path + name: containerComponentId + required: true + schema: + type: string + - in: path + name: componentInstanceUniqueId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ComponentInstanceCapabilityUpdateModel' + description: Component instance capability to update + required: true + responses: + "200": + description: Resource instance capability successfully updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Component/Component Instance/Capability not found + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated Component Instance Capability + tags: + - SDCE-2 APIs + ? /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/capability/{capabilityType}/capabilityName/{capabilityName}/ownerId/{ownerId}/properties + : get: + description: Get component instance capability properties + operationId: getInstanceCapabilityPropertiesById + parameters: + - in: path + name: containerComponentType + required: true + schema: + type: string + - in: path + name: containerComponentId + required: true + schema: + type: string + - in: path + name: componentInstanceUniqueId + required: true + schema: + type: string + - in: path + name: capabilityType + required: true + schema: + type: string + - in: path + name: capabilityName + required: true + schema: + type: string + - in: path + name: ownerId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Properties found + "403": + description: Restricted operation + "404": + description: Component/Component Instance/Capability - not found + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns component instance capability properties + tags: + - SDCE-2 APIs + put: + description: Update Instance Capabilty Property + operationId: updateInstanceCapabilityProperty + parameters: + - in: path + name: containerComponentType + required: true + schema: + type: string + - in: path + name: containerComponentId + required: true + schema: + type: string + - in: path + name: componentInstanceUniqueId + required: true + schema: + type: string + - in: path + name: capabilityType + required: true + schema: + type: string + - in: path + name: capabilityName + required: true + schema: + type: string + - in: path + name: ownerId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Instance capabilty property to update + required: true + responses: + "200": + description: Resource instance capabilty property updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Component/Component Instance/Capability - not found + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated property + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/properties: + get: + description: Get component instance properties + operationId: getInstancePropertiesById + parameters: + - in: path + name: containerComponentType + required: true + schema: + type: string + - in: path + name: containerComponentId + required: true + schema: + type: string + - in: path + name: componentInstanceUniqueId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Properties found + "403": + description: Restricted operation + "404": + description: Component/Component Instance - 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 component instance properties + tags: + - SDCE-2 APIs + ? /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/requirement/{capabilityType}/requirementName/{requirementName} + : put: + description: Update Instance Requirement + operationId: updateInstanceRequirement_1 + parameters: + - in: path + name: containerComponentType + required: true + schema: + type: string + - in: path + name: containerComponentId + required: true + schema: + type: string + - in: path + name: componentInstanceUniqueId + required: true + schema: + type: string + - in: path + name: capabilityType + required: true + schema: + type: string + - in: path + name: requirementName + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Instance capabilty requirement to update + required: true + responses: + "200": + description: Resource instance requirement updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "404": + description: Component/Component Instance/Requirement - not found + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated requirement + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy: + post: + description: Create service proxy + operationId: createServiceProxy + parameters: + - in: path + name: containerComponentId + required: true + schema: + type: string + - description: "valid values: resources / services" + in: path + name: containerComponentType + required: true + schema: + 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: + "201": + description: Service proxy created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + "409": + description: Service proxy 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 service proxy + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}: + delete: + description: Delete service proxy + operationId: deleteServiceProxy + parameters: + - in: path + name: containerComponentId + required: true + schema: + type: string + - in: path + name: serviceProxyId + required: true + schema: + type: string + - description: "valid values: resources / services / products" + in: path + name: containerComponentType + required: true + schema: + type: string + enum: + - resources + - services + responses: + "201": + description: Service proxy deleted + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + 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 delete service proxy + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}/changeVersion/{newServiceId}: + post: + description: Update service proxy with new version + operationId: changeServiceProxyVersion + parameters: + - in: path + name: containerComponentId + required: true + schema: + type: string + - in: path + name: serviceProxyId + required: true + schema: + type: string + - description: "valid values: resources / services" + in: path + name: containerComponentType + required: true + schema: + type: string + enum: + - resources + - services + responses: + "201": + description: Service proxy created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + type: object + properties: + allowedMethods: + type: array + items: + type: string + uniqueItems: true + cookies: + type: object + additionalProperties: + type: object + properties: + comment: + type: string + domain: + type: string + expiry: + type: string + format: date-time + httpOnly: + type: boolean + maxAge: + type: integer + format: int32 + name: + type: string + path: + type: string + secure: + type: boolean + value: + type: string + version: + type: integer + format: int32 + date: + type: string + format: date-time + entity: + type: object + entityTag: + type: object + properties: + value: + type: string + weak: + type: boolean + headers: + type: object + additionalProperties: + type: array + items: + type: object + language: + type: object + properties: + country: + type: string + displayCountry: + type: string + displayLanguage: + type: string + displayName: + type: string + displayScript: + type: string + displayVariant: + type: string + extensionKeys: + type: array + items: + type: string + uniqueItems: true + iso3Country: + type: string + iso3Language: + type: string + language: + type: string + script: + type: string + unicodeLocaleAttributes: + type: array + items: + type: string + uniqueItems: true + unicodeLocaleKeys: + type: array + items: + type: string + uniqueItems: true + variant: + type: string + lastModified: + type: string + format: date-time + length: + type: integer + format: int32 + links: + type: array + items: + type: object + properties: + params: + type: object + additionalProperties: + type: string + rel: + type: string + rels: + type: array + items: + type: string + title: + type: string + type: + type: string + uri: + type: string + format: uri + uriBuilder: + type: object + uniqueItems: true + location: + type: string + format: uri + mediaType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + metadata: + type: object + additionalProperties: + type: array + items: + type: object + status: + type: integer + format: int32 + statusInfo: + type: object + properties: + family: + type: string + enum: + - INFORMATIONAL + - SUCCESSFUL + - REDIRECTION + - CLIENT_ERROR + - SERVER_ERROR + - OTHER + reasonPhrase: + type: string + statusCode: + type: integer + format: int32 + stringHeaders: + type: object + additionalProperties: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated service proxy + tags: + - SDCE-2 APIs + /v1/catalog/{containerComponentType}/{serviceId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}: + put: + description: Update Group Instance Property Values + operationId: updateGroupInstancePropertyValues + parameters: + - in: path + name: serviceId + required: true + schema: + type: string + - in: path + name: componentInstanceId + required: true + schema: + type: string + - in: path + name: groupInstanceId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Group instance object to be Updated + required: true + responses: + "200": + description: Group Instance Property Values Updated + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Service' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns updated group instance + tags: + - SDCE-2 APIs + /v1/catalogUpdateTime: + get: + description: Retrieve previus and current catalog update time + operationId: getCatalogUpdateTime + parameters: + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Retrieve previus and current catalog update time + 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: Retrieve previus and current catalog update time + tags: + - SDCE-2 APIs + /v1/categories/{componentType}: + get: + description: Retrieve the list of all resource/service/product categories/sub-categories/groupings + operationId: getComponentCategories + parameters: + - description: allowed values are resources / services/ products + in: path + name: componentType + required: true + schema: + type: string + enum: + - resources + - services + - products + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Returns categories Ok + "400": + description: Invalid component type + "403": + description: Missing information + "409": + description: Restricted operation + "500": + description: Internal Server Error + 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: Retrieve the list of all resource/service/product categories/sub-categories/groupings. + tags: + - SDCE-2 APIs + /v1/category/{componentType}: + post: + description: Create new component category + operationId: createComponentCategory + parameters: + - description: allowed values are resources /services / products + in: path + name: componentType + required: true + schema: + type: string + enum: + - resources + - services + - products + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Category to be created + required: true + responses: + "201": + description: Category created + "400": + description: Invalid category data + "403": + description: USER_ID header is missing + "409": + description: Category already exists / User not permitted to perform the + action + "500": + description: General Error + servers: + - url: /sdc2/rest + variables: {} + summary: Create new component category + tags: + - SDCE-2 APIs + /v1/category/{componentType}/{categoryId}/subCategory: + post: + description: Create new component sub-category + operationId: createComponentSubCategory + parameters: + - description: allowed values are resources / products + in: path + name: componentType + required: true + schema: + type: string + enum: + - resources + - products + - description: Parent category unique ID + in: path + name: categoryId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: "Subcategory to be created. \ne.g. {\"name\":\"Resource-subcat\"\ + }" + required: true + responses: + "201": + description: Subcategory created + "400": + description: Invalid subcategory data + "403": + description: USER_ID header is missing + "404": + description: Parent category wasn't found + "409": + description: Subcategory already exists / User not permitted to perform + the action + "500": + description: General Error + servers: + - url: /sdc2/rest + variables: {} + summary: Create new component sub-category for existing category + tags: + - SDCE-2 APIs + /v1/category/{componentType}/{categoryId}/subCategory/{subCategoryId}/grouping: + post: + description: Create new component grouping + operationId: createComponentGrouping + parameters: + - description: allowed values are products + in: path + name: componentType + required: true + schema: + type: string + enum: + - products + - description: Parent category unique ID + in: path + name: categoryId + required: true + schema: + type: string + - description: Parent sub-category unique ID + in: path + name: subCategoryId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Subcategory to be created + required: true + responses: + "201": + description: Grouping created + "400": + description: Invalid grouping data + "403": + description: USER_ID header is missing + "404": + description: Parent category or subcategory were not found + "409": + description: Grouping already exists / User not permitted to perform the + action + "500": + description: General Error + servers: + - url: /sdc2/rest + variables: {} + summary: Create new component grouping for existing sub-category + 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 + operationId: deleteComponentCategory + parameters: + - in: path + name: categoryUniqueId + required: true + schema: + type: string + - in: path + name: componentType + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "204": + description: Category deleted + "403": + description: USER_ID header is missing + "404": + description: Category not found + "409": + description: User not permitted to perform the action + "500": + description: General Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Category' + servers: + - url: /sdc2/rest + variables: {} + summary: Delete component category + tags: + - SDCE-2 APIs + /v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}: + delete: + description: Delete component category + operationId: deleteComponentSubCategory + parameters: + - in: path + name: categoryUniqueId + required: true + schema: + type: string + - in: path + name: subCategoryUniqueId + required: true + schema: + type: string + - in: path + name: componentType + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "204": + description: Category deleted + "403": + description: USER_ID header is missing + "404": + description: Category not found + "409": + description: User not permitted to perform the action + "500": + description: General Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Category' + servers: + - url: /sdc2/rest + variables: {} + summary: Delete component category + tags: + - SDCE-2 APIs + /v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}/grouping/{groupingUniqueId}: + delete: + description: Delete component category + operationId: deleteComponentGrouping + parameters: + - in: path + name: categoryUniqueId + required: true + schema: + type: string + - in: path + name: subCategoryUniqueId + required: true + schema: + type: string + - in: path + name: groupingUniqueId + required: true + schema: + type: string + - in: path + name: componentType + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "204": + description: Category deleted + "403": + description: USER_ID header is missing + "404": + description: Category not found + "409": + description: User not permitted to perform the action + "500": + description: General Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Category' + servers: + - url: /sdc2/rest + variables: {} + summary: Delete component category + tags: + - SDCE-2 APIs + /v1/consumers: + post: + description: Consumer credentials + operationId: createConsumer + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: Consumer Object to be created + required: true + responses: + "201": + description: Consumer credentials created + "400": + description: Invalid content / Missing content + "403": + description: Restricted operation + 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 ECOMP consumer credentials + tags: + - SDCE-2 APIs + /v1/consumers/{consumerId}: + delete: + description: Deletes Consumer + operationId: deleteConsumer + parameters: + - in: path + name: consumerId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "204": + description: Consumer deleted + "403": + description: Restricted operation + "404": + description: Consumer not found + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsumerDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns deleted consumer according to ConsumerID + tags: + - SDCE-2 APIs + get: + description: Retrieve Consumer + operationId: getConsumer + parameters: + - in: path + name: consumerId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Consumer found + "403": + description: Restricted operation + "404": + description: Consumer not found + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsumerDefinition' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns consumer according to ConsumerID + tags: + - SDCE-2 APIs + /v1/ecompPortalMenu: + get: + description: Retrieve ecomp portal menu - MOC + operationId: getListOfCsars + responses: + "200": + description: Retrieve ecomp portal menu + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + servers: + - url: /sdc2/rest + variables: {} + summary: Retrieve ecomp portal menu + tags: + - SDCE-2 APIs + /v1/followed: + get: + description: Retrieve all followed + operationId: getFollowedResourcesServices + parameters: + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Returns followed Ok + "404": + description: User not found + "500": + description: Internal Server Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + servers: + - url: /sdc2/rest + variables: {} + summary: Retrieve all followed + tags: + - SDCE-2 APIs + /v1/inactiveComponents/{componentType}: + delete: + operationId: deleteMarkedResources + parameters: + - in: path + name: componentType + required: true + schema: + type: string + responses: + default: + content: + '*/*': {} + description: default response + servers: + - url: /sdc2/rest + variables: {} + tags: + - SDCE-2 APIs + /v1/propertyScopes: + get: + description: Retrieve all propertyScopes + operationId: getPropertyScopes + parameters: + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Returns propertyScopes Ok + "404": + description: No propertyScopes were found + "500": + description: Internal Server Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + servers: + - url: /sdc2/rest + variables: {} + summary: Retrieve all propertyScopes + tags: + - SDCE-2 APIs + /v1/screen: + get: + description: Retrieve catalog resources and services + operationId: getCatalogComponents + parameters: + - in: header + name: USER_ID + schema: + type: string + - in: query + name: excludeTypes + schema: + type: array + items: + type: string + enum: + - PRODUCT + - SERVICE + - VF + - VFC + - CP + - VL + - Configuration + - VFCMT + - CVFC + - PNF + - CR + - ServiceProxy + - ServiceSubstitution + responses: + "200": + description: Returns resources and services Ok + "404": + description: User not found + "500": + description: Internal Server Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + servers: + - url: /sdc2/rest + variables: {} + summary: Retrieve catalog resources and services + tags: + - SDCE-2 APIs + /v1/setup/ui: + get: + description: "Retrieve all artifactTypes, ui configuration and sdc version" + operationId: getConfCategoriesAndVersion_1 + parameters: + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: "Returns artifactTypes, ui configuration and sdc version Ok" + "404": + description: No artifactTypes were found/no ui configuration were found/no + sdc version were found + "500": + description: Internal Server Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + servers: + - url: /sdc2/rest + variables: {} + summary: "Retrieve all artifactTypes, ui configuration and sdc version" + tags: + - SDCE-2 APIs + /v1/tags: + get: + description: Retrieve all tags + operationId: getTags + parameters: + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Returns tags Ok + "404": + description: No tags were found + "500": + description: Internal Server Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + servers: + - url: /sdc2/rest + variables: {} + summary: Retrieve all tags + tags: + - SDCE-2 APIs + /v1/user: + post: + description: add user + operationId: createUser + parameters: + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: json describe the user + required: true + responses: + "201": + description: New user created + "400": + description: Invalid Content. + "403": + description: Missing information + "405": + description: Method Not Allowed + "409": + description: User already exists + "500": + description: Internal Server Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + servers: + - url: /sdc2/rest + variables: {} + summary: Provision new user + tags: + - SDCE-2 APIs + /v1/user/admins: + get: + description: retrieve all administrators + operationId: getAdminsUser + responses: + "200": + description: Returns user Ok + "405": + description: Method Not Allowed + "500": + description: Internal Server Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns all administrators + tags: + - SDCE-2 APIs + /v1/user/authorize: + get: + description: authorize + operationId: authorize + parameters: + - in: header + name: USER_ID + schema: + type: string + - in: header + name: HTTP_CSP_FIRSTNAME + schema: + type: string + - in: header + name: HTTP_CSP_LASTNAME + schema: + type: string + - in: header + name: HTTP_CSP_EMAIL + schema: + type: string + responses: + "200": + description: Returns user Ok + "403": + description: Restricted Access + "500": + description: Internal Server Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + servers: + - url: /sdc2/rest + variables: {} + summary: authorize user + tags: + - SDCE-2 APIs + /v1/user/users: + get: + description: Retrieve the list of all active ASDC users or only group of users + having specific roles. + operationId: getUsersList + parameters: + - description: 'Any active user''s USER_ID ' + in: header + name: USER_ID + schema: + type: string + - description: "TESTER,DESIGNER,PRODUCT_STRATEGIST,OPS,PRODUCT_MANAGER,GOVERNOR,\ + \ ADMIN OR all users by not typing anything" + in: query + name: roles + schema: + type: string + responses: + "200": + description: Returns users Ok + "204": + description: No provisioned ASDC users of requested role + "400": + description: Missing content + "403": + description: Restricted Access + "500": + description: Internal Server Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + servers: + - url: /sdc2/rest + variables: {} + summary: "Returns list of users with the specified roles, or all of users in\ + \ the case of empty 'roles' header" + tags: + - SDCE-2 APIs + /v1/user/{userId}: + delete: + description: delete user + operationId: deActivateUser + parameters: + - description: userId of user to get + in: path + name: userId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + "200": + description: Update deleted OK + "400": + description: Invalid Content. + "403": + description: Missing information + "404": + description: User not found + "405": + description: Method Not Allowed + "409": + description: Restricted operation + "500": + description: Internal Server Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + servers: + - url: /sdc2/rest + variables: {} + summary: Delete user + tags: + - SDCE-2 APIs + get: + description: retrieve user details + operationId: get + parameters: + - description: userId of user to get + in: path + name: userId + required: true + schema: + type: string + responses: + "200": + description: Returns user Ok + "404": + description: User not found + "405": + description: Method Not Allowed + "500": + description: Internal Server Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + servers: + - url: /sdc2/rest + variables: {} + summary: Returns user details according to userId + tags: + - SDCE-2 APIs + /v1/user/{userId}/role: + get: + description: retrieve user role + operationId: getRole + parameters: + - description: userId of user to get + in: path + name: userId + required: true + schema: + type: string + responses: + "200": + description: Returns user role Ok + "404": + description: User not found + "405": + description: Method Not Allowed + "500": + description: Internal Server Error + default: + content: + application/json: + schema: + type: array + items: + type: string + servers: + - url: /sdc2/rest + variables: {} + summary: Returns user role according to userId + tags: + - SDCE-2 APIs + post: + description: update user role + operationId: updateUserRole + parameters: + - description: userId of user to get + in: path + name: userId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserRole' + description: json describe the update role + required: true + responses: + "200": + description: Update user OK + "400": + description: Invalid Content. + "403": + description: Missing information/Restricted operation + "404": + description: User not found + "405": + description: Method Not Allowed + "409": + description: User already exists + "500": + description: Internal Server Error + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + servers: + - url: /sdc2/rest + variables: {} + summary: Update user role + tags: + - SDCE-2 APIs +components: + schemas: + AdditionalInfoParameterInfo: + type: object + properties: + empty: + type: boolean + key: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + uniqueId: + type: string + value: + type: string + version: + type: string + AdditionalInformationDefinition: + type: object + properties: + creationTime: + type: integer + format: int64 + empty: + type: boolean + lastCreatedCounter: + type: integer + format: int32 + modificationTime: + type: integer + format: int64 + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parameters: + type: array + items: + $ref: '#/components/schemas/AdditionalInfoParameterInfo' + parentUniqueId: + type: string + type: + type: string + uniqueId: + type: string + version: + type: string + Annotation: + type: object + properties: + description: + type: string + name: + type: string + properties: + type: array + items: + $ref: '#/components/schemas/PropertyDataDefinition' + type: + type: string + ApplicationL1CacheCatalogInfo: + type: object + properties: + enabled: + type: boolean + productsSizeInCache: + type: integer + format: int32 + resourcesSizeInCache: + type: integer + format: int32 + servicesSizeInCache: + type: integer + format: int32 + ApplicationL1CacheConfig: + type: object + properties: + datatypes: + $ref: '#/components/schemas/ApplicationL1CacheInfo' + ApplicationL1CacheInfo: + type: object + properties: + enabled: + type: boolean + firstRunDelay: + type: integer + format: int32 + pollIntervalInSec: + type: integer + format: int32 + ApplicationL2CacheConfig: + type: object + properties: + catalogL1Cache: + $ref: '#/components/schemas/ApplicationL1CacheCatalogInfo' + enabled: + type: boolean + queue: + $ref: '#/components/schemas/QueueInfo' + ArtifactConfiguration: + type: object + properties: + acceptedTypes: + type: array + items: + type: string + categories: + type: array + items: + type: string + enum: + - INFORMATIONAL + - DEPLOYMENT + - LIFE_CYCLE + - SERVICE_API + - TOSCA + - OTHER + componentTypes: + type: array + items: + type: string + enum: + - RESOURCE + - SERVICE + - RESOURCE_INSTANCE + - SERVICE_INSTANCE + resourceTypes: + type: array + items: + type: string + type: + type: string + ArtifactDataDefinition: + type: object + properties: + apiUrl: + type: string + artifactChecksum: + type: string + artifactCreator: + type: string + artifactDisplayName: + type: string + artifactGroupType: + type: string + enum: + - INFORMATIONAL + - DEPLOYMENT + - LIFE_CYCLE + - SERVICE_API + - TOSCA + - OTHER + artifactLabel: + type: string + artifactName: + type: string + artifactRef: + type: string + artifactRepository: + type: string + artifactType: + type: string + artifactUUID: + type: string + artifactVersion: + type: string + creationDate: + type: integer + format: int64 + creatorFullName: + type: string + description: + type: string + duplicated: + type: boolean + empty: + type: boolean + esId: + type: string + generated: + type: boolean + generatedFromId: + type: string + heatEnvType: + type: boolean + heatParameters: + type: array + items: + $ref: '#/components/schemas/HeatParameterDataDefinition' + heatParamsUpdateDate: + type: integer + format: int64 + isFromCsar: + type: boolean + lastUpdateDate: + type: integer + format: int64 + mandatory: + type: boolean + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + payloadUpdateDate: + type: integer + format: int64 + properties: + type: array + items: + $ref: '#/components/schemas/PropertyDataDefinition' + requiredArtifacts: + type: array + items: + type: string + serviceApi: + type: boolean + timeout: + type: integer + format: int32 + type: + type: string + uniqueId: + type: string + updaterFullName: + type: string + userIdCreator: + type: string + userIdLastUpdater: + type: string + version: + type: string + ArtifactDefinition: + type: object + properties: + apiUrl: + type: string + artifactChecksum: + type: string + artifactCreator: + type: string + artifactDisplayName: + type: string + artifactGroupType: + type: string + enum: + - INFORMATIONAL + - DEPLOYMENT + - LIFE_CYCLE + - SERVICE_API + - TOSCA + - OTHER + artifactLabel: + type: string + artifactName: + type: string + artifactRef: + type: string + artifactRepository: + type: string + artifactType: + type: string + artifactUUID: + type: string + artifactVersion: + type: string + creationDate: + type: integer + format: int64 + creatorFullName: + type: string + description: + type: string + duplicated: + type: boolean + empty: + type: boolean + esId: + type: string + generated: + type: boolean + generatedFromId: + type: string + heatEnvType: + type: boolean + heatParamUpdated: + type: boolean + heatParameters: + type: array + items: + $ref: '#/components/schemas/HeatParameterDataDefinition' + heatParamsUpdateDate: + type: integer + format: int64 + isFromCsar: + type: boolean + lastUpdateDate: + type: integer + format: int64 + listHeatParameters: + type: array + items: + $ref: '#/components/schemas/HeatParameterDefinition' + mandatory: + type: boolean + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + payload: + type: array + items: + type: string + format: byte + writeOnly: true + payloadData: + type: array + items: + type: string + format: byte + payloadUpdateDate: + type: integer + format: int64 + properties: + type: array + items: + $ref: '#/components/schemas/PropertyDataDefinition' + requiredArtifacts: + type: array + items: + type: string + serviceApi: + type: boolean + timeout: + type: integer + format: int32 + type: + type: string + uniqueId: + type: string + updaterFullName: + type: string + userIdCreator: + type: string + userIdLastUpdater: + type: string + version: + type: string + AttributeDefinition: + type: object + properties: + attributeId: + type: string + defaultValue: + type: string + definition: + type: boolean + description: + type: string + empty: + type: boolean + entry_schema: + $ref: '#/components/schemas/EntrySchema' + getOutputAttribute: + type: boolean + getOutputValues: + type: array + items: + $ref: '#/components/schemas/GetOutputValueDataDefinition' + get_default: + type: object + instanceUniqueId: + type: string + model: + type: string + name: + type: string + outputId: + type: string + outputPath: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentUniqueId: + type: string + schema: + $ref: '#/components/schemas/SchemaDefinition' + schemaType: + type: string + status: + type: string + type: + type: string + uniqueId: + type: string + value: + type: string + version: + type: string + BasicAuthConfig: + type: object + properties: + enabled: + type: boolean + excludedUrls: + type: string + userName: + type: string + userPass: + type: string + BeMonitoringConfig: + type: object + properties: + enabled: + type: boolean + isProxy: + type: boolean + probeIntervalInSeconds: + type: integer + format: int32 + CINodeFilterDataDefinition: + type: object + properties: + capabilities: + $ref: '#/components/schemas/ListDataDefinitionRequirementNodeFilterCapabilityDataDefinition' + empty: + type: boolean + id: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + properties: + $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition' + tosca_id: + type: object + type: + type: string + version: + type: string + CadiFilterParams: + type: object + properties: + aafLocateUrl: + type: string + aaf_env: + type: string + aaf_id: + type: string + aaf_password: + type: string + aaf_url: + type: string + aft_ENVIRONMENT: + type: string + aft_LATITUDE: + type: string + aft_LONGITUDE: + type: string + cadiX509Issuers: + type: string + cadi_keyfile: + type: string + cadi_loglevel: + type: string + cadi_truststore: + type: string + cadi_truststore_password: + type: string + csp_domain: + type: string + hostname: + type: string + CapabilityDataDefinition: + type: object + properties: + capabilitySources: + type: array + items: + type: string + description: + type: string + empty: + type: boolean + external: + type: boolean + externalName: + type: string + leftOccurrences: + type: string + maxOccurrences: + type: string + minOccurrences: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + ownerName: + type: string + ownerType: + type: string + enum: + - GROUP + - COMPONENT_INSTANCE + - RESOURCE + parentName: + type: string + path: + type: array + items: + type: string + previousName: + type: string + source: + type: string + type: + type: string + uniqueId: + type: string + validSourceTypes: + type: array + items: + type: string + version: + type: string + CapabilityDefinition: + type: object + properties: + capabilitySources: + type: array + items: + type: string + description: + type: string + empty: + type: boolean + external: + type: boolean + externalName: + type: string + leftOccurrences: + type: string + maxOccurrences: + type: string + minOccurrences: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + ownerName: + type: string + ownerType: + type: string + enum: + - GROUP + - COMPONENT_INSTANCE + - RESOURCE + ownerTypeIfEmpty: + type: string + enum: + - GROUP + - COMPONENT_INSTANCE + - RESOURCE + writeOnly: true + parentName: + type: string + path: + type: array + items: + type: string + previousName: + type: string + properties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceProperty' + source: + type: string + type: + type: string + uniqueId: + type: string + validSourceTypes: + type: array + items: + type: string + version: + type: string + CapabilityRequirementRelationship: + type: object + properties: + capability: + $ref: '#/components/schemas/CapabilityDataDefinition' + operations: + type: array + items: + $ref: '#/components/schemas/OperationUi' + relation: + $ref: '#/components/schemas/RelationshipInfo' + requirement: + $ref: '#/components/schemas/RequirementDataDefinition' + CassandrConfig: + type: object + properties: + authenticate: + type: boolean + cassandraHosts: + type: array + items: + type: string + cassandraPort: + type: integer + format: int32 + keySpaces: + type: array + items: + $ref: '#/components/schemas/KeyspaceConfig' + localDataCenter: + type: string + maxWaitSeconds: + type: integer + format: int32 + password: + type: string + reconnectTimeout: + type: integer + format: int64 + socketConnectTimeout: + type: integer + format: int32 + socketReadTimeout: + type: integer + format: int32 + ssl: + type: boolean + truststorePassword: + type: string + truststorePath: + type: string + username: + type: string + CatalogComponent: + type: object + properties: + categories: + type: array + items: + $ref: '#/components/schemas/CategoryDefinition' + categoryNormalizedName: + type: string + componentType: + type: string + enum: + - RESOURCE + - SERVICE + - RESOURCE_INSTANCE + - PRODUCT + - SERVICE_INSTANCE + description: + type: string + distributionStatus: + type: string + icon: + type: string + invariantUUID: + type: string + isHighestVersion: + type: boolean + lastUpdateDate: + type: integer + format: int64 + lastUpdaterUserId: + type: string + lifecycleState: + type: string + model: + type: string + name: + type: string + resourceType: + type: string + subCategoryNormalizedName: + type: string + systemName: + type: string + tags: + type: array + items: + type: string + uniqueId: + type: string + uuid: + type: string + version: + type: string + Category: + type: object + properties: + name: + type: string + CategoryBaseTypeConfig: + type: object + properties: + baseTypes: + type: array + items: + type: string + defaultBaseType: + type: string + required: + type: boolean + CategoryDefinition: + type: object + properties: + displayName: + type: string + empty: + type: boolean + icons: + type: array + items: + type: string + metadataKeys: + type: array + items: + $ref: '#/components/schemas/MetadataKeyDataDefinition' + models: + type: array + items: + type: string + name: + type: string + normalizedName: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + subcategories: + type: array + items: + $ref: '#/components/schemas/SubCategoryDefinition' + type: + type: string + uniqueId: + type: string + useServiceSubstitutionForNestedServices: + type: boolean + version: + type: string + CleanComponentsConfiguration: + type: object + properties: + cleanIntervalInMinutes: + type: integer + format: int64 + componentsToClean: + type: array + items: + type: string + ComponentInstance: + type: object + properties: + actualComponentUid: + type: string + artifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + attributeValueCounter: + type: integer + format: int32 + attributes: + type: array + items: + $ref: '#/components/schemas/AttributeDefinition' + capabilities: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/CapabilityDefinition' + componentMetadataForSupportLog: + type: object + additionalProperties: + type: string + componentName: + type: string + componentUid: + type: string + componentVersion: + type: string + createdFrom: + type: string + enum: + - UI + - CSAR + createdFromCsar: + type: boolean + creationTime: + type: integer + format: int64 + customizationUUID: + type: string + deploymentArtifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + description: + type: string + directives: + type: array + items: + type: string + empty: + type: boolean + groupInstances: + type: array + items: + $ref: '#/components/schemas/GroupInstance' + icon: + type: string + inputValueCounter: + type: integer + format: int32 + inputs: + type: array + items: + $ref: '#/components/schemas/InputDefinition' + instanceCount: + type: string + interfaces: + type: object + additionalProperties: + type: object + invariantName: + type: string + isProxy: + type: boolean + maxOccurrences: + type: string + minOccurrences: + type: string + modificationTime: + type: integer + format: int64 + name: + type: string + nodeFilter: + $ref: '#/components/schemas/CINodeFilterDataDefinition' + normalizedName: + type: string + originArchived: + type: boolean + originType: + type: string + enum: + - PRODUCT + - SERVICE + - VF + - VFC + - CP + - VL + - Configuration + - VFCMT + - CVFC + - PNF + - CR + - ServiceProxy + - ServiceSubstitution + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + posX: + type: string + posY: + type: string + properties: + type: array + items: + $ref: '#/components/schemas/PropertyDefinition' + propertyValueCounter: + type: integer + format: int32 + requirements: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/RequirementDefinition' + serviceSubstitution: + type: boolean + sourceModelInvariant: + type: string + sourceModelName: + type: string + sourceModelUid: + type: string + sourceModelUuid: + type: string + toscaArtifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ToscaArtifactDataDefinition' + toscaComponentName: + type: string + type: + type: string + uniqueId: + type: string + version: + type: string + ComponentInstanceAttribute: + type: object + properties: + attributeId: + type: string + componentInstanceId: + type: string + componentInstanceName: + type: string + defaultValue: + type: string + definition: + type: boolean + description: + type: string + empty: + type: boolean + entry_schema: + $ref: '#/components/schemas/EntrySchema' + getOutputAttribute: + type: boolean + getOutputValues: + type: array + items: + $ref: '#/components/schemas/GetOutputValueDataDefinition' + get_default: + type: object + instanceUniqueId: + type: string + model: + type: string + name: + type: string + outputId: + type: string + outputPath: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentUniqueId: + type: string + path: + type: array + items: + type: string + rules: + type: array + items: + $ref: '#/components/schemas/PropertyRule' + schema: + $ref: '#/components/schemas/SchemaDefinition' + schemaType: + type: string + status: + type: string + type: + type: string + uniqueId: + type: string + value: + type: string + valueUniqueUid: + type: string + version: + type: string + 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: + annotations: + type: array + items: + $ref: '#/components/schemas/Annotation' + annotationsToInput: + type: array + items: + $ref: '#/components/schemas/Annotation' + writeOnly: true + componentInstanceId: + type: string + componentInstanceName: + type: string + constraints: + type: array + items: + $ref: '#/components/schemas/PropertyConstraint' + 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 + label: + type: string + mappedToComponentProperty: + type: boolean + metadata: + type: object + additionalProperties: + type: string + model: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentPropertyType: + type: string + parentUniqueId: + type: string + password: + type: boolean + path: + type: array + items: + type: string + properties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceProperty' + propertyConstraints: + type: array + items: + type: string + propertyId: + type: string + required: + type: boolean + rules: + type: array + items: + $ref: '#/components/schemas/PropertyRule' + schema: + $ref: '#/components/schemas/SchemaDefinition' + schemaProperty: + $ref: '#/components/schemas/PropertyDataDefinition' + schemaType: + type: string + status: + type: string + subPropertyInputPath: + type: string + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + type: string + valueUniqueUid: + type: string + version: + type: string + ComponentInstanceInterface: + type: object + properties: + creationDate: + type: integer + format: int64 + definition: + type: boolean + derivedFrom: + type: string + description: + type: string + empty: + type: boolean + inputs: + type: object + additionalProperties: + $ref: '#/components/schemas/InputDataDefinition' + interfaceId: + type: string + interfaceInstanceDataDefinition: + $ref: '#/components/schemas/InterfaceInstanceDataDefinition' + lastUpdateDate: + type: integer + format: int64 + model: + type: string + operations: + type: object + additionalProperties: + $ref: '#/components/schemas/OperationDataDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + toscaResourceName: + type: string + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + version: + type: string + ComponentInstanceOutput: + type: object + properties: + attribute: + $ref: '#/components/schemas/ComponentInstanceAttribute' + attributeId: + type: string + componentInstanceId: + type: string + componentInstanceName: + type: string + defaultValue: + type: string + definition: + type: boolean + description: + type: string + empty: + type: boolean + entry_schema: + $ref: '#/components/schemas/EntrySchema' + getOutputAttribute: + type: boolean + getOutputValues: + type: array + items: + $ref: '#/components/schemas/GetOutputValueDataDefinition' + get_default: + type: object + instanceUniqueId: + type: string + model: + type: string + name: + type: string + outputId: + type: string + outputPath: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentUniqueId: + type: string + path: + type: array + items: + type: string + rules: + type: array + items: + $ref: '#/components/schemas/PropertyRule' + schema: + $ref: '#/components/schemas/SchemaDefinition' + schemaType: + type: string + status: + type: string + type: + type: string + uniqueId: + type: string + value: + type: string + valueUniqueUid: + type: string + version: + type: string + ComponentInstanceProperty: + type: object + properties: + annotations: + type: array + items: + $ref: '#/components/schemas/Annotation' + componentInstanceId: + type: string + componentInstanceName: + type: string + constraints: + type: array + items: + $ref: '#/components/schemas/PropertyConstraint' + 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 + label: + type: string + mappedToComponentProperty: + type: boolean + metadata: + type: object + additionalProperties: + type: string + model: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentPropertyType: + type: string + parentUniqueId: + type: string + password: + type: boolean + path: + type: array + items: + type: string + propertyConstraints: + type: array + items: + type: string + propertyId: + type: string + required: + type: boolean + rules: + type: array + items: + $ref: '#/components/schemas/PropertyRule' + schema: + $ref: '#/components/schemas/SchemaDefinition' + schemaProperty: + $ref: '#/components/schemas/PropertyDataDefinition' + schemaType: + type: string + status: + type: string + subPropertyInputPath: + type: string + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + type: string + valueUniqueUid: + type: string + version: + type: string + Configuration: + type: object + properties: + aafAuthNeeded: + type: boolean + aafNamespace: + type: string + additionalInformationMaxNumberOfKeys: + type: integer + format: int32 + appVersion: + type: string + applicationL1Cache: + $ref: '#/components/schemas/ApplicationL1CacheConfig' + applicationL2Cache: + $ref: '#/components/schemas/ApplicationL2CacheConfig' + artifactGeneratorConfig: + type: string + artifacts: + type: array + items: + $ref: '#/components/schemas/ArtifactConfiguration' + artifactsIndex: + type: string + authCookie: + $ref: '#/components/schemas/CookieConfig' + autoHealingOwner: + type: string + basicAuth: + $ref: '#/components/schemas/BasicAuthConfig' + beContext: + type: string + beFqdn: + type: string + beHttpPort: + type: integer + format: int32 + beProtocol: + type: string + beSslPort: + type: integer + format: int32 + cadiFilterParams: + $ref: '#/components/schemas/CadiFilterParams' + cassandraConfig: + $ref: '#/components/schemas/CassandrConfig' + cleanComponentsConfiguration: + $ref: '#/components/schemas/CleanComponentsConfiguration' + componentAllowedInstanceTypes: + type: object + additionalProperties: + type: object + additionalProperties: + type: array + items: + type: string + componentInstanceCounterDelimiter: + type: string + consumerBusinessLogic: + type: boolean + csarFormat: + $ref: '#/components/schemas/CsarFormat' + dataValidatorFilterExcludedUrls: + type: string + defaultImports: + type: array + items: + type: object + additionalProperties: + type: object + additionalProperties: + type: string + definedResourceNamespace: + type: array + items: + type: string + deleteLockTimeoutInSeconds: + type: integer + format: int32 + deploymentResourceArtifacts: + type: object + additionalProperties: + type: object + deploymentResourceInstanceArtifacts: + type: object + additionalProperties: + type: object + directives: + type: array + items: + type: string + disableAudit: + type: boolean + dmaapConsumerConfiguration: + $ref: '#/components/schemas/DmaapConsumerConfiguration' + dmaapProducerConfiguration: + $ref: '#/components/schemas/DmaapProducerConfiguration' + dmeConfiguration: + $ref: '#/components/schemas/DmeConfiguration' + ecompPortal: + $ref: '#/components/schemas/EcompPortalConfig' + enableAutoHealing: + type: boolean + environmentContext: + $ref: '#/components/schemas/EnvironmentContext' + excludeResourceCategory: + type: array + items: + type: string + excludeResourceType: + type: array + items: + type: string + excludeServiceCategory: + type: array + items: + type: string + excludedGroupTypesMapping: + type: object + additionalProperties: + type: array + items: + type: string + uniqueItems: true + excludedPolicyTypesMapping: + type: object + additionalProperties: + type: array + items: + type: string + uniqueItems: true + externalCsarStore: + $ref: '#/components/schemas/ExternalCsarStore' + gabConfig: + type: array + items: + $ref: '#/components/schemas/GabConfig' + genericAssetNodeTypes: + type: object + additionalProperties: + type: string + globalCsarImports: + type: array + items: + type: string + healthStatusExclude: + type: array + items: + type: string + heatArtifactDeploymentTimeout: + $ref: '#/components/schemas/HeatDeploymentArtifactTimeout' + heatEnvArtifactFooter: + type: string + heatEnvArtifactHeader: + type: string + heatTranslatorPath: + type: string + identificationHeaderFields: + type: array + items: + type: string + informationalResourceArtifacts: + type: object + additionalProperties: + type: object + informationalServiceArtifacts: + type: object + additionalProperties: + type: object + janusGraphCfgFile: + type: string + janusGraphHealthCheckReadTimeout: + type: integer + format: int64 + janusGraphInMemoryGraph: + type: boolean + janusGraphLockTimeout: + type: integer + format: int64 + janusGraphMigrationKeySpaceCfgFile: + type: string + janusGraphReconnectIntervalInSeconds: + type: integer + format: int64 + licenseTypes: + type: array + items: + type: string + maxDeleteComponents: + type: integer + format: int32 + minToscaConformanceLevel: + type: string + neo4j: + type: object + additionalProperties: + type: object + onboarding: + $ref: '#/components/schemas/OnboardingConfig' + permittedAncestors: + type: string + protocols: + type: array + items: + type: string + released: + type: string + format: date-time + resourceNodeTypes: + type: object + additionalProperties: + type: object + additionalProperties: + type: string + resourceTypes: + type: array + items: + type: string + resourcesForUpgrade: + type: object + additionalProperties: + type: array + items: + type: string + serviceApiArtifacts: + type: object + additionalProperties: + type: object + serviceBaseNodeTypes: + type: object + additionalProperties: + $ref: '#/components/schemas/CategoryBaseTypeConfig' + skipUpgradeFailedVfs: + type: boolean + skipUpgradeVSPs: + type: boolean + startMigrationFrom: + type: integer + format: int32 + supportAllottedResourcesAndProxy: + type: boolean + switchoverDetector: + $ref: '#/components/schemas/SwitchoverDetectorConfig' + systemMonitoring: + $ref: '#/components/schemas/BeMonitoringConfig' + toscaArtifacts: + type: object + additionalProperties: + type: object + toscaConformanceLevel: + type: string + toscaFilesDir: + type: string + toscaValidators: + $ref: '#/components/schemas/ToscaValidatorsConfig' + uebHealthCheckReadTimeout: + type: integer + format: int64 + uebHealthCheckReconnectIntervalInSeconds: + type: integer + format: int64 + unLoggedUrls: + type: array + items: + type: string + users: + type: object + additionalProperties: + type: string + version: + type: string + vfModuleProperties: + type: object + additionalProperties: + $ref: '#/components/schemas/VfModuleProperty' + workloadContext: + type: string + Constraint: + type: object + properties: + equal: + type: object + greater_or_equal: + type: object + greater_than: + type: object + in_range: + type: array + items: + type: object + length: + type: integer + format: int32 + less_or_equal: + type: object + less_than: + type: object + max_length: + type: integer + format: int32 + min_length: + type: integer + format: int32 + pattern: + type: object + valid_values: + type: array + items: + type: object + ConsumerDefinition: + type: object + properties: + consumerDetailsLastupdatedtime: + type: integer + format: int64 + consumerLastAuthenticationTime: + type: integer + format: int64 + consumerName: + type: string + consumerPassword: + type: string + consumerSalt: + type: string + empty: + type: boolean + lastModfierAtuid: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + CookieConfig: + type: object + properties: + cookieName: + type: string + domain: + type: string + excludedUrls: + type: array + items: + type: string + httpOnly: + type: boolean + isHttpOnly: + type: boolean + writeOnly: true + maxSessionTimeOut: + type: integer + format: int64 + onboardingExcludedUrls: + type: array + items: + type: string + path: + type: string + redirectURL: + type: string + securityKey: + type: string + sessionIdleTimeOut: + type: integer + format: int64 + Credential: + type: object + properties: + password: + type: string + username: + type: string + Credentials: + type: object + properties: + accessKey: + type: string + secretKey: + type: string + CsarFormat: + type: object + properties: + defaultFormat: + type: string + DataTypeDataDefinition: + type: object + properties: + creationTime: + type: integer + format: int64 + derivedFromName: + type: string + description: + type: string + empty: + type: boolean + model: + type: string + modificationTime: + type: integer + format: int64 + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + propertiesData: + type: array + items: + $ref: '#/components/schemas/PropertyDataDefinition' + type: + type: string + uniqueId: + type: string + version: + type: string + DataTypeDefinition: + type: object + properties: + constraints: + type: array + items: + $ref: '#/components/schemas/PropertyConstraint' + creationTime: + type: integer + format: int64 + derivedFrom: + $ref: '#/components/schemas/DataTypeDefinition' + derivedFromName: + type: string + description: + type: string + empty: + type: boolean + 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' + propertiesData: + type: array + items: + $ref: '#/components/schemas/PropertyDataDefinition' + type: + type: string + uniqueId: + type: string + version: + type: string + DistributionStatusInfo: + type: object + properties: + errorReason: + type: string + omfComponentID: + type: string + status: + type: string + timestamp: + type: string + url: + type: string + DistributionStatusListResponse: + type: object + properties: + distributionStatusList: + type: array + items: + $ref: '#/components/schemas/DistributionStatusInfo' + DmaapConsumerConfiguration: + type: object + properties: + active: + type: boolean + aftDme2ClientIgnoreSslConfig: + type: boolean + aftDme2ClientKeystore: + type: string + aftDme2ClientKeystorePassword: + type: string + aftDme2ClientSslCertAlias: + type: string + aftDme2ConnectionTimeoutMs: + type: integer + format: int32 + aftDme2ReadTimeoutMs: + type: integer + format: int32 + aftDme2RoundtripTimeoutMs: + type: integer + format: int32 + aftDme2SslEnable: + type: boolean + aftEnvironment: + type: string + consumerGroup: + type: string + consumerId: + type: string + contenttype: + type: string + credential: + $ref: '#/components/schemas/Credential' + dme2TraceOn: + type: boolean + dme2preferredRouterFilePath: + type: string + environment: + type: string + hosts: + type: string + latitude: + type: number + format: double + limit: + type: integer + format: int32 + longitude: + type: number + format: double + partner: + type: string + pollingInterval: + type: integer + format: int32 + protocol: + type: string + routeOffer: + type: string + serviceName: + type: string + timeLimitForNotificationHandleMs: + type: integer + format: int32 + timeoutMs: + type: integer + format: int32 + topic: + type: string + version: + type: string + DmaapProducerConfiguration: + type: object + properties: + active: + type: boolean + aftDme2ClientIgnoreSslConfig: + type: boolean + aftDme2ClientKeystore: + type: string + aftDme2ClientKeystorePassword: + type: string + aftDme2ClientSslCertAlias: + type: string + aftDme2ConnectionTimeoutMs: + type: integer + format: int32 + aftDme2ReadTimeoutMs: + type: integer + format: int32 + aftDme2RoundtripTimeoutMs: + type: integer + format: int32 + aftDme2SslEnable: + type: boolean + aftEnvironment: + type: string + consumerGroup: + type: string + consumerId: + type: string + contenttype: + type: string + credential: + $ref: '#/components/schemas/Credential' + dme2TraceOn: + type: boolean + dme2preferredRouterFilePath: + type: string + environment: + type: string + hosts: + type: string + latitude: + type: number + format: double + limit: + type: integer + format: int32 + longitude: + type: number + format: double + partner: + type: string + pollingInterval: + type: integer + format: int32 + protocol: + type: string + routeOffer: + type: string + serviceName: + type: string + timeLimitForNotificationHandleMs: + type: integer + format: int32 + timeoutMs: + type: integer + format: int32 + topic: + type: string + version: + type: string + DmeConfiguration: + type: object + properties: + lookupUriFormat: + type: string + EcompPortalConfig: + type: object + properties: + defaultFunctionalMenu: + type: string + healthCheckUri: + type: string + host: + type: string + pollingInterval: + type: integer + format: int32 + port: + type: integer + format: int32 + protocol: + type: string + timeoutMs: + type: integer + format: int32 + Endpoint: + type: object + properties: + host: + type: string + port: + type: integer + format: int32 + secure: + type: boolean + EntrySchema: + type: object + properties: + constraints: + type: array + items: + $ref: '#/components/schemas/Constraint' + description: + type: string + type: + type: string + EnvironmentContext: + type: object + properties: + defaultValue: + type: string + validValues: + type: array + items: + type: string + ExternalCsarStore: + type: object + properties: + credentials: + $ref: '#/components/schemas/Credentials' + endpoint: + $ref: '#/components/schemas/Endpoint' + storageType: + type: string + tempPath: + type: string + uploadPartSize: + type: integer + format: int32 + FormDataContentDisposition: + type: object + properties: + creationDate: + type: string + format: date-time + fileName: + type: string + modificationDate: + type: string + format: date-time + name: + type: string + parameters: + type: object + additionalProperties: + type: string + readDate: + type: string + format: date-time + size: + type: integer + format: int64 + type: + type: string + ForwardingPathDataDefinition: + type: object + properties: + description: + type: string + destinationPortNumber: + type: string + empty: + type: boolean + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + pathElements: + $ref: '#/components/schemas/ListDataDefinitionForwardingPathElementDataDefinition' + protocol: + type: string + toscaResourceName: + type: string + type: + type: string + uniqueId: + type: string + version: + type: string + ForwardingPathElementDataDefinition: + type: object + properties: + empty: + type: boolean + fromCP: + type: string + fromCPOriginId: + type: string + fromNode: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + toCP: + type: string + toCPOriginId: + type: string + toNode: + type: string + type: + type: string + version: + type: string + GabConfig: + type: object + properties: + artifactType: + type: string + pathsAndNamesDefinitions: + type: array + items: + $ref: '#/components/schemas/PathsAndNamesDefinition' + GenericArtifactQueryInfo: + type: object + properties: + artifactUniqueId: + type: string + fields: + type: array + items: + type: string + uniqueItems: true + parentId: + type: string + GetInputValueDataDefinition: + type: object + properties: + empty: + type: boolean + getInputIndex: + $ref: '#/components/schemas/GetInputValueDataDefinition' + indexValue: + type: integer + format: int32 + inputId: + type: string + inputName: + type: string + inputType: + type: string + list: + type: boolean + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + propName: + type: string + type: + type: string + version: + type: string + GetOutputValueDataDefinition: + type: object + properties: + attribName: + type: string + empty: + type: boolean + getOutputIndex: + $ref: '#/components/schemas/GetOutputValueDataDefinition' + indexValue: + type: integer + format: int32 + list: + type: boolean + outputId: + type: string + outputName: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + GetPolicyValueDataDefinition: + type: object + properties: + origPropertyValue: + type: string + policyId: + type: string + propertyName: + type: string + GroupDefinition: + type: object + properties: + artifacts: + type: array + items: + type: string + artifactsUuid: + type: array + items: + type: string + capabilities: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/CapabilityDefinition' + createdFrom: + type: string + enum: + - UI + - CSAR + description: + type: string + empty: + type: boolean + groupUUID: + type: string + invariantName: + type: string + invariantUUID: + type: string + members: + type: object + additionalProperties: + type: string + name: + type: string + normalizedName: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + properties: + type: array + items: + $ref: '#/components/schemas/PropertyDataDefinition' + propertyValueCounter: + type: integer + format: int32 + type: + type: string + typeUid: + type: string + uniqueId: + type: string + userDefined: + type: boolean + version: + type: string + vspOriginated: + type: boolean + GroupInfo: + type: object + properties: + changePriorityBody: + type: string + changePriorityUrl: + type: string + GroupInstance: + type: object + properties: + artifacts: + type: array + items: + type: string + artifactsUuid: + type: array + items: + type: string + creationTime: + type: integer + format: int64 + customizationUUID: + type: string + description: + type: string + empty: + type: boolean + groupInstanceArtifacts: + type: array + items: + type: string + groupInstanceArtifactsUuid: + type: array + items: + type: string + groupName: + type: string + groupUUID: + type: string + groupUid: + type: string + invariantUUID: + type: string + modificationTime: + type: integer + format: int64 + name: + type: string + normalizedName: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + posX: + type: string + posY: + type: string + properties: + type: array + items: + $ref: '#/components/schemas/PropertyDataDefinition' + propertyValueCounter: + type: integer + format: int32 + type: + type: string + uniqueId: + type: string + version: + type: string + GroupProperty: + type: object + properties: + annotations: + type: array + items: + $ref: '#/components/schemas/Annotation' + constraints: + type: array + items: + $ref: '#/components/schemas/PropertyConstraint' + 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 + label: + type: string + mappedToComponentProperty: + type: boolean + metadata: + type: object + additionalProperties: + type: string + model: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentPropertyType: + type: string + parentUniqueId: + type: string + password: + type: boolean + 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 + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + type: string + valueUniqueUid: + type: string + version: + type: string + GroupTypeDefinition: + type: object + properties: + capabilities: + type: object + additionalProperties: + $ref: '#/components/schemas/CapabilityDefinition' + creationTime: + type: integer + format: int64 + derivedFrom: + type: string + description: + type: string + empty: + type: boolean + highestVersion: + type: boolean + icon: + type: string + members: + type: array + items: + 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' + type: + type: string + uniqueId: + type: string + version: + type: string + GroupingDefinition: + type: object + properties: + empty: + type: boolean + name: + type: string + normalizedName: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + uniqueId: + type: string + version: + type: string + HeatDeploymentArtifactTimeout: + type: object + properties: + defaultMinutes: + type: integer + format: int32 + maxMinutes: + type: integer + format: int32 + minMinutes: + type: integer + format: int32 + HeatParameterDataDefinition: + type: object + properties: + currentValue: + type: string + defaultValue: + type: string + description: + type: string + empty: + type: boolean + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + uniqueId: + type: string + version: + type: string + HeatParameterDefinition: + type: object + properties: + currentValue: + type: string + defaultValue: + type: string + description: + type: string + empty: + type: boolean + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + uniqueId: + type: string + version: + type: string + InputDataDefinition: + 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 + label: + type: string + mappedToComponentProperty: + type: boolean + metadata: + type: object + additionalProperties: + type: string + model: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentPropertyType: + type: string + parentUniqueId: + type: string + password: + type: boolean + 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 + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + type: string + version: + type: string + InputDefinition: + type: object + properties: + annotations: + type: array + items: + $ref: '#/components/schemas/Annotation' + annotationsToInput: + type: array + items: + $ref: '#/components/schemas/Annotation' + writeOnly: true + constraints: + type: array + items: + $ref: '#/components/schemas/PropertyConstraint' + 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 + inputs: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceInput' + instanceUniqueId: + type: string + isDeclaredListInput: + type: boolean + label: + type: string + mappedToComponentProperty: + type: boolean + metadata: + type: object + additionalProperties: + type: string + model: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentPropertyType: + type: string + parentUniqueId: + type: string + password: + type: boolean + properties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceProperty' + 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 + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + type: string + version: + type: string + InterfaceDefinition: + type: object + properties: + creationDate: + type: integer + format: int64 + definition: + type: boolean + derivedFrom: + type: string + description: + type: string + empty: + type: boolean + inputs: + type: object + additionalProperties: + $ref: '#/components/schemas/InputDataDefinition' + lastUpdateDate: + type: integer + format: int64 + model: + type: string + operations: + type: object + additionalProperties: + $ref: '#/components/schemas/OperationDataDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + toscaResourceName: + type: string + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + version: + type: string + InterfaceInstanceDataDefinition: + type: object + properties: + empty: + type: boolean + inputs: + type: object + additionalProperties: + type: object + operations: + type: object + additionalProperties: + $ref: '#/components/schemas/OperationInstance' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + KeyspaceConfig: + type: object + properties: + name: + type: string + replicationInfo: + type: array + items: + type: string + replicationStrategy: + type: string + ListDataDefinitionForwardingPathElementDataDefinition: + type: object + properties: + empty: + type: boolean + listToscaDataDefinition: + type: array + items: + $ref: '#/components/schemas/ForwardingPathElementDataDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + ListDataDefinitionOperationInputDefinition: + type: object + properties: + empty: + type: boolean + listToscaDataDefinition: + type: array + items: + $ref: '#/components/schemas/OperationInputDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + ListDataDefinitionOperationOutputDefinition: + type: object + properties: + empty: + type: boolean + listToscaDataDefinition: + type: array + items: + $ref: '#/components/schemas/OperationOutputDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + ListDataDefinitionPropertyFilterDataDefinition: + type: object + properties: + empty: + type: boolean + listToscaDataDefinition: + type: array + items: + $ref: '#/components/schemas/PropertyFilterDataDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + ListDataDefinitionRequirementNodeFilterCapabilityDataDefinition: + type: object + properties: + empty: + type: boolean + listToscaDataDefinition: + type: array + items: + $ref: '#/components/schemas/RequirementNodeFilterCapabilityDataDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + ListDataDefinitionRequirementSubstitutionFilterCapabilityDataDefinition: + type: object + properties: + empty: + type: boolean + listToscaDataDefinition: + type: array + items: + $ref: '#/components/schemas/RequirementSubstitutionFilterCapabilityDataDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + ListDataDefinitionSubstitutionFilterPropertyDataDefinition: + type: object + properties: + empty: + type: boolean + listToscaDataDefinition: + type: array + items: + $ref: '#/components/schemas/SubstitutionFilterPropertyDataDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + MetadataKeyDataDefinition: + type: object + properties: + defaultValue: + type: string + displayName: + type: string + empty: + type: boolean + mandatory: + type: boolean + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + validValues: + type: array + items: + type: string + version: + type: string + 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: + - modelType + - name + NameIdPair: + type: object + additionalProperties: + type: object + properties: + empty: + type: boolean + id: + type: string + name: + type: string + ownerId: + type: string + NameIdPairWrapper: + type: object + additionalProperties: + type: object + properties: + data: + type: object + additionalProperties: + type: object + properties: + empty: + type: boolean + id: + type: string + name: + type: string + ownerId: + type: string + empty: + type: boolean + id: + type: string + nameIdPair: + type: object + additionalProperties: + type: object + properties: + empty: + type: boolean + id: + type: string + name: + type: string + ownerId: + type: string + NodeTypeMetadata: + type: object + properties: + categories: + type: array + items: + $ref: '#/components/schemas/CategoryDefinition' + contactId: + type: string + description: + type: string + icon: + type: string + model: + type: string + name: + type: string + normative: + type: boolean + resourceIconPath: + type: string + resourceType: + type: string + resourceVendorModelNumber: + type: string + tags: + type: array + items: + type: string + toscaName: + type: string + vendorName: + type: string + vendorRelease: + type: string + NodeTypesMetadataList: + type: object + properties: + nodeMetadataList: + type: array + items: + $ref: '#/components/schemas/NodeTypeMetadata' + OnboardingConfig: + type: object + properties: + getLatestVspPackageUri: + type: string + getLatestVspUri: + type: string + getVspPackageUri: + type: string + getVspUri: + type: string + healthCheckUri: + type: string + host: + type: string + port: + type: integer + format: int32 + protocol: + type: string + OperationDataDefinition: + type: object + properties: + creationDate: + type: integer + format: int64 + description: + type: string + empty: + type: boolean + implementation: + $ref: '#/components/schemas/ArtifactDataDefinition' + inputs: + $ref: '#/components/schemas/ListDataDefinitionOperationInputDefinition' + lastUpdateDate: + type: integer + format: int64 + name: + type: string + outputs: + $ref: '#/components/schemas/ListDataDefinitionOperationOutputDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + uniqueId: + type: string + version: + type: string + workflowAssociationType: + type: string + workflowId: + type: string + workflowName: + type: string + workflowVersion: + type: string + workflowVersionId: + type: string + OperationImplementation: + type: object + properties: + dependencies: + type: array + items: + type: string + primary: + type: string + OperationInputDefinition: + 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 + label: + type: string + mappedToComponentProperty: + type: boolean + metadata: + type: object + additionalProperties: + type: string + model: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentPropertyType: + type: string + parentUniqueId: + type: string + password: + type: boolean + 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 + source: + type: string + sourceProperty: + type: string + status: + type: string + subPropertyInputPath: + type: string + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + toscaDefaultValue: + type: string + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + type: string + version: + type: string + OperationInstance: + type: object + properties: + implementation: + $ref: '#/components/schemas/OperationImplementation' + inputs: + type: object + additionalProperties: + type: object + OperationOutputDefinition: + 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 + label: + type: string + mappedToComponentProperty: + type: boolean + metadata: + type: object + additionalProperties: + type: string + model: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentPropertyType: + type: string + parentUniqueId: + type: string + password: + type: boolean + 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 + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + type: string + version: + type: string + OperationUi: + type: object + properties: + implementation: + type: object + inputs: + type: array + items: + $ref: '#/components/schemas/PropertyAssignmentUi' + interfaceType: + type: string + operationType: + type: string + OutputDefinition: + type: object + properties: + attribute: + $ref: '#/components/schemas/ComponentInstanceAttribute' + attributeId: + type: string + defaultValue: + type: string + definition: + type: boolean + description: + type: string + empty: + type: boolean + entry_schema: + $ref: '#/components/schemas/EntrySchema' + getOutputAttribute: + type: boolean + getOutputValues: + type: array + items: + $ref: '#/components/schemas/GetOutputValueDataDefinition' + get_default: + type: object + instanceUniqueId: + type: string + model: + type: string + name: + type: string + outputId: + type: string + outputPath: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentUniqueId: + type: string + schema: + $ref: '#/components/schemas/SchemaDefinition' + schemaType: + type: string + status: + type: string + type: + type: string + uniqueId: + type: string + value: + type: string + version: + type: string + PathsAndNamesDefinition: + type: object + properties: + friendlyName: + type: string + path: + type: string + searchable: + type: boolean + PolicyDefinition: + type: object + properties: + annotations: + type: array + items: + $ref: '#/components/schemas/Annotation' + componentName: + type: string + defaultValue: + type: string + definition: + type: boolean + derivedFrom: + type: string + 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 + 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 + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + targets: + type: object + additionalProperties: + type: array + items: + type: string + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + 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 + label: + type: string + mappedToComponentProperty: + type: boolean + metadata: + type: object + additionalProperties: + type: string + model: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentPropertyType: + type: string + parentUniqueId: + type: string + password: + type: boolean + 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 + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + type: string + version: + type: string + PropertyDefinition: + type: object + properties: + annotations: + type: array + items: + $ref: '#/components/schemas/Annotation' + constraints: + type: array + items: + $ref: '#/components/schemas/PropertyConstraint' + 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 + label: + type: string + mappedToComponentProperty: + type: boolean + metadata: + type: object + additionalProperties: + type: string + model: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentPropertyType: + type: string + parentUniqueId: + type: string + password: + type: boolean + 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 + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + type: string + version: + type: string + PropertyDefinitionDto: + type: object + properties: + constraints: + type: array + items: + $ref: '#/components/schemas/PropertyConstraint' + defaultValue: + type: object + description: + type: string + name: + type: string + required: + type: boolean + schemaType: + type: string + type: + type: string + uniqueId: + type: string + value: + type: object + PropertyFilterConstraintDataDefinition: + type: object + properties: + capabilityName: + type: string + operator: + type: string + enum: + - EQUAL + - IN_RANGE + - GREATER_THAN + - GREATER_OR_EQUAL + - LESS_OR_EQUAL + - LENGTH + - MIN_LENGTH + - MAX_LENGTH + - VALID_VALUES + - LESS_THAN + - PATTERN + - SCHEMA + propertyName: + type: string + targetType: + type: string + enum: + - CAPABILITY + - PROPERTY + value: + type: object + valueType: + type: string + enum: + - STATIC + - GET_PROPERTY + - GET_INPUT + - GET_ATTRIBUTE + - YAML + - CONCAT + PropertyFilterDataDefinition: + type: object + properties: + constraints: + type: array + items: + $ref: '#/components/schemas/PropertyFilterConstraintDataDefinition' + empty: + type: boolean + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + PropertyRule: + type: object + properties: + empty: + type: boolean + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + rule: + type: array + items: + type: string + type: + type: string + value: + type: string + version: + type: string + QueueInfo: + type: object + properties: + numberOfCacheWorkers: + type: integer + format: int32 + syncIntervalInSecondes: + type: integer + format: int32 + waitOnShutDownInMinutes: + type: integer + format: int32 + RelationshipImpl: + type: object + properties: + type: + type: string + RelationshipInfo: + type: object + properties: + capability: + type: string + capabilityOwnerId: + type: string + capabilityUid: + type: string + id: + type: string + relationship: + $ref: '#/components/schemas/RelationshipImpl' + relationships: + $ref: '#/components/schemas/RelationshipImpl' + requirement: + type: string + requirementOwnerId: + type: string + requirementUid: + type: string + ReplaceVNFInfo: + type: object + properties: + abstractResourceUniqueId: + type: string + realVNFComponentInstance: + $ref: '#/components/schemas/ComponentInstance' + serviceUniqueId: + type: string + RequirementCapabilityRelDef: + type: object + properties: + fromNode: + type: string + originUI: + type: boolean + relationships: + type: array + items: + $ref: '#/components/schemas/CapabilityRequirementRelationship' + toNode: + type: string + uid: + type: string + RequirementDataDefinition: + type: object + properties: + capability: + type: string + empty: + type: boolean + external: + type: boolean + externalName: + type: string + leftOccurrences: + type: string + maxOccurrences: + type: string + minOccurrences: + type: string + name: + type: string + node: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + ownerName: + type: string + parentName: + type: string + path: + type: array + items: + type: string + previousName: + type: string + relationship: + type: string + source: + type: string + type: + type: string + uniqueId: + type: string + version: + type: string + RequirementDefinition: + type: object + properties: + capability: + type: string + empty: + type: boolean + external: + type: boolean + externalName: + type: string + leftOccurrences: + type: string + maxOccurrences: + type: string + minOccurrences: + type: string + name: + type: string + node: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + ownerName: + type: string + parentName: + type: string + path: + type: array + items: + type: string + previousName: + type: string + relationship: + type: string + source: + type: string + type: + type: string + uniqueId: + type: string + version: + type: string + RequirementNodeFilterCapabilityDataDefinition: + type: object + properties: + empty: + type: boolean + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + properties: + $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition' + type: + type: string + version: + type: string + RequirementSubstitutionFilterCapabilityDataDefinition: + type: object + properties: + empty: + type: boolean + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + properties: + $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition' + type: + type: string + version: + type: string + Resource: + type: object + properties: + abstract: + type: boolean + actualComponentType: + type: string + additionalInformation: + type: array + items: + $ref: '#/components/schemas/AdditionalInformationDefinition' + allArtifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + allVersions: + type: object + additionalProperties: + type: string + archiveTime: + type: integer + format: int64 + archived: + type: boolean + artifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + attributes: + type: array + items: + $ref: '#/components/schemas/AttributeDefinition' + capabilities: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/CapabilityDefinition' + categories: + type: array + items: + $ref: '#/components/schemas/CategoryDefinition' + categorySpecificMetadata: + type: object + additionalProperties: + type: string + componentInstances: + type: array + items: + $ref: '#/components/schemas/ComponentInstance' + componentInstancesAttributes: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceAttribute' + componentInstancesInputs: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceInput' + componentInstancesInterfaces: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceInterface' + componentInstancesOutputs: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceOutput' + componentInstancesProperties: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceProperty' + componentInstancesRelations: + type: array + items: + $ref: '#/components/schemas/RequirementCapabilityRelDef' + componentMetadataForSupportLog: + type: object + additionalProperties: + type: string + componentType: + type: string + enum: + - RESOURCE + - SERVICE + - RESOURCE_INSTANCE + - PRODUCT + - SERVICE_INSTANCE + conformanceLevel: + type: string + contactId: + type: string + cost: + type: string + creationDate: + type: integer + format: int64 + creatorFullName: + type: string + creatorUserId: + type: string + csarUUID: + type: string + csarVersion: + type: string + csarVersionId: + type: string + dataTypes: + type: array + items: + $ref: '#/components/schemas/DataTypeDefinition' + deploymentArtifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + derivedFrom: + type: array + items: + type: string + derivedFromGenericInfo: + $ref: '#/components/schemas/Resource' + derivedFromGenericType: + type: string + derivedFromGenericVersion: + type: string + derivedFromMapOfIdToName: + type: object + additionalProperties: + type: string + derivedList: + type: array + items: + type: string + description: + type: string + groups: + type: array + items: + $ref: '#/components/schemas/GroupDefinition' + highestVersion: + type: boolean + icon: + type: string + importedToscaChecksum: + type: string + inputs: + type: array + items: + $ref: '#/components/schemas/InputDefinition' + interfaces: + type: object + additionalProperties: + $ref: '#/components/schemas/InterfaceDefinition' + invariantUUID: + type: string + isDeleted: + type: boolean + lastUpdateDate: + type: integer + format: int64 + lastUpdaterFullName: + type: string + lastUpdaterUserId: + type: string + licenseType: + type: string + lifecycleState: + type: string + enum: + - CERTIFIED + - NOT_CERTIFIED_CHECKIN + - NOT_CERTIFIED_CHECKOUT + model: + type: string + name: + type: string + nodeFilterComponents: + type: object + additionalProperties: + $ref: '#/components/schemas/CINodeFilterDataDefinition' + normalizedName: + type: string + outputs: + type: array + items: + $ref: '#/components/schemas/OutputDefinition' + policies: + type: object + additionalProperties: + $ref: '#/components/schemas/PolicyDefinition' + projectCode: + type: string + properties: + type: array + items: + $ref: '#/components/schemas/PropertyDefinition' + requirements: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/RequirementDefinition' + resourceType: + type: string + enum: + - VFC + - VF + - CR + - CP + - PNF + - CVFC + - VL + - VFCMT + - Configuration + - ServiceProxy + - ABSTRACT + - SERVICE + resourceVendorModelNumber: + type: string + service: + type: boolean + specificComponetTypeArtifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + writeOnly: true + state: + type: string + enum: + - CERTIFIED + - NOT_CERTIFIED_CHECKIN + - NOT_CERTIFIED_CHECKOUT + writeOnly: true + substitutionFilter: + $ref: '#/components/schemas/SubstitutionFilterDataDefinition' + systemName: + type: string + tags: + type: array + items: + type: string + topologyTemplate: + type: boolean + toscaArtifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + toscaResourceName: + type: string + toscaType: + type: string + toscaVersion: + type: string + uniqueId: + type: string + uuid: + type: string + vendorName: + type: string + vendorRelease: + type: string + version: + type: string + vspArchived: + type: boolean + SchemaDefinition: + type: object + properties: + constraints: + type: array + items: + type: string + derivedFrom: + type: string + empty: + type: boolean + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + properties: + type: object + additionalProperties: + $ref: '#/components/schemas/PropertyDataDefinition' + property: + $ref: '#/components/schemas/PropertyDataDefinition' + type: + type: string + version: + type: string + Service: + type: object + properties: + abstract: + type: boolean + writeOnly: true + actualComponentType: + type: string + additionalInformation: + type: array + items: + $ref: '#/components/schemas/AdditionalInformationDefinition' + allArtifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + allVersions: + type: object + additionalProperties: + type: string + archiveTime: + type: integer + format: int64 + archived: + type: boolean + artifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + attributes: + type: array + items: + $ref: '#/components/schemas/AttributeDefinition' + capabilities: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/CapabilityDefinition' + categories: + type: array + items: + $ref: '#/components/schemas/CategoryDefinition' + categorySpecificMetadata: + type: object + additionalProperties: + type: string + componentInstances: + type: array + items: + $ref: '#/components/schemas/ComponentInstance' + componentInstancesAttributes: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceAttribute' + componentInstancesInputs: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceInput' + componentInstancesInterfaces: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceInterface' + componentInstancesOutputs: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceOutput' + componentInstancesProperties: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceProperty' + componentInstancesRelations: + type: array + items: + $ref: '#/components/schemas/RequirementCapabilityRelDef' + componentMetadataForSupportLog: + type: object + additionalProperties: + type: string + componentType: + type: string + enum: + - RESOURCE + - SERVICE + - RESOURCE_INSTANCE + - PRODUCT + - SERVICE_INSTANCE + conformanceLevel: + type: string + contactId: + type: string + creationDate: + type: integer + format: int64 + creatorFullName: + type: string + creatorUserId: + type: string + csarUUID: + type: string + csarVersion: + type: string + dataTypes: + type: array + items: + $ref: '#/components/schemas/DataTypeDefinition' + deploymentArtifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + derivedFromGenericInfo: + $ref: '#/components/schemas/Resource' + derivedFromGenericType: + type: string + derivedFromGenericVersion: + type: string + description: + type: string + distributionStatus: + type: string + enum: + - DISTRIBUTION_NOT_APPROVED + - DISTRIBUTED + ecompGeneratedNaming: + type: boolean + environmentContext: + type: string + forwardingPaths: + type: object + additionalProperties: + $ref: '#/components/schemas/ForwardingPathDataDefinition' + groups: + type: array + items: + $ref: '#/components/schemas/GroupDefinition' + highestVersion: + type: boolean + icon: + type: string + importedToscaChecksum: + type: string + inputs: + type: array + items: + $ref: '#/components/schemas/InputDefinition' + instantiationType: + type: string + interfaces: + type: object + additionalProperties: + $ref: '#/components/schemas/InterfaceDefinition' + invariantUUID: + type: string + isDeleted: + type: boolean + lastUpdateDate: + type: integer + format: int64 + lastUpdaterFullName: + type: string + lastUpdaterUserId: + type: string + lifecycleState: + type: string + enum: + - CERTIFIED + - NOT_CERTIFIED_CHECKIN + - NOT_CERTIFIED_CHECKOUT + model: + type: string + name: + type: string + namingPolicy: + type: string + nodeFilterComponents: + type: object + additionalProperties: + $ref: '#/components/schemas/CINodeFilterDataDefinition' + normalizedName: + type: string + outputs: + type: array + items: + $ref: '#/components/schemas/OutputDefinition' + policies: + type: object + additionalProperties: + $ref: '#/components/schemas/PolicyDefinition' + projectCode: + type: string + properties: + type: array + items: + $ref: '#/components/schemas/PropertyDefinition' + requirements: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/RequirementDefinition' + service: + type: boolean + serviceApiArtifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + serviceFunction: + type: string + serviceRole: + type: string + serviceType: + type: string + serviceVendorModelNumber: + type: string + writeOnly: true + specificComponetTypeArtifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + writeOnly: true + state: + type: string + enum: + - CERTIFIED + - NOT_CERTIFIED_CHECKIN + - NOT_CERTIFIED_CHECKOUT + writeOnly: true + substituteCandidate: + type: boolean + substitutionFilter: + $ref: '#/components/schemas/SubstitutionFilterDataDefinition' + systemName: + type: string + tags: + type: array + items: + type: string + topologyTemplate: + type: boolean + toscaArtifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + toscaServiceName: + type: string + toscaType: + type: string + uniqueId: + type: string + uuid: + type: string + vendorName: + type: string + writeOnly: true + vendorRelease: + type: string + writeOnly: true + version: + type: string + vspArchived: + type: boolean + ServiceRelations: + type: array + items: + $ref: '#/components/schemas/NameIdPairWrapper' + properties: + empty: + type: boolean + relations: + type: array + items: + $ref: '#/components/schemas/NameIdPairWrapper' + uniqueItems: true + SubCategoryDefinition: + type: object + properties: + empty: + type: boolean + groupings: + type: array + items: + $ref: '#/components/schemas/GroupingDefinition' + icons: + type: array + items: + type: string + metadataKeys: + type: array + items: + $ref: '#/components/schemas/MetadataKeyDataDefinition' + name: + type: string + normalizedName: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + uniqueId: + type: string + version: + type: string + SubPropertyToscaFunction: + type: object + properties: + subPropertyPath: + type: array + items: + type: string + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + SubstitutionFilterDataDefinition: + type: object + properties: + capabilities: + $ref: '#/components/schemas/ListDataDefinitionRequirementSubstitutionFilterCapabilityDataDefinition' + empty: + type: boolean + id: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + properties: + $ref: '#/components/schemas/ListDataDefinitionSubstitutionFilterPropertyDataDefinition' + tosca_id: + type: object + type: + type: string + version: + type: string + SubstitutionFilterPropertyDataDefinition: + type: object + properties: + constraints: + type: array + items: + $ref: '#/components/schemas/PropertyFilterConstraintDataDefinition' + empty: + type: boolean + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + SwitchoverDetectorConfig: + type: object + properties: + beResolveAttempts: + type: integer + format: int32 + beVip: + type: string + changePriorityPassword: + type: string + changePriorityUser: + type: string + enabled: + type: boolean + feResolveAttempts: + type: integer + format: int32 + feVip: + type: string + getgBeFqdn: + type: string + getgFeFqdn: + type: string + groups: + type: object + additionalProperties: + $ref: '#/components/schemas/GroupInfo' + interval: + type: integer + format: int64 + publishNetworkBody: + type: string + publishNetworkUrl: + type: string + ToscaArtifactDataDefinition: + type: object + properties: + file: + type: string + properties: + type: object + additionalProperties: + type: object + type: + type: string + ToscaFunction: + type: object + properties: + jsonObjectValue: + type: object + type: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + - CONCAT + - YAML + - STRING + value: + type: string + ToscaGetFunctionDataDefinition: + type: object + properties: + functionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + propertyName: + type: string + propertyPathFromSource: + type: array + items: + type: string + propertySource: + type: string + enum: + - SELF + - INSTANCE + propertyUniqueId: + type: string + sourceName: + type: string + sourceUniqueId: + type: string + type: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + - CONCAT + - YAML + - STRING + ToscaValidatorsConfig: + type: object + properties: + stringMaxLength: + type: integer + format: int32 + UIConstraint: + type: object + properties: + capabilityName: + type: string + constraintOperator: + type: string + servicePropertyName: + type: string + sourceName: + type: string + sourceType: + type: string + value: + type: object + User: + type: object + properties: + email: + type: string + firstName: + type: string + fullName: + type: string + lastLoginTime: + type: integer + format: int64 + lastName: + type: string + role: + type: string + status: + type: string + enum: + - ACTIVE + - INACTIVE + userId: + type: string + UserRole: + type: object + properties: + role: + type: string + enum: + - ADMIN + - TESTER + - DESIGNER + - PRODUCT_MANAGER + - PRODUCT_STRATEGIST + VfModuleProperty: + type: object + properties: + forBaseModule: + type: string + forNonBaseModule: + type: string diff --git a/docs/openapi/openapi-sdce-4.json b/docs/openapi/openapi-sdce-4.json new file mode 100644 index 0000000000..ab623bbe6a --- /dev/null +++ b/docs/openapi/openapi-sdce-4.json @@ -0,0 +1,346 @@ +{ + "openapi" : "3.0.1", + "info" : { + "contact" : { + "email" : "onap-discuss@lists.onap.org", + "name" : "ONAP", + "url" : "https://onap.readthedocs.io" + }, + "description" : "SDC API for certifying services (SDCE-4)", + "license" : { + "name" : "Apache 2.0", + "url" : "http://www.apache.org/licenses/LICENSE-2.0" + }, + "title" : "SPC API: SDCE-4", + "version" : "1.0" + }, + "servers" : [ { + "description" : "SDCE-4 APIs", + "url" : "/sdc" + } ], + "paths" : { + "/v1/catalog/{componentCollection}/{componentId}/lifecycleState/{lifecycleOperation}" : { + "post" : { + "description" : "Change Resource lifecycle State", + "operationId" : "changeResourceState", + "parameters" : [ { + "description" : "validValues: resources / services / products", + "in" : "path", + "name" : "componentCollection", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services", "products" ] + } + }, { + "in" : "path", + "name" : "lifecycleOperation", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "checkout, undoCheckout, checkin, certificationRequest, startCertification, failCertification, cancelCertification, certify" ] + } + }, { + "description" : "id of component to be changed", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "id of user initiating the operation", + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "LifecycleChangeInfo - relevant for checkin, failCertification, cancelCertification" + }, + "responses" : { + "200" : { + "description" : "Resource state changed" + }, + "403" : { + "description" : "Restricted operation" + }, + "409" : { + "description" : "Resource 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" : { } + } ], + "tags" : [ "SDCE-4 APIs" ] + } + } + } +}
\ No newline at end of file diff --git a/docs/openapi/openapi-sdce-4.yaml b/docs/openapi/openapi-sdce-4.yaml new file mode 100644 index 0000000000..255ab767e6 --- /dev/null +++ b/docs/openapi/openapi-sdce-4.yaml @@ -0,0 +1,249 @@ +openapi: 3.0.1 +info: + contact: + email: onap-discuss@lists.onap.org + name: ONAP + url: https://onap.readthedocs.io + description: SDC API for certifying services (SDCE-4) + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0 + title: "SPC API: SDCE-4" + version: "1.0" +servers: +- description: SDCE-4 APIs + url: /sdc +paths: + /v1/catalog/{componentCollection}/{componentId}/lifecycleState/{lifecycleOperation}: + post: + description: Change Resource lifecycle State + operationId: changeResourceState + parameters: + - description: "validValues: resources / services / products" + in: path + name: componentCollection + required: true + schema: + type: string + enum: + - resources + - services + - products + - in: path + name: lifecycleOperation + required: true + schema: + type: string + enum: + - "checkout, undoCheckout, checkin, certificationRequest, startCertification,\ + \ failCertification, cancelCertification, certify" + - description: id of component to be changed + in: path + name: componentId + required: true + schema: + type: string + - description: id of user initiating the operation + in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + description: "LifecycleChangeInfo - relevant for checkin, failCertification,\ + \ cancelCertification" + responses: + "200": + description: Resource state changed + "403": + description: Restricted operation + "409": + description: Resource 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: {} + tags: + - SDCE-4 APIs diff --git a/docs/openapi/openapi-sdce-6.json b/docs/openapi/openapi-sdce-6.json new file mode 100644 index 0000000000..f368cf9bf2 --- /dev/null +++ b/docs/openapi/openapi-sdce-6.json @@ -0,0 +1,506 @@ +{ + "openapi" : "3.0.1", + "info" : { + "contact" : { + "email" : "onap-discuss@lists.onap.org", + "name" : "ONAP", + "url" : "https://onap.readthedocs.io" + }, + "description" : "SDC API for distribution subscription (SDCE-6)", + "license" : { + "name" : "Apache 2.0", + "url" : "http://www.apache.org/licenses/LICENSE-2.0" + }, + "title" : "SPC API: SDCE-6", + "version" : "1.0" + }, + "servers" : [ { + "description" : "SDCE-6 APIs", + "url" : "/sdc" + } ], + "paths" : { + "/v1/artifactTypes" : { + "get" : { + "description" : "Artifact types list", + "operationId" : "getValidArtifactTypes", + "parameters" : [ { + "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" : "The username and password", + "in" : "header", + "name" : "Authorization", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The username and password", + "in" : "header", + "name" : "Accept", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "description" : "Artifact types list fetched successfully" + }, + "400" : { + "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "405" : { + "description" : "Method Not Allowed : Invalid HTTP method type used to register for distribution ( POST,PUT,DELETE will be rejected) - POL4050" + }, + "500" : { + "description" : "The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component should continue the attempts to register for distribution - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "Fetches available artifact types list", + "tags" : [ "SDCE-6 APIs" ] + } + }, + "/v1/distributionKafkaData" : { + "get" : { + "description" : "Kafka data", + "operationId" : "getKafkaData", + "parameters" : [ { + "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" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/KafkaDataResponse" + } + } + } + }, + "description" : "ECOMP component is authenticated and kafka endpoint and topic list is returned" + }, + "400" : { + "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its credentials for Basic Authentication - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "405" : { + "description" : "Method Not Allowed: Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "return the kafka cluster and topic list", + "tags" : [ "SDCE-6 APIs" ] + } + }, + "/v1/distributionUebCluster" : { + "get" : { + "description" : "UEB Server List", + "operationId" : "getUebServerList", + "parameters" : [ { + "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" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServerListResponse" + } + } + } + }, + "description" : "ECOMP component is authenticated and list of Cambria API server’s FQDNs is returned" + }, + "400" : { + "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its credentials for Basic Authentication - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "405" : { + "description" : "Method Not Allowed: Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "return the available UEB Server List", + "tags" : [ "SDCE-6 APIs" ] + } + }, + "/v1/registerForDistribution" : { + "post" : { + "description" : "Subscription status", + "operationId" : "registerForDistribution", + "parameters" : [ { + "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" : "Determines the format of the body of the request", + "in" : "header", + "name" : "Content-Type", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Length of the request body", + "in" : "header", + "name" : "Content-Length", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The username and password", + "in" : "header", + "name" : "Authorization", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TopicRegistrationResponse" + } + } + } + }, + "description" : "ECOMP component is successfully registered for distribution" + }, + "400" : { + "description" : "Invalid Body : Specified 'distrEnvName' doesn’t exist - POL4137" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "405" : { + "description" : "Method Not Allowed : Invalid HTTP method type used to register for distribution ( PUT,DELETE,GET will be rejected) - POL4050" + }, + "500" : { + "description" : "The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component should continue the attempts to register for distribution - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "Subscribes for distribution notifications", + "tags" : [ "SDCE-6 APIs" ] + } + }, + "/v1/unRegisterForDistribution" : { + "post" : { + "description" : "Subscription status", + "operationId" : "unRegisterForDistribution", + "parameters" : [ { + "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" : "Determines the format of the body of the request", + "in" : "header", + "name" : "Content-Type", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Length of the request body", + "in" : "header", + "name" : "Content-Length", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The username and password", + "in" : "header", + "name" : "Authorization", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TopicUnregistrationResponse" + } + } + } + }, + "description" : "ECOMP component is successfully unregistered" + }, + "400" : { + "description" : "Invalid Body : Specified 'distrEnvName' doesn’t exist - POL4137" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "405" : { + "description" : "Method Not Allowed : Invalid HTTP method type used to register for distribution ( PUT,DELETE,GET will be rejected) - POL4050" + }, + "500" : { + "description" : "The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component should continue the attempts to register for distribution - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "Removes from subscription for distribution notifications", + "tags" : [ "SDCE-6 APIs" ] + } + } + }, + "components" : { + "schemas" : { + "KafkaDataResponse" : { + "type" : "object", + "properties" : { + "distrNotificationTopicName" : { + "type" : "string" + }, + "distrStatusTopicName" : { + "type" : "string" + }, + "kafkaBootStrapServer" : { + "type" : "string" + } + } + }, + "RegistrationRequest" : { + "type" : "object", + "properties" : { + "apiPublicKey" : { + "type" : "string" + }, + "distEnvEndPoints" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "distrEnvName" : { + "type" : "string" + }, + "isConsumerToSdcDistrStatusTopic" : { + "type" : "boolean" + }, + "managerApiPublicKey" : { + "type" : "string" + }, + "managerApiSecretKey" : { + "type" : "string" + } + } + }, + "ServerListResponse" : { + "type" : "object", + "properties" : { + "uebServerList" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "TopicRegistrationResponse" : { + "type" : "object", + "properties" : { + "distrNotificationTopicName" : { + "type" : "string" + }, + "distrStatusTopicName" : { + "type" : "string" + } + } + }, + "TopicUnregistrationResponse" : { + "type" : "object", + "properties" : { + "distrNotificationTopicName" : { + "type" : "string" + }, + "distrStatusTopicName" : { + "type" : "string" + }, + "notificationUnregisterResult" : { + "type" : "string", + "enum" : [ "OK", "CONNNECTION_ERROR", "NOT_FOUND", "TOPIC_ALREADY_EXIST", "OBJECT_NOT_FOUND", "INTERNAL_SERVER_ERROR", "AUTHENTICATION_ERROR", "UNKNOWN_HOST_ERROR" ] + }, + "statusUnregisterResult" : { + "type" : "string", + "enum" : [ "OK", "CONNNECTION_ERROR", "NOT_FOUND", "TOPIC_ALREADY_EXIST", "OBJECT_NOT_FOUND", "INTERNAL_SERVER_ERROR", "AUTHENTICATION_ERROR", "UNKNOWN_HOST_ERROR" ] + } + } + } + } + } +}
\ No newline at end of file diff --git a/docs/openapi/openapi-sdce-6.yaml b/docs/openapi/openapi-sdce-6.yaml new file mode 100644 index 0000000000..97f4c7e484 --- /dev/null +++ b/docs/openapi/openapi-sdce-6.yaml @@ -0,0 +1,394 @@ +openapi: 3.0.1 +info: + contact: + email: onap-discuss@lists.onap.org + name: ONAP + url: https://onap.readthedocs.io + description: SDC API for distribution subscription (SDCE-6) + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0 + title: "SPC API: SDCE-6" + version: "1.0" +servers: +- description: SDCE-6 APIs + url: /sdc +paths: + /v1/artifactTypes: + get: + description: Artifact types list + operationId: getValidArtifactTypes + parameters: + - 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: The username and password + in: header + name: Authorization + required: true + schema: + type: string + - description: The username and password + in: header + name: Accept + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + type: array + items: + type: string + description: Artifact types list fetched successfully + "400": + description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "405": + description: "Method Not Allowed : Invalid HTTP method type used to \ + \ register for distribution ( POST,PUT,DELETE will be rejected) - POL4050" + "500": + description: The registration failed due to internal SDC problem or Cambria + Service failure ECOMP Component should continue the attempts to register + for distribution - POL5000 + servers: + - url: /sdc + variables: {} + summary: Fetches available artifact types list + tags: + - SDCE-6 APIs + /v1/distributionKafkaData: + get: + description: Kafka data + operationId: getKafkaData + parameters: + - 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 + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/KafkaDataResponse' + description: ECOMP component is authenticated and kafka endpoint and topic + list is returned + "400": + description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its credentials for Basic Authentication - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "405": + description: "Method Not Allowed: Invalid HTTP method type used ( PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "500": + description: The GET request failed either due to internal SDC problem or + Cambria Service failure. ECOMP Component should continue the attempts + to get the needed information - POL5000 + servers: + - url: /sdc + variables: {} + summary: return the kafka cluster and topic list + tags: + - SDCE-6 APIs + /v1/distributionUebCluster: + get: + description: UEB Server List + operationId: getUebServerList + parameters: + - 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 + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServerListResponse' + description: ECOMP component is authenticated and list of Cambria API server’s + FQDNs is returned + "400": + description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its credentials for Basic Authentication - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "405": + description: "Method Not Allowed: Invalid HTTP method type used ( PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "500": + description: The GET request failed either due to internal SDC problem or + Cambria Service failure. ECOMP Component should continue the attempts + to get the needed information - POL5000 + servers: + - url: /sdc + variables: {} + summary: return the available UEB Server List + tags: + - SDCE-6 APIs + /v1/registerForDistribution: + post: + description: Subscription status + operationId: registerForDistribution + parameters: + - 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: Determines the format of the body of the request + in: header + name: Content-Type + required: true + schema: + type: string + - description: Length of the request body + in: header + name: Content-Length + required: true + schema: + type: string + - description: The username and password + in: header + name: Authorization + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TopicRegistrationResponse' + description: ECOMP component is successfully registered for distribution + "400": + description: "Invalid Body : Specified 'distrEnvName' doesn’t exist - POL4137" + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "405": + description: "Method Not Allowed : Invalid HTTP method type used to \ + \ register for distribution ( PUT,DELETE,GET will be rejected) - POL4050" + "500": + description: The registration failed due to internal SDC problem or Cambria + Service failure ECOMP Component should continue the attempts to register + for distribution - POL5000 + servers: + - url: /sdc + variables: {} + summary: Subscribes for distribution notifications + tags: + - SDCE-6 APIs + /v1/unRegisterForDistribution: + post: + description: Subscription status + operationId: unRegisterForDistribution + parameters: + - 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: Determines the format of the body of the request + in: header + name: Content-Type + required: true + schema: + type: string + - description: Length of the request body + in: header + name: Content-Length + required: true + schema: + type: string + - description: The username and password + in: header + name: Authorization + required: true + schema: + type: string + responses: + "204": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TopicUnregistrationResponse' + description: ECOMP component is successfully unregistered + "400": + description: "Invalid Body : Specified 'distrEnvName' doesn’t exist - POL4137" + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "405": + description: "Method Not Allowed : Invalid HTTP method type used to \ + \ register for distribution ( PUT,DELETE,GET will be rejected) - POL4050" + "500": + description: The registration failed due to internal SDC problem or Cambria + Service failure ECOMP Component should continue the attempts to register + for distribution - POL5000 + servers: + - url: /sdc + variables: {} + summary: Removes from subscription for distribution notifications + tags: + - SDCE-6 APIs +components: + schemas: + KafkaDataResponse: + type: object + properties: + distrNotificationTopicName: + type: string + distrStatusTopicName: + type: string + kafkaBootStrapServer: + type: string + RegistrationRequest: + type: object + properties: + apiPublicKey: + type: string + distEnvEndPoints: + type: array + items: + type: string + distrEnvName: + type: string + isConsumerToSdcDistrStatusTopic: + type: boolean + managerApiPublicKey: + type: string + managerApiSecretKey: + type: string + ServerListResponse: + type: object + properties: + uebServerList: + type: array + items: + type: string + TopicRegistrationResponse: + type: object + properties: + distrNotificationTopicName: + type: string + distrStatusTopicName: + type: string + TopicUnregistrationResponse: + type: object + properties: + distrNotificationTopicName: + type: string + distrStatusTopicName: + type: string + notificationUnregisterResult: + type: string + enum: + - OK + - CONNNECTION_ERROR + - NOT_FOUND + - TOPIC_ALREADY_EXIST + - OBJECT_NOT_FOUND + - INTERNAL_SERVER_ERROR + - AUTHENTICATION_ERROR + - UNKNOWN_HOST_ERROR + statusUnregisterResult: + type: string + enum: + - OK + - CONNNECTION_ERROR + - NOT_FOUND + - TOPIC_ALREADY_EXIST + - OBJECT_NOT_FOUND + - INTERNAL_SERVER_ERROR + - AUTHENTICATION_ERROR + - UNKNOWN_HOST_ERROR diff --git a/docs/openapi/openapi-sdce-7.json b/docs/openapi/openapi-sdce-7.json new file mode 100644 index 0000000000..a24edd2c82 --- /dev/null +++ b/docs/openapi/openapi-sdce-7.json @@ -0,0 +1,8260 @@ +{ + "openapi" : "3.0.1", + "info" : { + "contact" : { + "email" : "onap-discuss@lists.onap.org", + "name" : "ONAP", + "url" : "https://onap.readthedocs.io" + }, + "description" : "SDC API for retrieval for service models (SDCE-7)", + "license" : { + "name" : "Apache 2.0", + "url" : "http://www.apache.org/licenses/LICENSE-2.0" + }, + "title" : "SPC API: SDCE-7", + "version" : "1.0" + }, + "servers" : [ { + "description" : "SDCE-7 APIs", + "url" : "/sdc" + } ], + "paths" : { + "/v1/catalog/abstract/service/serviceUUID/{uuid}/copy" : { + "post" : { + "description" : "Copy a new service based on the existing service", + "operationId" : "copyExistService", + "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" + } + }, { + "description" : "The requested asset uuid", + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AbstractTemplateInfo" + } + } + } + }, + "description" : "ECOMP component is authenticated and list of Catalog Assets Metadata is returned" + }, + "400" : { + "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "404" : { + "description" : "Error: Requested '%1' (uuid) resource was not found - SVC4063" + }, + "405" : { + "description" : "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050" + }, + "409" : { + "description" : "Service already exist" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "Return whether the copy service is successful", + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/abstract/service/serviceUUID/{uuid}/status" : { + "get" : { + "description" : "Fetch abstract status of service", + "operationId" : "getServiceAbstractStatus", + "parameters" : [ { + "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" + } + }, { + "description" : "The requested asset uuid", + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AbstractTemplateInfo" + } + } + } + }, + "description" : "The check result of whether the service is an abstract service is returned" + }, + "400" : { + "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "404" : { + "description" : "Error: Requested '%1' (uuid) resource was not found - SVC4063" + }, + "405" : { + "description" : "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "Return whether the service is a virtual service", + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/services/{serviceName}/{serviceVersion}/artifacts/{artifactName}" : { + "get" : { + "description" : "Download service artifact", + "operationId" : "downloadServiceArtifact", + "parameters" : [ { + "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" + } + }, { + "in" : "path", + "name" : "serviceName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "serviceVersion", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "description" : "The artifact is found and streamed." + }, + "400" : { + "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "404" : { + "description" : "Specified artifact is not found - SVC4505" + }, + "405" : { + "description" : "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000" + }, + "default" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "Returns downloaded artifact", + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/services/{serviceName}/{serviceVersion}/resourceInstances/{resourceInstanceName}/artifacts/{artifactName}" : { + "get" : { + "description" : "Download resource instance artifact", + "operationId" : "downloadResourceInstanceArtifactByName", + "parameters" : [ { + "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" + } + }, { + "in" : "path", + "name" : "serviceName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "serviceVersion", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "resourceInstanceName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "description" : "The artifact is found and streamed." + }, + "400" : { + "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "404" : { + "description" : "Specified artifact is not found - SVC4505" + }, + "405" : { + "description" : "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000" + }, + "default" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "Returns downloaded artifact", + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/services/{serviceName}/{serviceVersion}/resources/{resourceName}/{resourceVersion}/artifacts/{artifactName}" : { + "get" : { + "description" : "Download resource artifact", + "operationId" : "downloadResourceArtifact", + "parameters" : [ { + "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" + } + }, { + "in" : "path", + "name" : "serviceName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "serviceVersion", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "resourceName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "resourceVersion", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "artifactName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "description" : "The artifact is found and streamed." + }, + "400" : { + "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "404" : { + "description" : "Specified artifact is not found - SVC4505" + }, + "405" : { + "description" : "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000" + }, + "default" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "Returns downloaded artifact", + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/services/{serviceUUID}/distribution/{opEnvId}/activate" : { + "post" : { + "description" : "activate a service", + "operationId" : "activateServiceExternal", + "parameters" : [ { + "description" : "Determines the format of the body of the request", + "in" : "header", + "name" : "Content-Type", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "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" + } + }, { + "description" : "The serviceUUid to activate", + "in" : "path", + "name" : "serviceUUID", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The operational environment on which to activate the service on", + "in" : "path", + "name" : "opEnvId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + }, + "responses" : { + "202" : { + "description" : "ECOMP component is authenticated and required service may be distributed" + }, + "400" : { + "description" : "The resource name is missing in the request body - SVC4062" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "404" : { + "description" : "Error: Requested '%1' (uuid) resource was not found - SVC4063" + }, + "405" : { + "description" : "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050" + }, + "409" : { + "description" : "Service state is invalid for this action" + }, + "500" : { + "description" : "The request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000" + }, + "502" : { + "description" : "The server was acting as a gateway or proxy and received an invalid response from the upstream server" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "Activates a service", + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/{assetType}" : { + "get" : { + "description" : "Fetch list of assets", + "operationId" : "getAssetListExternal", + "parameters" : [ { + "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" + } + }, { + "description" : "The requested asset type", + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + }, { + "description" : "The filter key (resourceType only for resources)", + "in" : "query", + "name" : "category", + "schema" : { + "type" : "string" + } + }, { + "description" : "The filter key (resourceType only for resources)", + "in" : "query", + "name" : "subCategory", + "schema" : { + "type" : "string" + } + }, { + "description" : "The filter key (resourceType only for resources)", + "in" : "query", + "name" : "distributionStatus", + "schema" : { + "type" : "string" + } + }, { + "description" : "The filter key (resourceType only for resources)", + "in" : "query", + "name" : "resourceType", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AssetMetadata" + } + } + } + }, + "description" : "ECOMP component is authenticated and list of Catalog Assets Metadata is returned" + }, + "400" : { + "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "405" : { + "description" : "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "Returns list of assets", + "tags" : [ "SDCE-7 APIs" ] + }, + "post" : { + "description" : "creates an asset (resource or service)", + "operationId" : "createComponentExternal", + "parameters" : [ { + "description" : "Determines the format of the body of the request", + "in" : "header", + "name" : "Content-Type", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "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" + } + }, { + "description" : "The requested asset type", + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources, services" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + }, + "description" : "ECOMP component is authenticated and Asset created" + }, + "400" : { + "description" : "Invalid Content. Missing PROJECT_CODE number - SVC4129" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "404" : { + "description" : "Error: Requested '%1' (uuid) resource was not found - SVC4063" + }, + "405" : { + "description" : "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050" + }, + "409" : { + "description" : "Error: %1 (Service) with name '%2' already exists. - SVC4050" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "Creates an asset (resource or service)", + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/{assetType}/{uuid}/artifacts" : { + "post" : { + "description" : "uploads of artifact to a resource or service", + "operationId" : "uploadArtifact", + "parameters" : [ { + "description" : "Determines the format of the body of the request", + "in" : "header", + "name" : "Content-Type", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The value for this header must be the MD5 checksum over the whole json body", + "in" : "header", + "name" : "Content-MD5", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The user ID of the DCAE Designer. This user must also have Designer role in SDC", + "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" + } + }, { + "description" : "The requested asset type", + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources,services" ] + } + }, { + "description" : "The uuid of the asset as published in the metadata", + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + } + } + }, + "description" : "Artifact uploaded" + }, + "400" : { + "description" : "Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "404" : { + "description" : "Specified resource is not found - SVC4063" + }, + "405" : { + "description" : "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "uploads of artifact to a resource or service", + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}" : { + "delete" : { + "description" : "deletes an artifact of a resource or service", + "operationId" : "deleteArtifact", + "parameters" : [ { + "description" : "The user ID of the DCAE Designer. This user must also have Designer role in SDC", + "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" + } + }, { + "description" : "The requested asset type", + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources,services" ] + } + }, { + "description" : "The uuid of the asset as published in the metadata", + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation", + "in" : "path", + "name" : "artifactUUID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + } + } + }, + "description" : "Artifact deleted" + }, + "400" : { + "description" : "Artifact name is missing in input - SVC4128" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "Asset is being edited by different user. Only one user can checkout and edit an asset on given time. The asset will be available for checkout after the other user will checkin the asset - SVC4086" + }, + "404" : { + "description" : "Specified resource is not found - SVC4063" + }, + "405" : { + "description" : "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050" + }, + "409" : { + "description" : "Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000" + }, + "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" + } + } + } + } + } + } + } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "deletes an artifact of a resource or service", + "tags" : [ "SDCE-7 APIs" ] + }, + "get" : { + "description" : "Download component artifact", + "operationId" : "downloadComponentArtifact", + "parameters" : [ { + "description" : "The user ID of the DCAE Designer. This user must also have Designer role in SDC", + "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" + } + }, { + "description" : "The requested asset type", + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources,services" ] + } + }, { + "description" : "The uuid of the asset as published in the metadata", + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation", + "in" : "path", + "name" : "artifactUUID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "description" : "Artifact downloaded" + }, + "400" : { + "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "404" : { + "description" : "Artifact was not found - SVC4505" + }, + "405" : { + "description" : "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "Returns downloaded artifact", + "tags" : [ "SDCE-7 APIs" ] + }, + "post" : { + "description" : "updates an artifact on a resource or service", + "operationId" : "updateArtifact", + "parameters" : [ { + "description" : "Determines the format of the body of the request", + "in" : "header", + "name" : "Content-Type", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The value for this header must be the MD5 checksum over the whole json body", + "in" : "header", + "name" : "Content-MD5", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The user ID of the DCAE Designer. This user must also have Designer role in SDC", + "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" + } + }, { + "description" : "The requested asset type", + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources,services" ] + } + }, { + "description" : "The uuid of the asset as published in the metadata", + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation", + "in" : "path", + "name" : "artifactUUID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + } + } + }, + "description" : "Artifact updated" + }, + "400" : { + "description" : "Artifact name is missing in input - SVC4128" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "Asset is being edited by different user. Only one user can checkout and edit an asset on given time. The asset will be available for checkout after the other user will checkin the asset - SVC4086" + }, + "404" : { + "description" : "Specified resource is not found - SVC4063" + }, + "405" : { + "description" : "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050" + }, + "409" : { + "description" : "Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "uploads of artifact to a resource or service", + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/{assetType}/{uuid}/interfaces/{interfaceUUID}/operations/{operationUUID}/artifacts/{artifactUUID}" : { + "post" : { + "description" : "uploads of artifact to VF operation workflow", + "operationId" : "uploadInterfaceOperationArtifact", + "parameters" : [ { + "description" : "Determines the format of the body of the request", + "in" : "header", + "name" : "Content-Type", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The value for this header must be the MD5 checksum over the whole json body", + "in" : "header", + "name" : "Content-MD5", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The user ID of the DCAE Designer. This user must also have Designer role in SDC", + "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" + } + }, { + "description" : "Asset type", + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The uuid of the asset as published in the metadata", + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The uuid of the interface", + "in" : "path", + "name" : "interfaceUUID", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The uuid of the operation", + "in" : "path", + "name" : "operationUUID", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The uuid of the artifact", + "in" : "path", + "name" : "artifactUUID", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + } + } + }, + "description" : "Artifact uploaded" + }, + "400" : { + "description" : "Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "404" : { + "description" : "Specified resource is not found - SVC4063" + }, + "405" : { + "description" : "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "uploads of artifact to VF operation workflow", + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/{assetType}/{uuid}/lifecycleState/{lifecycleOperation}" : { + "post" : { + "description" : "Change Resource lifecycle State", + "operationId" : "changeResourceStateExternal", + "parameters" : [ { + "description" : "Determines the format of the body of the request", + "in" : "header", + "name" : "Content-Type", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "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" + } + }, { + "in" : "path", + "name" : "lifecycleOperation", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "checkout, checkin" ] + } + }, { + "description" : "id of component to be changed", + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "validValues: resources / services ", + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AssetMetadata" + } + } + } + }, + "description" : "Resource state changed" + }, + "400" : { + "description" : "Missing X-ECOMP-InstanceID HTTP header - POL5001" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "Asset is being edited by different user. Only one user can checkout and edit an asset on given time. The asset will be available for checkout after the other user will checkin the asset - SVC4080" + }, + "404" : { + "description" : "Error: Requested '%1' (uuid) resource was not found - SVC4063" + }, + "405" : { + "description" : "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/{assetType}/{uuid}/metadata" : { + "get" : { + "description" : "Detailed metadata of asset by uuid", + "operationId" : "getAssetSpecificMetadataByUuidExternal", + "parameters" : [ { + "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" + } + }, { + "description" : "The requested asset type", + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + }, { + "description" : "The requested asset uuid", + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AssetMetadata" + } + } + } + }, + "description" : "ECOMP component is authenticated and list of Catalog Assets Metadata is returned" + }, + "400" : { + "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "404" : { + "description" : "Error: Requested '%1' (uuid) resource was not found - SVC4063" + }, + "405" : { + "description" : "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "Returns detailed metadata of an asset by uuid", + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/{assetType}/{uuid}/resourceInstances/{componentInstanceName}/externalReferences/{objectType}" : { + "post" : { + "operationId" : "addComponentInstanceExternalRef", + "parameters" : [ { + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-ECOMP-InstanceID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ExternalRefDTO" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/{assetType}/{uuid}/resourceInstances/{componentInstanceName}/externalReferences/{objectType}/{oldRefValue}" : { + "put" : { + "operationId" : "updateComponentInstanceReference", + "parameters" : [ { + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "oldRefValue", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-ECOMP-InstanceID", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ExternalRefDTO" + } + } + } + }, + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/{assetType}/{uuid}/resourceInstances/{componentInstanceName}/externalReferences/{objectType}/{reference}" : { + "delete" : { + "operationId" : "deleteComponentInstanceReference", + "parameters" : [ { + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "reference", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-ECOMP-InstanceID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts" : { + "post" : { + "description" : "uploads an artifact to a resource instance", + "operationId" : "uploadArtifactToInstance", + "parameters" : [ { + "description" : "Determines the format of the body of the request", + "in" : "header", + "name" : "Content-Type", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The value for this header must be the MD5 checksum over the whole json body", + "in" : "header", + "name" : "Content-MD5", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The user ID of the DCAE Designer. This user must also have Designer role in SDC", + "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" + } + }, { + "description" : "The requested asset type", + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources,services" ] + } + }, { + "description" : "The uuid of the asset as published in the metadata", + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources,services" ] + } + }, { + "description" : "The component instance name (as publishedin the response of the detailed query)", + "in" : "path", + "name" : "resourceInstanceName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + } + } + }, + "description" : "Artifact uploaded" + }, + "400" : { + "description" : "Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "404" : { + "description" : "Specified resource is not found - SVC4063" + }, + "405" : { + "description" : "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "uploads an artifact to a resource instance", + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}" : { + "delete" : { + "description" : "deletes an artifact of a resource insatnce", + "operationId" : "deleteArtifactOnResourceInstance", + "parameters" : [ { + "description" : "The user ID of the DCAE Designer. This user must also have Designer role in SDC", + "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" + } + }, { + "description" : "The requested asset type", + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources,services" ] + } + }, { + "description" : "The uuid of the asset as published in the metadata", + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation", + "in" : "path", + "name" : "artifactUUID", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The component instance name (as publishedin the response of the detailed query)", + "in" : "path", + "name" : "resourceInstanceName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + } + } + }, + "description" : "Artifact deleted" + }, + "400" : { + "description" : "Artifact name is missing in input - SVC4128" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "Asset is being edited by different user. Only one user can checkout and edit an asset on given time. The asset will be available for checkout after the other user will checkin the asset - SVC4086" + }, + "404" : { + "description" : "Specified resource is not found - SVC4063" + }, + "405" : { + "description" : "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050" + }, + "409" : { + "description" : "Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000" + }, + "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" + } + } + } + } + } + } + } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "deletes an artifact of a resource insatnce", + "tags" : [ "SDCE-7 APIs" ] + }, + "get" : { + "description" : "Download resource instance artifact", + "operationId" : "downloadResourceInstanceArtifact", + "parameters" : [ { + "description" : "The user ID of the DCAE Designer. This user must also have Designer role in SDC", + "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" + } + }, { + "description" : "The requested asset type", + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The uuid of the asset as published in the metadata", + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation", + "in" : "path", + "name" : "artifactUUID", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The component instance name (as publishedin the response of the detailed query)", + "in" : "path", + "name" : "resourceInstanceName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "description" : "Artifact downloaded" + }, + "400" : { + "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "404" : { + "description" : "Artifact was not found - SVC4505" + }, + "405" : { + "description" : "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000" + }, + "default" : { + "content" : { + "application/octet-stream" : { + "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" + } + } + } + } + } + } + } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "Returns downloaded artifact", + "tags" : [ "SDCE-7 APIs" ] + }, + "post" : { + "description" : "updates an artifact on a resource instance", + "operationId" : "updateArtifactOnResourceInstance", + "parameters" : [ { + "description" : "Determines the format of the body of the request", + "in" : "header", + "name" : "Content-Type", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The value for this header must be the MD5 checksum over the whole json body", + "in" : "header", + "name" : "Content-MD5", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The user ID of the DCAE Designer. This user must also have Designer role in SDC", + "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" + } + }, { + "description" : "The requested asset type", + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources,services" ] + } + }, { + "description" : "The uuid of the asset as published in the metadata", + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation", + "in" : "path", + "name" : "artifactUUID", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The component instance name (as publishedin the response of the detailed query)", + "in" : "path", + "name" : "resourceInstanceName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + } + } + }, + "description" : "Artifact updated" + }, + "400" : { + "description" : "Artifact name is missing in input - SVC4128" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "Asset is being edited by different user. Only one user can checkout and edit an asset on given time. The asset will be available for checkout after the other user will checkin the asset - SVC4086" + }, + "404" : { + "description" : "Specified resource is not found - SVC4063" + }, + "405" : { + "description" : "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050" + }, + "409" : { + "description" : "Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "uploads of artifact to a resource or service", + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/{assetType}/{uuid}/toscaModel" : { + "get" : { + "description" : "Fetch assets CSAR", + "operationId" : "getToscaModelExternal", + "parameters" : [ { + "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" + } + }, { + "description" : "The requested asset type", + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "resources", "services" ] + } + }, { + "description" : "The requested asset uuid", + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "description" : "ECOMP component is authenticated and list of Catalog Assets Metadata is returned" + }, + "400" : { + "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "404" : { + "description" : "Error: Requested '%1' (uuid) resource was not found - SVC4063" + }, + "405" : { + "description" : "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000" + }, + "default" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "Returns asset csar", + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/{assetType}/{uuid}/version/{version}/externalReferences/{objectType}" : { + "get" : { + "operationId" : "getAssetExternalRefByObjectType", + "parameters" : [ { + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-ECOMP-InstanceID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/catalog/{assetType}/{uuid}/version/{version}/resourceInstances/{componentInstanceName}/externalReferences/{objectType}" : { + "get" : { + "operationId" : "getComponentInstanceExternalRef", + "parameters" : [ { + "in" : "path", + "name" : "assetType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "uuid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "componentInstanceName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "USER_ID", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-ECOMP-InstanceID", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "content" : { + "application/json" : { } + }, + "description" : "default response" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "tags" : [ "SDCE-7 APIs" ] + } + }, + "/v1/distributionKafkaData" : { + "get" : { + "description" : "Kafka data", + "operationId" : "getKafkaData", + "parameters" : [ { + "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" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/KafkaDataResponse" + } + } + } + }, + "description" : "ECOMP component is authenticated and kafka endpoint and topic list is returned" + }, + "400" : { + "description" : "Missing 'X-ECOMP-InstanceID' HTTP header - POL5001" + }, + "401" : { + "description" : "ECOMP component should authenticate itself and to re-send again HTTP request with its credentials for Basic Authentication - POL5002" + }, + "403" : { + "description" : "ECOMP component is not authorized - POL5003" + }, + "405" : { + "description" : "Method Not Allowed: Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050" + }, + "500" : { + "description" : "The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000" + } + }, + "servers" : [ { + "url" : "/sdc", + "variables" : { } + } ], + "summary" : "return the kafka cluster and topic list", + "tags" : [ "SDCE-6 APIs" ] + } + } + }, + "components" : { + "schemas" : { + "AbstractResourceInfo" : { + "type" : "object", + "properties" : { + "abstractResourceName" : { + "type" : "string" + }, + "abstractResourceUUid" : { + "type" : "string" + }, + "abstractResourceUniqueId" : { + "type" : "string" + }, + "componentInstancesRelations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementCapabilityRelDef" + } + } + } + }, + "AbstractTemplateInfo" : { + "type" : "object", + "properties" : { + "abstractResourceInfoList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AbstractResourceInfo" + } + }, + "isAbstractTemplate" : { + "type" : "boolean" + }, + "serviceUUid" : { + "type" : "string" + }, + "serviceUniqueId" : { + "type" : "string" + } + } + }, + "AdditionalInfoParameterInfo" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "key" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "AdditionalInformationDefinition" : { + "type" : "object", + "properties" : { + "creationTime" : { + "type" : "integer", + "format" : "int64" + }, + "empty" : { + "type" : "boolean" + }, + "lastCreatedCounter" : { + "type" : "integer", + "format" : "int32" + }, + "modificationTime" : { + "type" : "integer", + "format" : "int64" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parameters" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AdditionalInfoParameterInfo" + } + }, + "parentUniqueId" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "Annotation" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + } + }, + "type" : { + "type" : "string" + } + } + }, + "ArtifactDataDefinition" : { + "type" : "object", + "properties" : { + "apiUrl" : { + "type" : "string" + }, + "artifactChecksum" : { + "type" : "string" + }, + "artifactCreator" : { + "type" : "string" + }, + "artifactDisplayName" : { + "type" : "string" + }, + "artifactGroupType" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "DEPLOYMENT", "LIFE_CYCLE", "SERVICE_API", "TOSCA", "OTHER" ] + }, + "artifactLabel" : { + "type" : "string" + }, + "artifactName" : { + "type" : "string" + }, + "artifactRef" : { + "type" : "string" + }, + "artifactRepository" : { + "type" : "string" + }, + "artifactType" : { + "type" : "string" + }, + "artifactUUID" : { + "type" : "string" + }, + "artifactVersion" : { + "type" : "string" + }, + "creationDate" : { + "type" : "integer", + "format" : "int64" + }, + "creatorFullName" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "duplicated" : { + "type" : "boolean" + }, + "empty" : { + "type" : "boolean" + }, + "esId" : { + "type" : "string" + }, + "generated" : { + "type" : "boolean" + }, + "generatedFromId" : { + "type" : "string" + }, + "heatEnvType" : { + "type" : "boolean" + }, + "heatParameters" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HeatParameterDataDefinition" + } + }, + "heatParamsUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "isFromCsar" : { + "type" : "boolean" + }, + "lastUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "mandatory" : { + "type" : "boolean" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "payloadUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + } + }, + "requiredArtifacts" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "serviceApi" : { + "type" : "boolean" + }, + "timeout" : { + "type" : "integer", + "format" : "int32" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "updaterFullName" : { + "type" : "string" + }, + "userIdCreator" : { + "type" : "string" + }, + "userIdLastUpdater" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ArtifactDefinition" : { + "type" : "object", + "properties" : { + "apiUrl" : { + "type" : "string" + }, + "artifactChecksum" : { + "type" : "string" + }, + "artifactCreator" : { + "type" : "string" + }, + "artifactDisplayName" : { + "type" : "string" + }, + "artifactGroupType" : { + "type" : "string", + "enum" : [ "INFORMATIONAL", "DEPLOYMENT", "LIFE_CYCLE", "SERVICE_API", "TOSCA", "OTHER" ] + }, + "artifactLabel" : { + "type" : "string" + }, + "artifactName" : { + "type" : "string" + }, + "artifactRef" : { + "type" : "string" + }, + "artifactRepository" : { + "type" : "string" + }, + "artifactType" : { + "type" : "string" + }, + "artifactUUID" : { + "type" : "string" + }, + "artifactVersion" : { + "type" : "string" + }, + "creationDate" : { + "type" : "integer", + "format" : "int64" + }, + "creatorFullName" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "duplicated" : { + "type" : "boolean" + }, + "empty" : { + "type" : "boolean" + }, + "esId" : { + "type" : "string" + }, + "generated" : { + "type" : "boolean" + }, + "generatedFromId" : { + "type" : "string" + }, + "heatEnvType" : { + "type" : "boolean" + }, + "heatParamUpdated" : { + "type" : "boolean" + }, + "heatParameters" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HeatParameterDataDefinition" + } + }, + "heatParamsUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "isFromCsar" : { + "type" : "boolean" + }, + "lastUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "listHeatParameters" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/HeatParameterDefinition" + } + }, + "mandatory" : { + "type" : "boolean" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "payload" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte" + }, + "writeOnly" : true + }, + "payloadData" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte" + } + }, + "payloadUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + } + }, + "requiredArtifacts" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "serviceApi" : { + "type" : "boolean" + }, + "timeout" : { + "type" : "integer", + "format" : "int32" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "updaterFullName" : { + "type" : "string" + }, + "userIdCreator" : { + "type" : "string" + }, + "userIdLastUpdater" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "AssetMetadata" : { + "type" : "object", + "properties" : { + "invariantUUID" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "toscaModelURL" : { + "type" : "string" + }, + "uuid" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "AttributeDefinition" : { + "type" : "object", + "properties" : { + "attributeId" : { + "type" : "string" + }, + "defaultValue" : { + "type" : "string" + }, + "definition" : { + "type" : "boolean" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "entry_schema" : { + "$ref" : "#/components/schemas/EntrySchema" + }, + "getOutputAttribute" : { + "type" : "boolean" + }, + "getOutputValues" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GetOutputValueDataDefinition" + } + }, + "get_default" : { + "type" : "object" + }, + "instanceUniqueId" : { + "type" : "string" + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "outputId" : { + "type" : "string" + }, + "outputPath" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentUniqueId" : { + "type" : "string" + }, + "schema" : { + "$ref" : "#/components/schemas/SchemaDefinition" + }, + "schemaType" : { + "type" : "string" + }, + "status" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "CINodeFilterDataDefinition" : { + "type" : "object", + "properties" : { + "capabilities" : { + "$ref" : "#/components/schemas/ListDataDefinitionRequirementNodeFilterCapabilityDataDefinition" + }, + "empty" : { + "type" : "boolean" + }, + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "properties" : { + "$ref" : "#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition" + }, + "tosca_id" : { + "type" : "object" + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "CapabilityDataDefinition" : { + "type" : "object", + "properties" : { + "capabilitySources" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "external" : { + "type" : "boolean" + }, + "externalName" : { + "type" : "string" + }, + "leftOccurrences" : { + "type" : "string" + }, + "maxOccurrences" : { + "type" : "string" + }, + "minOccurrences" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "ownerName" : { + "type" : "string" + }, + "ownerType" : { + "type" : "string", + "enum" : [ "GROUP", "COMPONENT_INSTANCE", "RESOURCE" ] + }, + "parentName" : { + "type" : "string" + }, + "path" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "previousName" : { + "type" : "string" + }, + "source" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "validSourceTypes" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "version" : { + "type" : "string" + } + } + }, + "CapabilityDefinition" : { + "type" : "object", + "properties" : { + "capabilitySources" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "external" : { + "type" : "boolean" + }, + "externalName" : { + "type" : "string" + }, + "leftOccurrences" : { + "type" : "string" + }, + "maxOccurrences" : { + "type" : "string" + }, + "minOccurrences" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "ownerName" : { + "type" : "string" + }, + "ownerType" : { + "type" : "string", + "enum" : [ "GROUP", "COMPONENT_INSTANCE", "RESOURCE" ] + }, + "ownerTypeIfEmpty" : { + "type" : "string", + "enum" : [ "GROUP", "COMPONENT_INSTANCE", "RESOURCE" ], + "writeOnly" : true + }, + "parentName" : { + "type" : "string" + }, + "path" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "previousName" : { + "type" : "string" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceProperty" + } + }, + "source" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "validSourceTypes" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "version" : { + "type" : "string" + } + } + }, + "CapabilityRequirementRelationship" : { + "type" : "object", + "properties" : { + "capability" : { + "$ref" : "#/components/schemas/CapabilityDataDefinition" + }, + "operations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OperationUi" + } + }, + "relation" : { + "$ref" : "#/components/schemas/RelationshipInfo" + }, + "requirement" : { + "$ref" : "#/components/schemas/RequirementDataDefinition" + } + } + }, + "CategoryDefinition" : { + "type" : "object", + "properties" : { + "displayName" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "icons" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "metadataKeys" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MetadataKeyDataDefinition" + } + }, + "models" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "name" : { + "type" : "string" + }, + "normalizedName" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "subcategories" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubCategoryDefinition" + } + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "useServiceSubstitutionForNestedServices" : { + "type" : "boolean" + }, + "version" : { + "type" : "string" + } + } + }, + "ComponentInstance" : { + "type" : "object", + "properties" : { + "actualComponentUid" : { + "type" : "string" + }, + "artifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + }, + "attributeValueCounter" : { + "type" : "integer", + "format" : "int32" + }, + "attributes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AttributeDefinition" + } + }, + "capabilities" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CapabilityDefinition" + } + } + }, + "componentMetadataForSupportLog" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "componentName" : { + "type" : "string" + }, + "componentUid" : { + "type" : "string" + }, + "componentVersion" : { + "type" : "string" + }, + "createdFrom" : { + "type" : "string", + "enum" : [ "UI", "CSAR" ] + }, + "createdFromCsar" : { + "type" : "boolean" + }, + "creationTime" : { + "type" : "integer", + "format" : "int64" + }, + "customizationUUID" : { + "type" : "string" + }, + "deploymentArtifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + }, + "description" : { + "type" : "string" + }, + "directives" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "empty" : { + "type" : "boolean" + }, + "groupInstances" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupInstance" + } + }, + "icon" : { + "type" : "string" + }, + "inputValueCounter" : { + "type" : "integer", + "format" : "int32" + }, + "inputs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/InputDefinition" + } + }, + "instanceCount" : { + "type" : "string" + }, + "interfaces" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "invariantName" : { + "type" : "string" + }, + "isProxy" : { + "type" : "boolean" + }, + "maxOccurrences" : { + "type" : "string" + }, + "minOccurrences" : { + "type" : "string" + }, + "modificationTime" : { + "type" : "integer", + "format" : "int64" + }, + "name" : { + "type" : "string" + }, + "nodeFilter" : { + "$ref" : "#/components/schemas/CINodeFilterDataDefinition" + }, + "normalizedName" : { + "type" : "string" + }, + "originArchived" : { + "type" : "boolean" + }, + "originType" : { + "type" : "string", + "enum" : [ "PRODUCT", "SERVICE", "VF", "VFC", "CP", "VL", "Configuration", "VFCMT", "CVFC", "PNF", "CR", "ServiceProxy", "ServiceSubstitution" ] + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "posX" : { + "type" : "string" + }, + "posY" : { + "type" : "string" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDefinition" + } + }, + "propertyValueCounter" : { + "type" : "integer", + "format" : "int32" + }, + "requirements" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementDefinition" + } + } + }, + "serviceSubstitution" : { + "type" : "boolean" + }, + "sourceModelInvariant" : { + "type" : "string" + }, + "sourceModelName" : { + "type" : "string" + }, + "sourceModelUid" : { + "type" : "string" + }, + "sourceModelUuid" : { + "type" : "string" + }, + "toscaArtifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ToscaArtifactDataDefinition" + } + }, + "toscaComponentName" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ComponentInstanceAttribute" : { + "type" : "object", + "properties" : { + "attributeId" : { + "type" : "string" + }, + "componentInstanceId" : { + "type" : "string" + }, + "componentInstanceName" : { + "type" : "string" + }, + "defaultValue" : { + "type" : "string" + }, + "definition" : { + "type" : "boolean" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "entry_schema" : { + "$ref" : "#/components/schemas/EntrySchema" + }, + "getOutputAttribute" : { + "type" : "boolean" + }, + "getOutputValues" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GetOutputValueDataDefinition" + } + }, + "get_default" : { + "type" : "object" + }, + "instanceUniqueId" : { + "type" : "string" + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "outputId" : { + "type" : "string" + }, + "outputPath" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentUniqueId" : { + "type" : "string" + }, + "path" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "rules" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyRule" + } + }, + "schema" : { + "$ref" : "#/components/schemas/SchemaDefinition" + }, + "schemaType" : { + "type" : "string" + }, + "status" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "value" : { + "type" : "string" + }, + "valueUniqueUid" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ComponentInstanceInput" : { + "type" : "object", + "properties" : { + "annotations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Annotation" + } + }, + "annotationsToInput" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Annotation" + }, + "writeOnly" : true + }, + "componentInstanceId" : { + "type" : "string" + }, + "componentInstanceName" : { + "type" : "string" + }, + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyConstraint" + } + }, + "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" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "path" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceProperty" + } + }, + "propertyConstraints" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "propertyId" : { + "type" : "string" + }, + "required" : { + "type" : "boolean" + }, + "rules" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyRule" + } + }, + "schema" : { + "$ref" : "#/components/schemas/SchemaDefinition" + }, + "schemaProperty" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + }, + "schemaType" : { + "type" : "string" + }, + "status" : { + "type" : "string" + }, + "subPropertyInputPath" : { + "type" : "string" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "valueUniqueUid" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ComponentInstanceInterface" : { + "type" : "object", + "properties" : { + "creationDate" : { + "type" : "integer", + "format" : "int64" + }, + "definition" : { + "type" : "boolean" + }, + "derivedFrom" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "inputs" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/InputDataDefinition" + } + }, + "interfaceId" : { + "type" : "string" + }, + "interfaceInstanceDataDefinition" : { + "$ref" : "#/components/schemas/InterfaceInstanceDataDefinition" + }, + "lastUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "model" : { + "type" : "string" + }, + "operations" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/OperationDataDefinition" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "toscaResourceName" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "version" : { + "type" : "string" + } + } + }, + "ComponentInstanceOutput" : { + "type" : "object", + "properties" : { + "attribute" : { + "$ref" : "#/components/schemas/ComponentInstanceAttribute" + }, + "attributeId" : { + "type" : "string" + }, + "componentInstanceId" : { + "type" : "string" + }, + "componentInstanceName" : { + "type" : "string" + }, + "defaultValue" : { + "type" : "string" + }, + "definition" : { + "type" : "boolean" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "entry_schema" : { + "$ref" : "#/components/schemas/EntrySchema" + }, + "getOutputAttribute" : { + "type" : "boolean" + }, + "getOutputValues" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GetOutputValueDataDefinition" + } + }, + "get_default" : { + "type" : "object" + }, + "instanceUniqueId" : { + "type" : "string" + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "outputId" : { + "type" : "string" + }, + "outputPath" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentUniqueId" : { + "type" : "string" + }, + "path" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "rules" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyRule" + } + }, + "schema" : { + "$ref" : "#/components/schemas/SchemaDefinition" + }, + "schemaType" : { + "type" : "string" + }, + "status" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "value" : { + "type" : "string" + }, + "valueUniqueUid" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ComponentInstanceProperty" : { + "type" : "object", + "properties" : { + "annotations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Annotation" + } + }, + "componentInstanceId" : { + "type" : "string" + }, + "componentInstanceName" : { + "type" : "string" + }, + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyConstraint" + } + }, + "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" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "path" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "propertyConstraints" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "propertyId" : { + "type" : "string" + }, + "required" : { + "type" : "boolean" + }, + "rules" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyRule" + } + }, + "schema" : { + "$ref" : "#/components/schemas/SchemaDefinition" + }, + "schemaProperty" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + }, + "schemaType" : { + "type" : "string" + }, + "status" : { + "type" : "string" + }, + "subPropertyInputPath" : { + "type" : "string" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "valueUniqueUid" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "Constraint" : { + "type" : "object", + "properties" : { + "equal" : { + "type" : "object" + }, + "greater_or_equal" : { + "type" : "object" + }, + "greater_than" : { + "type" : "object" + }, + "in_range" : { + "type" : "array", + "items" : { + "type" : "object" + } + }, + "length" : { + "type" : "integer", + "format" : "int32" + }, + "less_or_equal" : { + "type" : "object" + }, + "less_than" : { + "type" : "object" + }, + "max_length" : { + "type" : "integer", + "format" : "int32" + }, + "min_length" : { + "type" : "integer", + "format" : "int32" + }, + "pattern" : { + "type" : "object" + }, + "valid_values" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + } + }, + "DataTypeDefinition" : { + "type" : "object", + "properties" : { + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyConstraint" + } + }, + "creationTime" : { + "type" : "integer", + "format" : "int64" + }, + "derivedFrom" : { + "$ref" : "#/components/schemas/DataTypeDefinition" + }, + "derivedFromName" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "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" + } + }, + "propertiesData" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + } + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "EntrySchema" : { + "type" : "object", + "properties" : { + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Constraint" + } + }, + "description" : { + "type" : "string" + }, + "type" : { + "type" : "string" + } + } + }, + "ExternalRefDTO" : { + "type" : "object", + "properties" : { + "referenceUUID" : { + "type" : "string" + } + } + }, + "GetInputValueDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "getInputIndex" : { + "$ref" : "#/components/schemas/GetInputValueDataDefinition" + }, + "indexValue" : { + "type" : "integer", + "format" : "int32" + }, + "inputId" : { + "type" : "string" + }, + "inputName" : { + "type" : "string" + }, + "inputType" : { + "type" : "string" + }, + "list" : { + "type" : "boolean" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "propName" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "GetOutputValueDataDefinition" : { + "type" : "object", + "properties" : { + "attribName" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "getOutputIndex" : { + "$ref" : "#/components/schemas/GetOutputValueDataDefinition" + }, + "indexValue" : { + "type" : "integer", + "format" : "int32" + }, + "list" : { + "type" : "boolean" + }, + "outputId" : { + "type" : "string" + }, + "outputName" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "GetPolicyValueDataDefinition" : { + "type" : "object", + "properties" : { + "origPropertyValue" : { + "type" : "string" + }, + "policyId" : { + "type" : "string" + }, + "propertyName" : { + "type" : "string" + } + } + }, + "GroupDefinition" : { + "type" : "object", + "properties" : { + "artifacts" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "artifactsUuid" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "capabilities" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CapabilityDefinition" + } + } + }, + "createdFrom" : { + "type" : "string", + "enum" : [ "UI", "CSAR" ] + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "groupUUID" : { + "type" : "string" + }, + "invariantName" : { + "type" : "string" + }, + "invariantUUID" : { + "type" : "string" + }, + "members" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "name" : { + "type" : "string" + }, + "normalizedName" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + } + }, + "propertyValueCounter" : { + "type" : "integer", + "format" : "int32" + }, + "type" : { + "type" : "string" + }, + "typeUid" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userDefined" : { + "type" : "boolean" + }, + "version" : { + "type" : "string" + }, + "vspOriginated" : { + "type" : "boolean" + } + } + }, + "GroupInstance" : { + "type" : "object", + "properties" : { + "artifacts" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "artifactsUuid" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "creationTime" : { + "type" : "integer", + "format" : "int64" + }, + "customizationUUID" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "groupInstanceArtifacts" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "groupInstanceArtifactsUuid" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "groupName" : { + "type" : "string" + }, + "groupUUID" : { + "type" : "string" + }, + "groupUid" : { + "type" : "string" + }, + "invariantUUID" : { + "type" : "string" + }, + "modificationTime" : { + "type" : "integer", + "format" : "int64" + }, + "name" : { + "type" : "string" + }, + "normalizedName" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "posX" : { + "type" : "string" + }, + "posY" : { + "type" : "string" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + } + }, + "propertyValueCounter" : { + "type" : "integer", + "format" : "int32" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "GroupingDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "normalizedName" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "HeatParameterDataDefinition" : { + "type" : "object", + "properties" : { + "currentValue" : { + "type" : "string" + }, + "defaultValue" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "HeatParameterDefinition" : { + "type" : "object", + "properties" : { + "currentValue" : { + "type" : "string" + }, + "defaultValue" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "InputDataDefinition" : { + "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" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "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" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "InputDefinition" : { + "type" : "object", + "properties" : { + "annotations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Annotation" + } + }, + "annotationsToInput" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Annotation" + }, + "writeOnly" : true + }, + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyConstraint" + } + }, + "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" + }, + "inputs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceInput" + } + }, + "instanceUniqueId" : { + "type" : "string" + }, + "isDeclaredListInput" : { + "type" : "boolean" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceProperty" + } + }, + "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" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "InterfaceDefinition" : { + "type" : "object", + "properties" : { + "creationDate" : { + "type" : "integer", + "format" : "int64" + }, + "definition" : { + "type" : "boolean" + }, + "derivedFrom" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "inputs" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/InputDataDefinition" + } + }, + "lastUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "model" : { + "type" : "string" + }, + "operations" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/OperationDataDefinition" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "toscaResourceName" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "version" : { + "type" : "string" + } + } + }, + "InterfaceInstanceDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "inputs" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "operations" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/OperationInstance" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "KafkaDataResponse" : { + "type" : "object", + "properties" : { + "distrNotificationTopicName" : { + "type" : "string" + }, + "distrStatusTopicName" : { + "type" : "string" + }, + "kafkaBootStrapServer" : { + "type" : "string" + } + } + }, + "ListDataDefinitionOperationInputDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "listToscaDataDefinition" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OperationInputDefinition" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ListDataDefinitionOperationOutputDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "listToscaDataDefinition" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OperationOutputDefinition" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ListDataDefinitionPropertyFilterDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "listToscaDataDefinition" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyFilterDataDefinition" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ListDataDefinitionRequirementNodeFilterCapabilityDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "listToscaDataDefinition" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementNodeFilterCapabilityDataDefinition" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ListDataDefinitionRequirementSubstitutionFilterCapabilityDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "listToscaDataDefinition" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementSubstitutionFilterCapabilityDataDefinition" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ListDataDefinitionSubstitutionFilterPropertyDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "listToscaDataDefinition" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubstitutionFilterPropertyDataDefinition" + } + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "MetadataKeyDataDefinition" : { + "type" : "object", + "properties" : { + "defaultValue" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "mandatory" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "validValues" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "version" : { + "type" : "string" + } + } + }, + "OperationDataDefinition" : { + "type" : "object", + "properties" : { + "creationDate" : { + "type" : "integer", + "format" : "int64" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "implementation" : { + "$ref" : "#/components/schemas/ArtifactDataDefinition" + }, + "inputs" : { + "$ref" : "#/components/schemas/ListDataDefinitionOperationInputDefinition" + }, + "lastUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "name" : { + "type" : "string" + }, + "outputs" : { + "$ref" : "#/components/schemas/ListDataDefinitionOperationOutputDefinition" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + }, + "workflowAssociationType" : { + "type" : "string" + }, + "workflowId" : { + "type" : "string" + }, + "workflowName" : { + "type" : "string" + }, + "workflowVersion" : { + "type" : "string" + }, + "workflowVersionId" : { + "type" : "string" + } + } + }, + "OperationImplementation" : { + "type" : "object", + "properties" : { + "dependencies" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "primary" : { + "type" : "string" + } + } + }, + "OperationInputDefinition" : { + "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" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "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" + }, + "source" : { + "type" : "string" + }, + "sourceProperty" : { + "type" : "string" + }, + "status" : { + "type" : "string" + }, + "subPropertyInputPath" : { + "type" : "string" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "toscaDefaultValue" : { + "type" : "string" + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "OperationInstance" : { + "type" : "object", + "properties" : { + "implementation" : { + "$ref" : "#/components/schemas/OperationImplementation" + }, + "inputs" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + } + } + }, + "OperationOutputDefinition" : { + "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" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "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" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "OperationUi" : { + "type" : "object", + "properties" : { + "implementation" : { + "type" : "object" + }, + "inputs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyAssignmentUi" + } + }, + "interfaceType" : { + "type" : "string" + }, + "operationType" : { + "type" : "string" + } + } + }, + "OutputDefinition" : { + "type" : "object", + "properties" : { + "attribute" : { + "$ref" : "#/components/schemas/ComponentInstanceAttribute" + }, + "attributeId" : { + "type" : "string" + }, + "defaultValue" : { + "type" : "string" + }, + "definition" : { + "type" : "boolean" + }, + "description" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "entry_schema" : { + "$ref" : "#/components/schemas/EntrySchema" + }, + "getOutputAttribute" : { + "type" : "boolean" + }, + "getOutputValues" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GetOutputValueDataDefinition" + } + }, + "get_default" : { + "type" : "object" + }, + "instanceUniqueId" : { + "type" : "string" + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "outputId" : { + "type" : "string" + }, + "outputPath" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentUniqueId" : { + "type" : "string" + }, + "schema" : { + "$ref" : "#/components/schemas/SchemaDefinition" + }, + "schemaType" : { + "type" : "string" + }, + "status" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "PolicyDefinition" : { + "type" : "object", + "properties" : { + "annotations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Annotation" + } + }, + "componentName" : { + "type" : "string" + }, + "defaultValue" : { + "type" : "string" + }, + "definition" : { + "type" : "boolean" + }, + "derivedFrom" : { + "type" : "string" + }, + "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" + }, + "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" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "targets" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "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" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "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" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "PropertyDefinition" : { + "type" : "object", + "properties" : { + "annotations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Annotation" + } + }, + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyConstraint" + } + }, + "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" + }, + "label" : { + "type" : "string" + }, + "mappedToComponentProperty" : { + "type" : "boolean" + }, + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "parentPropertyType" : { + "type" : "string" + }, + "parentUniqueId" : { + "type" : "string" + }, + "password" : { + "type" : "boolean" + }, + "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" + }, + "subPropertyToscaFunctions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SubPropertyToscaFunction" + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + }, + "toscaGetFunction" : { + "$ref" : "#/components/schemas/ToscaGetFunctionDataDefinition" + }, + "toscaGetFunctionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "userCreated" : { + "type" : "boolean" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "PropertyFilterConstraintDataDefinition" : { + "type" : "object", + "properties" : { + "capabilityName" : { + "type" : "string" + }, + "operator" : { + "type" : "string", + "enum" : [ "EQUAL", "IN_RANGE", "GREATER_THAN", "GREATER_OR_EQUAL", "LESS_OR_EQUAL", "LENGTH", "MIN_LENGTH", "MAX_LENGTH", "VALID_VALUES", "LESS_THAN", "PATTERN", "SCHEMA" ] + }, + "propertyName" : { + "type" : "string" + }, + "targetType" : { + "type" : "string", + "enum" : [ "CAPABILITY", "PROPERTY" ] + }, + "value" : { + "type" : "object" + }, + "valueType" : { + "type" : "string", + "enum" : [ "STATIC", "GET_PROPERTY", "GET_INPUT", "GET_ATTRIBUTE", "YAML", "CONCAT" ] + } + } + }, + "PropertyFilterDataDefinition" : { + "type" : "object", + "properties" : { + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyFilterConstraintDataDefinition" + } + }, + "empty" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "PropertyRule" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "rule" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string" + }, + "value" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "RelationshipImpl" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string" + } + } + }, + "RelationshipInfo" : { + "type" : "object", + "properties" : { + "capability" : { + "type" : "string" + }, + "capabilityOwnerId" : { + "type" : "string" + }, + "capabilityUid" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "relationship" : { + "$ref" : "#/components/schemas/RelationshipImpl" + }, + "relationships" : { + "$ref" : "#/components/schemas/RelationshipImpl" + }, + "requirement" : { + "type" : "string" + }, + "requirementOwnerId" : { + "type" : "string" + }, + "requirementUid" : { + "type" : "string" + } + } + }, + "RequirementCapabilityRelDef" : { + "type" : "object", + "properties" : { + "fromNode" : { + "type" : "string" + }, + "originUI" : { + "type" : "boolean" + }, + "relationships" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CapabilityRequirementRelationship" + } + }, + "toNode" : { + "type" : "string" + }, + "uid" : { + "type" : "string" + } + } + }, + "RequirementDataDefinition" : { + "type" : "object", + "properties" : { + "capability" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "external" : { + "type" : "boolean" + }, + "externalName" : { + "type" : "string" + }, + "leftOccurrences" : { + "type" : "string" + }, + "maxOccurrences" : { + "type" : "string" + }, + "minOccurrences" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "node" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "ownerName" : { + "type" : "string" + }, + "parentName" : { + "type" : "string" + }, + "path" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "previousName" : { + "type" : "string" + }, + "relationship" : { + "type" : "string" + }, + "source" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "RequirementDefinition" : { + "type" : "object", + "properties" : { + "capability" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "external" : { + "type" : "boolean" + }, + "externalName" : { + "type" : "string" + }, + "leftOccurrences" : { + "type" : "string" + }, + "maxOccurrences" : { + "type" : "string" + }, + "minOccurrences" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "node" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "ownerName" : { + "type" : "string" + }, + "parentName" : { + "type" : "string" + }, + "path" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "previousName" : { + "type" : "string" + }, + "relationship" : { + "type" : "string" + }, + "source" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "RequirementNodeFilterCapabilityDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "properties" : { + "$ref" : "#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition" + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "RequirementSubstitutionFilterCapabilityDataDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "properties" : { + "$ref" : "#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition" + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "Resource" : { + "type" : "object", + "properties" : { + "abstract" : { + "type" : "boolean" + }, + "actualComponentType" : { + "type" : "string" + }, + "additionalInformation" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AdditionalInformationDefinition" + } + }, + "allArtifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + }, + "allVersions" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "archiveTime" : { + "type" : "integer", + "format" : "int64" + }, + "archived" : { + "type" : "boolean" + }, + "artifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + }, + "attributes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AttributeDefinition" + } + }, + "capabilities" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CapabilityDefinition" + } + } + }, + "categories" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CategoryDefinition" + } + }, + "categorySpecificMetadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "componentInstances" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstance" + } + }, + "componentInstancesAttributes" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceAttribute" + } + } + }, + "componentInstancesInputs" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceInput" + } + } + }, + "componentInstancesInterfaces" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceInterface" + } + } + }, + "componentInstancesOutputs" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceOutput" + } + } + }, + "componentInstancesProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentInstanceProperty" + } + } + }, + "componentInstancesRelations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementCapabilityRelDef" + } + }, + "componentMetadataForSupportLog" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "RESOURCE", "SERVICE", "RESOURCE_INSTANCE", "PRODUCT", "SERVICE_INSTANCE" ] + }, + "conformanceLevel" : { + "type" : "string" + }, + "contactId" : { + "type" : "string" + }, + "cost" : { + "type" : "string" + }, + "creationDate" : { + "type" : "integer", + "format" : "int64" + }, + "creatorFullName" : { + "type" : "string" + }, + "creatorUserId" : { + "type" : "string" + }, + "csarUUID" : { + "type" : "string" + }, + "csarVersion" : { + "type" : "string" + }, + "csarVersionId" : { + "type" : "string" + }, + "dataTypes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataTypeDefinition" + } + }, + "deploymentArtifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + }, + "derivedFrom" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "derivedFromGenericInfo" : { + "$ref" : "#/components/schemas/Resource" + }, + "derivedFromGenericType" : { + "type" : "string" + }, + "derivedFromGenericVersion" : { + "type" : "string" + }, + "derivedFromMapOfIdToName" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "derivedList" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "description" : { + "type" : "string" + }, + "groups" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupDefinition" + } + }, + "highestVersion" : { + "type" : "boolean" + }, + "icon" : { + "type" : "string" + }, + "importedToscaChecksum" : { + "type" : "string" + }, + "inputs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/InputDefinition" + } + }, + "interfaces" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/InterfaceDefinition" + } + }, + "invariantUUID" : { + "type" : "string" + }, + "isDeleted" : { + "type" : "boolean" + }, + "lastUpdateDate" : { + "type" : "integer", + "format" : "int64" + }, + "lastUpdaterFullName" : { + "type" : "string" + }, + "lastUpdaterUserId" : { + "type" : "string" + }, + "licenseType" : { + "type" : "string" + }, + "lifecycleState" : { + "type" : "string", + "enum" : [ "CERTIFIED", "NOT_CERTIFIED_CHECKIN", "NOT_CERTIFIED_CHECKOUT" ] + }, + "model" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "nodeFilterComponents" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/CINodeFilterDataDefinition" + } + }, + "normalizedName" : { + "type" : "string" + }, + "outputs" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OutputDefinition" + } + }, + "policies" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PolicyDefinition" + } + }, + "projectCode" : { + "type" : "string" + }, + "properties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyDefinition" + } + }, + "requirements" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RequirementDefinition" + } + } + }, + "resourceType" : { + "type" : "string", + "enum" : [ "VFC", "VF", "CR", "CP", "PNF", "CVFC", "VL", "VFCMT", "Configuration", "ServiceProxy", "ABSTRACT", "SERVICE" ] + }, + "resourceVendorModelNumber" : { + "type" : "string" + }, + "service" : { + "type" : "boolean" + }, + "specificComponetTypeArtifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + }, + "writeOnly" : true + }, + "state" : { + "type" : "string", + "enum" : [ "CERTIFIED", "NOT_CERTIFIED_CHECKIN", "NOT_CERTIFIED_CHECKOUT" ], + "writeOnly" : true + }, + "substitutionFilter" : { + "$ref" : "#/components/schemas/SubstitutionFilterDataDefinition" + }, + "systemName" : { + "type" : "string" + }, + "tags" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "topologyTemplate" : { + "type" : "boolean" + }, + "toscaArtifacts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ArtifactDefinition" + } + }, + "toscaResourceName" : { + "type" : "string" + }, + "toscaType" : { + "type" : "string" + }, + "toscaVersion" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "uuid" : { + "type" : "string" + }, + "vendorName" : { + "type" : "string" + }, + "vendorRelease" : { + "type" : "string" + }, + "version" : { + "type" : "string" + }, + "vspArchived" : { + "type" : "boolean" + } + } + }, + "SchemaDefinition" : { + "type" : "object", + "properties" : { + "constraints" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "derivedFrom" : { + "type" : "string" + }, + "empty" : { + "type" : "boolean" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + } + }, + "property" : { + "$ref" : "#/components/schemas/PropertyDataDefinition" + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "SubCategoryDefinition" : { + "type" : "object", + "properties" : { + "empty" : { + "type" : "boolean" + }, + "groupings" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupingDefinition" + } + }, + "icons" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "metadataKeys" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MetadataKeyDataDefinition" + } + }, + "name" : { + "type" : "string" + }, + "normalizedName" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "uniqueId" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "SubPropertyToscaFunction" : { + "type" : "object", + "properties" : { + "subPropertyPath" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "toscaFunction" : { + "$ref" : "#/components/schemas/ToscaFunction" + } + } + }, + "SubstitutionFilterDataDefinition" : { + "type" : "object", + "properties" : { + "capabilities" : { + "$ref" : "#/components/schemas/ListDataDefinitionRequirementSubstitutionFilterCapabilityDataDefinition" + }, + "empty" : { + "type" : "boolean" + }, + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "properties" : { + "$ref" : "#/components/schemas/ListDataDefinitionSubstitutionFilterPropertyDataDefinition" + }, + "tosca_id" : { + "type" : "object" + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "SubstitutionFilterPropertyDataDefinition" : { + "type" : "object", + "properties" : { + "constraints" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PropertyFilterConstraintDataDefinition" + } + }, + "empty" : { + "type" : "boolean" + }, + "name" : { + "type" : "string" + }, + "ownerId" : { + "type" : "string" + }, + "ownerIdIfEmpty" : { + "type" : "string", + "writeOnly" : true + }, + "type" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ToscaArtifactDataDefinition" : { + "type" : "object", + "properties" : { + "file" : { + "type" : "string" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "type" : { + "type" : "string" + } + } + }, + "ToscaFunction" : { + "type" : "object", + "properties" : { + "jsonObjectValue" : { + "type" : "object" + }, + "type" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE", "CONCAT", "YAML", "STRING" ] + }, + "value" : { + "type" : "string" + } + } + }, + "ToscaGetFunctionDataDefinition" : { + "type" : "object", + "properties" : { + "functionType" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ] + }, + "propertyName" : { + "type" : "string" + }, + "propertyPathFromSource" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "propertySource" : { + "type" : "string", + "enum" : [ "SELF", "INSTANCE" ] + }, + "propertyUniqueId" : { + "type" : "string" + }, + "sourceName" : { + "type" : "string" + }, + "sourceUniqueId" : { + "type" : "string" + }, + "type" : { + "type" : "string", + "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE", "CONCAT", "YAML", "STRING" ] + } + } + } + } + } +}
\ No newline at end of file diff --git a/docs/openapi/openapi-sdce-7.yaml b/docs/openapi/openapi-sdce-7.yaml new file mode 100644 index 0000000000..93681a29ca --- /dev/null +++ b/docs/openapi/openapi-sdce-7.yaml @@ -0,0 +1,5962 @@ +openapi: 3.0.1 +info: + contact: + email: onap-discuss@lists.onap.org + name: ONAP + url: https://onap.readthedocs.io + description: SDC API for retrieval for service models (SDCE-7) + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0 + title: "SPC API: SDCE-7" + version: "1.0" +servers: +- description: SDCE-7 APIs + url: /sdc +paths: + /v1/catalog/abstract/service/serviceUUID/{uuid}/copy: + post: + description: Copy a new service based on the existing service + operationId: copyExistService + 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 + - description: The requested asset uuid + in: path + name: uuid + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AbstractTemplateInfo' + description: ECOMP component is authenticated and list of Catalog Assets + Metadata is returned + "400": + description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "404": + description: "Error: Requested '%1' (uuid) resource was not found - SVC4063" + "405": + description: "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "409": + description: Service already exist + "500": + description: The GET request failed either due to internal SDC problem. + ECOMP Component should continue the attempts to get the needed information + - POL5000 + servers: + - url: /sdc + variables: {} + summary: Return whether the copy service is successful + tags: + - SDCE-7 APIs + /v1/catalog/abstract/service/serviceUUID/{uuid}/status: + get: + description: Fetch abstract status of service + operationId: getServiceAbstractStatus + parameters: + - 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 + - description: The requested asset uuid + in: path + name: uuid + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AbstractTemplateInfo' + description: The check result of whether the service is an abstract service + is returned + "400": + description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "404": + description: "Error: Requested '%1' (uuid) resource was not found - SVC4063" + "405": + description: "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "500": + description: The GET request failed either due to internal SDC problem. + ECOMP Component should continue the attempts to get the needed information + - POL5000 + servers: + - url: /sdc + variables: {} + summary: Return whether the service is a virtual service + tags: + - SDCE-7 APIs + /v1/catalog/services/{serviceName}/{serviceVersion}/artifacts/{artifactName}: + get: + description: Download service artifact + operationId: downloadServiceArtifact + parameters: + - 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 + - in: path + name: serviceName + required: true + schema: + type: string + - in: path + name: serviceVersion + required: true + schema: + type: string + - in: path + name: artifactName + required: true + schema: + type: string + responses: + "200": + content: + application/octet-stream: + schema: + type: array + items: + type: string + description: The artifact is found and streamed. + "400": + description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "404": + description: Specified artifact is not found - SVC4505 + "405": + description: "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "500": + description: The GET request failed either due to internal SDC problem or + Cambria Service failure. ECOMP Component should continue the attempts + to get the needed information - POL5000 + default: + content: + application/octet-stream: + schema: + type: array + items: + type: string + description: default response + servers: + - url: /sdc + variables: {} + summary: Returns downloaded artifact + tags: + - SDCE-7 APIs + /v1/catalog/services/{serviceName}/{serviceVersion}/resourceInstances/{resourceInstanceName}/artifacts/{artifactName}: + get: + description: Download resource instance artifact + operationId: downloadResourceInstanceArtifactByName + parameters: + - 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 + - in: path + name: serviceName + required: true + schema: + type: string + - in: path + name: serviceVersion + required: true + schema: + type: string + - in: path + name: resourceInstanceName + required: true + schema: + type: string + - in: path + name: artifactName + required: true + schema: + type: string + responses: + "200": + content: + application/octet-stream: + schema: + type: array + items: + type: string + description: The artifact is found and streamed. + "400": + description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "404": + description: Specified artifact is not found - SVC4505 + "405": + description: "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "500": + description: The GET request failed either due to internal SDC problem or + Cambria Service failure. ECOMP Component should continue the attempts + to get the needed information - POL5000 + default: + content: + application/octet-stream: + schema: + type: array + items: + type: string + description: default response + servers: + - url: /sdc + variables: {} + summary: Returns downloaded artifact + tags: + - SDCE-7 APIs + /v1/catalog/services/{serviceName}/{serviceVersion}/resources/{resourceName}/{resourceVersion}/artifacts/{artifactName}: + get: + description: Download resource artifact + operationId: downloadResourceArtifact + parameters: + - 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 + - in: path + name: serviceName + required: true + schema: + type: string + - in: path + name: serviceVersion + required: true + schema: + type: string + - in: path + name: resourceName + required: true + schema: + type: string + - in: path + name: resourceVersion + required: true + schema: + type: string + - in: path + name: artifactName + required: true + schema: + type: string + responses: + "200": + content: + application/octet-stream: + schema: + type: array + items: + type: string + description: The artifact is found and streamed. + "400": + description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "404": + description: Specified artifact is not found - SVC4505 + "405": + description: "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "500": + description: The GET request failed either due to internal SDC problem or + Cambria Service failure. ECOMP Component should continue the attempts + to get the needed information - POL5000 + default: + content: + application/octet-stream: + schema: + type: array + items: + type: string + description: default response + servers: + - url: /sdc + variables: {} + summary: Returns downloaded artifact + tags: + - SDCE-7 APIs + /v1/catalog/services/{serviceUUID}/distribution/{opEnvId}/activate: + post: + description: activate a service + operationId: activateServiceExternal + parameters: + - description: Determines the format of the body of the request + in: header + name: Content-Type + required: true + schema: + type: string + - 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 + - description: The serviceUUid to activate + in: path + name: serviceUUID + required: true + schema: + type: string + - description: The operational environment on which to activate the service + on + in: path + name: opEnvId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + responses: + "202": + description: ECOMP component is authenticated and required service may be + distributed + "400": + description: The resource name is missing in the request body - SVC4062 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "404": + description: "Error: Requested '%1' (uuid) resource was not found - SVC4063" + "405": + description: "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "409": + description: Service state is invalid for this action + "500": + description: The request failed either due to internal SDC problem. ECOMP + Component should continue the attempts to get the needed information - + POL5000 + "502": + description: The server was acting as a gateway or proxy and received an + invalid response from the upstream server + servers: + - url: /sdc + variables: {} + summary: Activates a service + tags: + - SDCE-7 APIs + /v1/catalog/{assetType}: + get: + description: Fetch list of assets + operationId: getAssetListExternal + parameters: + - 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 + - description: The requested asset type + in: path + name: assetType + required: true + schema: + type: string + enum: + - resources + - services + - description: The filter key (resourceType only for resources) + in: query + name: category + schema: + type: string + - description: The filter key (resourceType only for resources) + in: query + name: subCategory + schema: + type: string + - description: The filter key (resourceType only for resources) + in: query + name: distributionStatus + schema: + type: string + - description: The filter key (resourceType only for resources) + in: query + name: resourceType + schema: + type: string + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AssetMetadata' + description: ECOMP component is authenticated and list of Catalog Assets + Metadata is returned + "400": + description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "405": + description: "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "500": + description: The GET request failed either due to internal SDC problem. + ECOMP Component should continue the attempts to get the needed information + - POL5000 + servers: + - url: /sdc + variables: {} + summary: Returns list of assets + tags: + - SDCE-7 APIs + post: + description: creates an asset (resource or service) + operationId: createComponentExternal + parameters: + - description: Determines the format of the body of the request + in: header + name: Content-Type + required: true + schema: + type: string + - 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 + - description: The requested asset type + in: path + name: assetType + required: true + schema: + type: string + enum: + - "resources, services" + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Resource' + description: ECOMP component is authenticated and Asset created + "400": + description: Invalid Content. Missing PROJECT_CODE number - SVC4129 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "404": + description: "Error: Requested '%1' (uuid) resource was not found - SVC4063" + "405": + description: "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "409": + description: "Error: %1 (Service) with name '%2' already exists. - SVC4050" + "500": + description: The GET request failed either due to internal SDC problem. + ECOMP Component should continue the attempts to get the needed information + - POL5000 + servers: + - url: /sdc + variables: {} + summary: Creates an asset (resource or service) + tags: + - SDCE-7 APIs + /v1/catalog/{assetType}/{uuid}/artifacts: + post: + description: uploads of artifact to a resource or service + operationId: uploadArtifact + parameters: + - description: Determines the format of the body of the request + in: header + name: Content-Type + required: true + schema: + type: string + - description: The value for this header must be the MD5 checksum over the whole + json body + in: header + name: Content-MD5 + required: true + schema: + type: string + - description: The user ID of the DCAE Designer. This user must also have Designer + role in SDC + 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 + - description: The requested asset type + in: path + name: assetType + required: true + schema: + type: string + enum: + - "resources,services" + - description: The uuid of the asset as published in the metadata + in: path + name: uuid + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ArtifactDefinition' + description: Artifact uploaded + "400": + description: Restricted Operation – the user provided does not have role + of Designer or the asset is being used by another designer - SVC4301 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "404": + description: Specified resource is not found - SVC4063 + "405": + description: "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "500": + description: The GET request failed either due to internal SDC problem or + Cambria Service failure. ECOMP Component should continue the attempts + to get the needed information - POL5000 + servers: + - url: /sdc + variables: {} + summary: uploads of artifact to a resource or service + tags: + - SDCE-7 APIs + /v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}: + delete: + description: deletes an artifact of a resource or service + operationId: deleteArtifact + parameters: + - description: The user ID of the DCAE Designer. This user must also have Designer + role in SDC + 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 + - description: The requested asset type + in: path + name: assetType + required: true + schema: + type: string + enum: + - "resources,services" + - description: The uuid of the asset as published in the metadata + in: path + name: uuid + required: true + schema: + type: string + - description: The uuid of the artifact as published in the asset detailed metadata + or in the response of the upload / update operation + in: path + name: artifactUUID + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ArtifactDefinition' + description: Artifact deleted + "400": + description: Artifact name is missing in input - SVC4128 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: Asset is being edited by different user. Only one user can + checkout and edit an asset on given time. The asset will be available + for checkout after the other user will checkin the asset - SVC4086 + "404": + description: Specified resource is not found - SVC4063 + "405": + description: "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "409": + description: Restricted Operation – the user provided does not have role + of Designer or the asset is being used by another designer - SVC4301 + "500": + description: The GET request failed either due to internal SDC problem or + Cambria Service failure. ECOMP Component should continue the attempts + to get the needed information - POL5000 + 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 + description: default response + servers: + - url: /sdc + variables: {} + summary: deletes an artifact of a resource or service + tags: + - SDCE-7 APIs + get: + description: Download component artifact + operationId: downloadComponentArtifact + parameters: + - description: The user ID of the DCAE Designer. This user must also have Designer + role in SDC + 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 + - description: The requested asset type + in: path + name: assetType + required: true + schema: + type: string + enum: + - "resources,services" + - description: The uuid of the asset as published in the metadata + in: path + name: uuid + required: true + schema: + type: string + - description: The uuid of the artifact as published in the asset detailed metadata + or in the response of the upload / update operation + in: path + name: artifactUUID + required: true + schema: + type: string + responses: + "200": + content: + application/octet-stream: + schema: + type: array + items: + type: string + description: Artifact downloaded + "400": + description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "404": + description: Artifact was not found - SVC4505 + "405": + description: "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "500": + description: The GET request failed either due to internal SDC problem or + Cambria Service failure. ECOMP Component should continue the attempts + to get the needed information - POL5000 + servers: + - url: /sdc + variables: {} + summary: Returns downloaded artifact + tags: + - SDCE-7 APIs + post: + description: updates an artifact on a resource or service + operationId: updateArtifact + parameters: + - description: Determines the format of the body of the request + in: header + name: Content-Type + required: true + schema: + type: string + - description: The value for this header must be the MD5 checksum over the whole + json body + in: header + name: Content-MD5 + required: true + schema: + type: string + - description: The user ID of the DCAE Designer. This user must also have Designer + role in SDC + 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 + - description: The requested asset type + in: path + name: assetType + required: true + schema: + type: string + enum: + - "resources,services" + - description: The uuid of the asset as published in the metadata + in: path + name: uuid + required: true + schema: + type: string + - description: The uuid of the artifact as published in the asset detailed metadata + or in the response of the upload / update operation + in: path + name: artifactUUID + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ArtifactDefinition' + description: Artifact updated + "400": + description: Artifact name is missing in input - SVC4128 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: Asset is being edited by different user. Only one user can + checkout and edit an asset on given time. The asset will be available + for checkout after the other user will checkin the asset - SVC4086 + "404": + description: Specified resource is not found - SVC4063 + "405": + description: "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "409": + description: Restricted Operation – the user provided does not have role + of Designer or the asset is being used by another designer - SVC4301 + "500": + description: The GET request failed either due to internal SDC problem or + Cambria Service failure. ECOMP Component should continue the attempts + to get the needed information - POL5000 + servers: + - url: /sdc + variables: {} + summary: uploads of artifact to a resource or service + tags: + - SDCE-7 APIs + /v1/catalog/{assetType}/{uuid}/interfaces/{interfaceUUID}/operations/{operationUUID}/artifacts/{artifactUUID}: + post: + description: uploads of artifact to VF operation workflow + operationId: uploadInterfaceOperationArtifact + parameters: + - description: Determines the format of the body of the request + in: header + name: Content-Type + required: true + schema: + type: string + - description: The value for this header must be the MD5 checksum over the whole + json body + in: header + name: Content-MD5 + required: true + schema: + type: string + - description: The user ID of the DCAE Designer. This user must also have Designer + role in SDC + 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 + - description: Asset type + in: path + name: assetType + required: true + schema: + type: string + - description: The uuid of the asset as published in the metadata + in: path + name: uuid + required: true + schema: + type: string + - description: The uuid of the interface + in: path + name: interfaceUUID + required: true + schema: + type: string + - description: The uuid of the operation + in: path + name: operationUUID + required: true + schema: + type: string + - description: The uuid of the artifact + in: path + name: artifactUUID + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ArtifactDefinition' + description: Artifact uploaded + "400": + description: Restricted Operation – the user provided does not have role + of Designer or the asset is being used by another designer - SVC4301 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "404": + description: Specified resource is not found - SVC4063 + "405": + description: "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "500": + description: The GET request failed either due to internal SDC problem or + Cambria Service failure. ECOMP Component should continue the attempts + to get the needed information - POL5000 + servers: + - url: /sdc + variables: {} + summary: uploads of artifact to VF operation workflow + tags: + - SDCE-7 APIs + /v1/catalog/{assetType}/{uuid}/lifecycleState/{lifecycleOperation}: + post: + description: Change Resource lifecycle State + operationId: changeResourceStateExternal + parameters: + - description: Determines the format of the body of the request + in: header + name: Content-Type + required: true + schema: + type: string + - 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 + - in: path + name: lifecycleOperation + required: true + schema: + type: string + enum: + - "checkout, checkin" + - description: id of component to be changed + in: path + name: uuid + required: true + schema: + type: string + - description: "validValues: resources / services " + in: path + name: assetType + required: true + schema: + type: string + enum: + - resources + - services + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AssetMetadata' + description: Resource state changed + "400": + description: Missing X-ECOMP-InstanceID HTTP header - POL5001 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: Asset is being edited by different user. Only one user can + checkout and edit an asset on given time. The asset will be available + for checkout after the other user will checkin the asset - SVC4080 + "404": + description: "Error: Requested '%1' (uuid) resource was not found - SVC4063" + "405": + description: "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "500": + description: The GET request failed either due to internal SDC problem. + ECOMP Component should continue the attempts to get the needed information + - POL5000 + servers: + - url: /sdc + variables: {} + tags: + - SDCE-7 APIs + /v1/catalog/{assetType}/{uuid}/metadata: + get: + description: Detailed metadata of asset by uuid + operationId: getAssetSpecificMetadataByUuidExternal + parameters: + - 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 + - description: The requested asset type + in: path + name: assetType + required: true + schema: + type: string + enum: + - resources + - services + - description: The requested asset uuid + in: path + name: uuid + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AssetMetadata' + description: ECOMP component is authenticated and list of Catalog Assets + Metadata is returned + "400": + description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "404": + description: "Error: Requested '%1' (uuid) resource was not found - SVC4063" + "405": + description: "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "500": + description: The GET request failed either due to internal SDC problem. + ECOMP Component should continue the attempts to get the needed information + - POL5000 + servers: + - url: /sdc + variables: {} + summary: Returns detailed metadata of an asset by uuid + tags: + - SDCE-7 APIs + /v1/catalog/{assetType}/{uuid}/resourceInstances/{componentInstanceName}/externalReferences/{objectType}: + post: + operationId: addComponentInstanceExternalRef + parameters: + - in: path + name: assetType + required: true + schema: + type: string + - in: path + name: uuid + required: true + schema: + type: string + - in: path + name: componentInstanceName + required: true + schema: + type: string + - in: path + name: objectType + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + - in: header + name: X-ECOMP-InstanceID + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalRefDTO' + responses: + default: + content: + application/json: {} + description: default response + servers: + - url: /sdc + variables: {} + tags: + - SDCE-7 APIs + /v1/catalog/{assetType}/{uuid}/resourceInstances/{componentInstanceName}/externalReferences/{objectType}/{oldRefValue}: + put: + operationId: updateComponentInstanceReference + parameters: + - in: path + name: assetType + required: true + schema: + type: string + - in: path + name: uuid + required: true + schema: + type: string + - in: path + name: componentInstanceName + required: true + schema: + type: string + - in: path + name: objectType + required: true + schema: + type: string + - in: path + name: oldRefValue + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + - in: header + name: X-ECOMP-InstanceID + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalRefDTO' + responses: + default: + content: + application/json: {} + description: default response + servers: + - url: /sdc + variables: {} + tags: + - SDCE-7 APIs + /v1/catalog/{assetType}/{uuid}/resourceInstances/{componentInstanceName}/externalReferences/{objectType}/{reference}: + delete: + operationId: deleteComponentInstanceReference + parameters: + - in: path + name: assetType + required: true + schema: + type: string + - in: path + name: uuid + required: true + schema: + type: string + - in: path + name: componentInstanceName + required: true + schema: + type: string + - in: path + name: objectType + required: true + schema: + type: string + - in: path + name: reference + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + - in: header + name: X-ECOMP-InstanceID + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + servers: + - url: /sdc + variables: {} + tags: + - SDCE-7 APIs + /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts: + post: + description: uploads an artifact to a resource instance + operationId: uploadArtifactToInstance + parameters: + - description: Determines the format of the body of the request + in: header + name: Content-Type + required: true + schema: + type: string + - description: The value for this header must be the MD5 checksum over the whole + json body + in: header + name: Content-MD5 + required: true + schema: + type: string + - description: The user ID of the DCAE Designer. This user must also have Designer + role in SDC + 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 + - description: The requested asset type + in: path + name: assetType + required: true + schema: + type: string + enum: + - "resources,services" + - description: The uuid of the asset as published in the metadata + in: path + name: uuid + required: true + schema: + type: string + enum: + - "resources,services" + - description: The component instance name (as publishedin the response of the + detailed query) + in: path + name: resourceInstanceName + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ArtifactDefinition' + description: Artifact uploaded + "400": + description: Restricted Operation – the user provided does not have role + of Designer or the asset is being used by another designer - SVC4301 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "404": + description: Specified resource is not found - SVC4063 + "405": + description: "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "500": + description: The GET request failed either due to internal SDC problem or + Cambria Service failure. ECOMP Component should continue the attempts + to get the needed information - POL5000 + servers: + - url: /sdc + variables: {} + summary: uploads an artifact to a resource instance + tags: + - SDCE-7 APIs + /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}: + delete: + description: deletes an artifact of a resource insatnce + operationId: deleteArtifactOnResourceInstance + parameters: + - description: The user ID of the DCAE Designer. This user must also have Designer + role in SDC + 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 + - description: The requested asset type + in: path + name: assetType + required: true + schema: + type: string + enum: + - "resources,services" + - description: The uuid of the asset as published in the metadata + in: path + name: uuid + required: true + schema: + type: string + - description: The uuid of the artifact as published in the asset detailed metadata + or in the response of the upload / update operation + in: path + name: artifactUUID + required: true + schema: + type: string + - description: The component instance name (as publishedin the response of the + detailed query) + in: path + name: resourceInstanceName + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ArtifactDefinition' + description: Artifact deleted + "400": + description: Artifact name is missing in input - SVC4128 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: Asset is being edited by different user. Only one user can + checkout and edit an asset on given time. The asset will be available + for checkout after the other user will checkin the asset - SVC4086 + "404": + description: Specified resource is not found - SVC4063 + "405": + description: "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "409": + description: Restricted Operation – the user provided does not have role + of Designer or the asset is being used by another designer - SVC4301 + "500": + description: The GET request failed either due to internal SDC problem or + Cambria Service failure. ECOMP Component should continue the attempts + to get the needed information - POL5000 + 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 + description: default response + servers: + - url: /sdc + variables: {} + summary: deletes an artifact of a resource insatnce + tags: + - SDCE-7 APIs + get: + description: Download resource instance artifact + operationId: downloadResourceInstanceArtifact + parameters: + - description: The user ID of the DCAE Designer. This user must also have Designer + role in SDC + 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 + - description: The requested asset type + in: path + name: assetType + required: true + schema: + type: string + - description: The uuid of the asset as published in the metadata + in: path + name: uuid + required: true + schema: + type: string + - description: The uuid of the artifact as published in the asset detailed metadata + or in the response of the upload / update operation + in: path + name: artifactUUID + required: true + schema: + type: string + - description: The component instance name (as publishedin the response of the + detailed query) + in: path + name: resourceInstanceName + required: true + schema: + type: string + responses: + "200": + content: + application/octet-stream: + schema: + type: array + items: + type: string + description: Artifact downloaded + "400": + description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "404": + description: Artifact was not found - SVC4505 + "405": + description: "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "500": + description: The GET request failed either due to internal SDC problem or + Cambria Service failure. ECOMP Component should continue the attempts + to get the needed information - POL5000 + default: + content: + application/octet-stream: + 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 + description: default response + servers: + - url: /sdc + variables: {} + summary: Returns downloaded artifact + tags: + - SDCE-7 APIs + post: + description: updates an artifact on a resource instance + operationId: updateArtifactOnResourceInstance + parameters: + - description: Determines the format of the body of the request + in: header + name: Content-Type + required: true + schema: + type: string + - description: The value for this header must be the MD5 checksum over the whole + json body + in: header + name: Content-MD5 + required: true + schema: + type: string + - description: The user ID of the DCAE Designer. This user must also have Designer + role in SDC + 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 + - description: The requested asset type + in: path + name: assetType + required: true + schema: + type: string + enum: + - "resources,services" + - description: The uuid of the asset as published in the metadata + in: path + name: uuid + required: true + schema: + type: string + - description: The uuid of the artifact as published in the asset detailed metadata + or in the response of the upload / update operation + in: path + name: artifactUUID + required: true + schema: + type: string + - description: The component instance name (as publishedin the response of the + detailed query) + in: path + name: resourceInstanceName + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ArtifactDefinition' + description: Artifact updated + "400": + description: Artifact name is missing in input - SVC4128 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: Asset is being edited by different user. Only one user can + checkout and edit an asset on given time. The asset will be available + for checkout after the other user will checkin the asset - SVC4086 + "404": + description: Specified resource is not found - SVC4063 + "405": + description: "Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "409": + description: Restricted Operation – the user provided does not have role + of Designer or the asset is being used by another designer - SVC4301 + "500": + description: The GET request failed either due to internal SDC problem or + Cambria Service failure. ECOMP Component should continue the attempts + to get the needed information - POL5000 + servers: + - url: /sdc + variables: {} + summary: uploads of artifact to a resource or service + tags: + - SDCE-7 APIs + /v1/catalog/{assetType}/{uuid}/toscaModel: + get: + description: Fetch assets CSAR + operationId: getToscaModelExternal + parameters: + - 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 + - description: The requested asset type + in: path + name: assetType + required: true + schema: + type: string + enum: + - resources + - services + - description: The requested asset uuid + in: path + name: uuid + required: true + schema: + type: string + responses: + "200": + content: + application/octet-stream: + schema: + type: array + items: + type: string + description: ECOMP component is authenticated and list of Catalog Assets + Metadata is returned + "400": + description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its Basic Authentication credentials - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "404": + description: "Error: Requested '%1' (uuid) resource was not found - SVC4063" + "405": + description: "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "500": + description: The GET request failed either due to internal SDC problem. + ECOMP Component should continue the attempts to get the needed information + - POL5000 + default: + content: + application/octet-stream: + schema: + type: array + items: + type: string + description: default response + servers: + - url: /sdc + variables: {} + summary: Returns asset csar + tags: + - SDCE-7 APIs + /v1/catalog/{assetType}/{uuid}/version/{version}/externalReferences/{objectType}: + get: + operationId: getAssetExternalRefByObjectType + parameters: + - in: path + name: assetType + required: true + schema: + type: string + - in: path + name: uuid + required: true + schema: + type: string + - in: path + name: version + required: true + schema: + type: string + - in: path + name: objectType + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + - in: header + name: X-ECOMP-InstanceID + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: object + additionalProperties: + type: array + items: + type: string + description: default response + servers: + - url: /sdc + variables: {} + tags: + - SDCE-7 APIs + /v1/catalog/{assetType}/{uuid}/version/{version}/resourceInstances/{componentInstanceName}/externalReferences/{objectType}: + get: + operationId: getComponentInstanceExternalRef + parameters: + - in: path + name: assetType + required: true + schema: + type: string + - in: path + name: uuid + required: true + schema: + type: string + - in: path + name: version + required: true + schema: + type: string + - in: path + name: componentInstanceName + required: true + schema: + type: string + - in: path + name: objectType + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + - in: header + name: X-ECOMP-InstanceID + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + servers: + - url: /sdc + variables: {} + tags: + - SDCE-7 APIs + /v1/distributionKafkaData: + get: + description: Kafka data + operationId: getKafkaData + parameters: + - 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 + responses: + "200": + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/KafkaDataResponse' + description: ECOMP component is authenticated and kafka endpoint and topic + list is returned + "400": + description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 + "401": + description: ECOMP component should authenticate itself and to re-send again HTTP request with + its credentials for Basic Authentication - POL5002 + "403": + description: ECOMP component is not authorized - POL5003 + "405": + description: "Method Not Allowed: Invalid HTTP method type used ( PUT,DELETE,POST\ + \ will be rejected) - POL4050" + "500": + description: The GET request failed either due to internal SDC problem or + Cambria Service failure. ECOMP Component should continue the attempts + to get the needed information - POL5000 + servers: + - url: /sdc + variables: {} + summary: return the kafka cluster and topic list + tags: + - SDCE-6 APIs +components: + schemas: + AbstractResourceInfo: + type: object + properties: + abstractResourceName: + type: string + abstractResourceUUid: + type: string + abstractResourceUniqueId: + type: string + componentInstancesRelations: + type: array + items: + $ref: '#/components/schemas/RequirementCapabilityRelDef' + AbstractTemplateInfo: + type: object + properties: + abstractResourceInfoList: + type: array + items: + $ref: '#/components/schemas/AbstractResourceInfo' + isAbstractTemplate: + type: boolean + serviceUUid: + type: string + serviceUniqueId: + type: string + AdditionalInfoParameterInfo: + type: object + properties: + empty: + type: boolean + key: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + uniqueId: + type: string + value: + type: string + version: + type: string + AdditionalInformationDefinition: + type: object + properties: + creationTime: + type: integer + format: int64 + empty: + type: boolean + lastCreatedCounter: + type: integer + format: int32 + modificationTime: + type: integer + format: int64 + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parameters: + type: array + items: + $ref: '#/components/schemas/AdditionalInfoParameterInfo' + parentUniqueId: + type: string + type: + type: string + uniqueId: + type: string + version: + type: string + Annotation: + type: object + properties: + description: + type: string + name: + type: string + properties: + type: array + items: + $ref: '#/components/schemas/PropertyDataDefinition' + type: + type: string + ArtifactDataDefinition: + type: object + properties: + apiUrl: + type: string + artifactChecksum: + type: string + artifactCreator: + type: string + artifactDisplayName: + type: string + artifactGroupType: + type: string + enum: + - INFORMATIONAL + - DEPLOYMENT + - LIFE_CYCLE + - SERVICE_API + - TOSCA + - OTHER + artifactLabel: + type: string + artifactName: + type: string + artifactRef: + type: string + artifactRepository: + type: string + artifactType: + type: string + artifactUUID: + type: string + artifactVersion: + type: string + creationDate: + type: integer + format: int64 + creatorFullName: + type: string + description: + type: string + duplicated: + type: boolean + empty: + type: boolean + esId: + type: string + generated: + type: boolean + generatedFromId: + type: string + heatEnvType: + type: boolean + heatParameters: + type: array + items: + $ref: '#/components/schemas/HeatParameterDataDefinition' + heatParamsUpdateDate: + type: integer + format: int64 + isFromCsar: + type: boolean + lastUpdateDate: + type: integer + format: int64 + mandatory: + type: boolean + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + payloadUpdateDate: + type: integer + format: int64 + properties: + type: array + items: + $ref: '#/components/schemas/PropertyDataDefinition' + requiredArtifacts: + type: array + items: + type: string + serviceApi: + type: boolean + timeout: + type: integer + format: int32 + type: + type: string + uniqueId: + type: string + updaterFullName: + type: string + userIdCreator: + type: string + userIdLastUpdater: + type: string + version: + type: string + ArtifactDefinition: + type: object + properties: + apiUrl: + type: string + artifactChecksum: + type: string + artifactCreator: + type: string + artifactDisplayName: + type: string + artifactGroupType: + type: string + enum: + - INFORMATIONAL + - DEPLOYMENT + - LIFE_CYCLE + - SERVICE_API + - TOSCA + - OTHER + artifactLabel: + type: string + artifactName: + type: string + artifactRef: + type: string + artifactRepository: + type: string + artifactType: + type: string + artifactUUID: + type: string + artifactVersion: + type: string + creationDate: + type: integer + format: int64 + creatorFullName: + type: string + description: + type: string + duplicated: + type: boolean + empty: + type: boolean + esId: + type: string + generated: + type: boolean + generatedFromId: + type: string + heatEnvType: + type: boolean + heatParamUpdated: + type: boolean + heatParameters: + type: array + items: + $ref: '#/components/schemas/HeatParameterDataDefinition' + heatParamsUpdateDate: + type: integer + format: int64 + isFromCsar: + type: boolean + lastUpdateDate: + type: integer + format: int64 + listHeatParameters: + type: array + items: + $ref: '#/components/schemas/HeatParameterDefinition' + mandatory: + type: boolean + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + payload: + type: array + items: + type: string + format: byte + writeOnly: true + payloadData: + type: array + items: + type: string + format: byte + payloadUpdateDate: + type: integer + format: int64 + properties: + type: array + items: + $ref: '#/components/schemas/PropertyDataDefinition' + requiredArtifacts: + type: array + items: + type: string + serviceApi: + type: boolean + timeout: + type: integer + format: int32 + type: + type: string + uniqueId: + type: string + updaterFullName: + type: string + userIdCreator: + type: string + userIdLastUpdater: + type: string + version: + type: string + AssetMetadata: + type: object + properties: + invariantUUID: + type: string + name: + type: string + toscaModelURL: + type: string + uuid: + type: string + version: + type: string + AttributeDefinition: + type: object + properties: + attributeId: + type: string + defaultValue: + type: string + definition: + type: boolean + description: + type: string + empty: + type: boolean + entry_schema: + $ref: '#/components/schemas/EntrySchema' + getOutputAttribute: + type: boolean + getOutputValues: + type: array + items: + $ref: '#/components/schemas/GetOutputValueDataDefinition' + get_default: + type: object + instanceUniqueId: + type: string + model: + type: string + name: + type: string + outputId: + type: string + outputPath: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentUniqueId: + type: string + schema: + $ref: '#/components/schemas/SchemaDefinition' + schemaType: + type: string + status: + type: string + type: + type: string + uniqueId: + type: string + value: + type: string + version: + type: string + CINodeFilterDataDefinition: + type: object + properties: + capabilities: + $ref: '#/components/schemas/ListDataDefinitionRequirementNodeFilterCapabilityDataDefinition' + empty: + type: boolean + id: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + properties: + $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition' + tosca_id: + type: object + type: + type: string + version: + type: string + CapabilityDataDefinition: + type: object + properties: + capabilitySources: + type: array + items: + type: string + description: + type: string + empty: + type: boolean + external: + type: boolean + externalName: + type: string + leftOccurrences: + type: string + maxOccurrences: + type: string + minOccurrences: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + ownerName: + type: string + ownerType: + type: string + enum: + - GROUP + - COMPONENT_INSTANCE + - RESOURCE + parentName: + type: string + path: + type: array + items: + type: string + previousName: + type: string + source: + type: string + type: + type: string + uniqueId: + type: string + validSourceTypes: + type: array + items: + type: string + version: + type: string + CapabilityDefinition: + type: object + properties: + capabilitySources: + type: array + items: + type: string + description: + type: string + empty: + type: boolean + external: + type: boolean + externalName: + type: string + leftOccurrences: + type: string + maxOccurrences: + type: string + minOccurrences: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + ownerName: + type: string + ownerType: + type: string + enum: + - GROUP + - COMPONENT_INSTANCE + - RESOURCE + ownerTypeIfEmpty: + type: string + enum: + - GROUP + - COMPONENT_INSTANCE + - RESOURCE + writeOnly: true + parentName: + type: string + path: + type: array + items: + type: string + previousName: + type: string + properties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceProperty' + source: + type: string + type: + type: string + uniqueId: + type: string + validSourceTypes: + type: array + items: + type: string + version: + type: string + CapabilityRequirementRelationship: + type: object + properties: + capability: + $ref: '#/components/schemas/CapabilityDataDefinition' + operations: + type: array + items: + $ref: '#/components/schemas/OperationUi' + relation: + $ref: '#/components/schemas/RelationshipInfo' + requirement: + $ref: '#/components/schemas/RequirementDataDefinition' + CategoryDefinition: + type: object + properties: + displayName: + type: string + empty: + type: boolean + icons: + type: array + items: + type: string + metadataKeys: + type: array + items: + $ref: '#/components/schemas/MetadataKeyDataDefinition' + models: + type: array + items: + type: string + name: + type: string + normalizedName: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + subcategories: + type: array + items: + $ref: '#/components/schemas/SubCategoryDefinition' + type: + type: string + uniqueId: + type: string + useServiceSubstitutionForNestedServices: + type: boolean + version: + type: string + ComponentInstance: + type: object + properties: + actualComponentUid: + type: string + artifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + attributeValueCounter: + type: integer + format: int32 + attributes: + type: array + items: + $ref: '#/components/schemas/AttributeDefinition' + capabilities: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/CapabilityDefinition' + componentMetadataForSupportLog: + type: object + additionalProperties: + type: string + componentName: + type: string + componentUid: + type: string + componentVersion: + type: string + createdFrom: + type: string + enum: + - UI + - CSAR + createdFromCsar: + type: boolean + creationTime: + type: integer + format: int64 + customizationUUID: + type: string + deploymentArtifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + description: + type: string + directives: + type: array + items: + type: string + empty: + type: boolean + groupInstances: + type: array + items: + $ref: '#/components/schemas/GroupInstance' + icon: + type: string + inputValueCounter: + type: integer + format: int32 + inputs: + type: array + items: + $ref: '#/components/schemas/InputDefinition' + instanceCount: + type: string + interfaces: + type: object + additionalProperties: + type: object + invariantName: + type: string + isProxy: + type: boolean + maxOccurrences: + type: string + minOccurrences: + type: string + modificationTime: + type: integer + format: int64 + name: + type: string + nodeFilter: + $ref: '#/components/schemas/CINodeFilterDataDefinition' + normalizedName: + type: string + originArchived: + type: boolean + originType: + type: string + enum: + - PRODUCT + - SERVICE + - VF + - VFC + - CP + - VL + - Configuration + - VFCMT + - CVFC + - PNF + - CR + - ServiceProxy + - ServiceSubstitution + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + posX: + type: string + posY: + type: string + properties: + type: array + items: + $ref: '#/components/schemas/PropertyDefinition' + propertyValueCounter: + type: integer + format: int32 + requirements: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/RequirementDefinition' + serviceSubstitution: + type: boolean + sourceModelInvariant: + type: string + sourceModelName: + type: string + sourceModelUid: + type: string + sourceModelUuid: + type: string + toscaArtifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ToscaArtifactDataDefinition' + toscaComponentName: + type: string + type: + type: string + uniqueId: + type: string + version: + type: string + ComponentInstanceAttribute: + type: object + properties: + attributeId: + type: string + componentInstanceId: + type: string + componentInstanceName: + type: string + defaultValue: + type: string + definition: + type: boolean + description: + type: string + empty: + type: boolean + entry_schema: + $ref: '#/components/schemas/EntrySchema' + getOutputAttribute: + type: boolean + getOutputValues: + type: array + items: + $ref: '#/components/schemas/GetOutputValueDataDefinition' + get_default: + type: object + instanceUniqueId: + type: string + model: + type: string + name: + type: string + outputId: + type: string + outputPath: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentUniqueId: + type: string + path: + type: array + items: + type: string + rules: + type: array + items: + $ref: '#/components/schemas/PropertyRule' + schema: + $ref: '#/components/schemas/SchemaDefinition' + schemaType: + type: string + status: + type: string + type: + type: string + uniqueId: + type: string + value: + type: string + valueUniqueUid: + type: string + version: + type: string + ComponentInstanceInput: + type: object + properties: + annotations: + type: array + items: + $ref: '#/components/schemas/Annotation' + annotationsToInput: + type: array + items: + $ref: '#/components/schemas/Annotation' + writeOnly: true + componentInstanceId: + type: string + componentInstanceName: + type: string + constraints: + type: array + items: + $ref: '#/components/schemas/PropertyConstraint' + 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 + label: + type: string + mappedToComponentProperty: + type: boolean + metadata: + type: object + additionalProperties: + type: string + model: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentPropertyType: + type: string + parentUniqueId: + type: string + password: + type: boolean + path: + type: array + items: + type: string + properties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceProperty' + propertyConstraints: + type: array + items: + type: string + propertyId: + type: string + required: + type: boolean + rules: + type: array + items: + $ref: '#/components/schemas/PropertyRule' + schema: + $ref: '#/components/schemas/SchemaDefinition' + schemaProperty: + $ref: '#/components/schemas/PropertyDataDefinition' + schemaType: + type: string + status: + type: string + subPropertyInputPath: + type: string + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + type: string + valueUniqueUid: + type: string + version: + type: string + ComponentInstanceInterface: + type: object + properties: + creationDate: + type: integer + format: int64 + definition: + type: boolean + derivedFrom: + type: string + description: + type: string + empty: + type: boolean + inputs: + type: object + additionalProperties: + $ref: '#/components/schemas/InputDataDefinition' + interfaceId: + type: string + interfaceInstanceDataDefinition: + $ref: '#/components/schemas/InterfaceInstanceDataDefinition' + lastUpdateDate: + type: integer + format: int64 + model: + type: string + operations: + type: object + additionalProperties: + $ref: '#/components/schemas/OperationDataDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + toscaResourceName: + type: string + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + version: + type: string + ComponentInstanceOutput: + type: object + properties: + attribute: + $ref: '#/components/schemas/ComponentInstanceAttribute' + attributeId: + type: string + componentInstanceId: + type: string + componentInstanceName: + type: string + defaultValue: + type: string + definition: + type: boolean + description: + type: string + empty: + type: boolean + entry_schema: + $ref: '#/components/schemas/EntrySchema' + getOutputAttribute: + type: boolean + getOutputValues: + type: array + items: + $ref: '#/components/schemas/GetOutputValueDataDefinition' + get_default: + type: object + instanceUniqueId: + type: string + model: + type: string + name: + type: string + outputId: + type: string + outputPath: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentUniqueId: + type: string + path: + type: array + items: + type: string + rules: + type: array + items: + $ref: '#/components/schemas/PropertyRule' + schema: + $ref: '#/components/schemas/SchemaDefinition' + schemaType: + type: string + status: + type: string + type: + type: string + uniqueId: + type: string + value: + type: string + valueUniqueUid: + type: string + version: + type: string + ComponentInstanceProperty: + type: object + properties: + annotations: + type: array + items: + $ref: '#/components/schemas/Annotation' + componentInstanceId: + type: string + componentInstanceName: + type: string + constraints: + type: array + items: + $ref: '#/components/schemas/PropertyConstraint' + 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 + label: + type: string + mappedToComponentProperty: + type: boolean + metadata: + type: object + additionalProperties: + type: string + model: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentPropertyType: + type: string + parentUniqueId: + type: string + password: + type: boolean + path: + type: array + items: + type: string + propertyConstraints: + type: array + items: + type: string + propertyId: + type: string + required: + type: boolean + rules: + type: array + items: + $ref: '#/components/schemas/PropertyRule' + schema: + $ref: '#/components/schemas/SchemaDefinition' + schemaProperty: + $ref: '#/components/schemas/PropertyDataDefinition' + schemaType: + type: string + status: + type: string + subPropertyInputPath: + type: string + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + type: string + valueUniqueUid: + type: string + version: + type: string + Constraint: + type: object + properties: + equal: + type: object + greater_or_equal: + type: object + greater_than: + type: object + in_range: + type: array + items: + type: object + length: + type: integer + format: int32 + less_or_equal: + type: object + less_than: + type: object + max_length: + type: integer + format: int32 + min_length: + type: integer + format: int32 + pattern: + type: object + valid_values: + type: array + items: + type: object + DataTypeDefinition: + type: object + properties: + constraints: + type: array + items: + $ref: '#/components/schemas/PropertyConstraint' + creationTime: + type: integer + format: int64 + derivedFrom: + $ref: '#/components/schemas/DataTypeDefinition' + derivedFromName: + type: string + description: + type: string + empty: + type: boolean + 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' + propertiesData: + type: array + items: + $ref: '#/components/schemas/PropertyDataDefinition' + type: + type: string + uniqueId: + type: string + version: + type: string + EntrySchema: + type: object + properties: + constraints: + type: array + items: + $ref: '#/components/schemas/Constraint' + description: + type: string + type: + type: string + ExternalRefDTO: + type: object + properties: + referenceUUID: + type: string + GetInputValueDataDefinition: + type: object + properties: + empty: + type: boolean + getInputIndex: + $ref: '#/components/schemas/GetInputValueDataDefinition' + indexValue: + type: integer + format: int32 + inputId: + type: string + inputName: + type: string + inputType: + type: string + list: + type: boolean + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + propName: + type: string + type: + type: string + version: + type: string + GetOutputValueDataDefinition: + type: object + properties: + attribName: + type: string + empty: + type: boolean + getOutputIndex: + $ref: '#/components/schemas/GetOutputValueDataDefinition' + indexValue: + type: integer + format: int32 + list: + type: boolean + outputId: + type: string + outputName: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + GetPolicyValueDataDefinition: + type: object + properties: + origPropertyValue: + type: string + policyId: + type: string + propertyName: + type: string + GroupDefinition: + type: object + properties: + artifacts: + type: array + items: + type: string + artifactsUuid: + type: array + items: + type: string + capabilities: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/CapabilityDefinition' + createdFrom: + type: string + enum: + - UI + - CSAR + description: + type: string + empty: + type: boolean + groupUUID: + type: string + invariantName: + type: string + invariantUUID: + type: string + members: + type: object + additionalProperties: + type: string + name: + type: string + normalizedName: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + properties: + type: array + items: + $ref: '#/components/schemas/PropertyDataDefinition' + propertyValueCounter: + type: integer + format: int32 + type: + type: string + typeUid: + type: string + uniqueId: + type: string + userDefined: + type: boolean + version: + type: string + vspOriginated: + type: boolean + GroupInstance: + type: object + properties: + artifacts: + type: array + items: + type: string + artifactsUuid: + type: array + items: + type: string + creationTime: + type: integer + format: int64 + customizationUUID: + type: string + description: + type: string + empty: + type: boolean + groupInstanceArtifacts: + type: array + items: + type: string + groupInstanceArtifactsUuid: + type: array + items: + type: string + groupName: + type: string + groupUUID: + type: string + groupUid: + type: string + invariantUUID: + type: string + modificationTime: + type: integer + format: int64 + name: + type: string + normalizedName: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + posX: + type: string + posY: + type: string + properties: + type: array + items: + $ref: '#/components/schemas/PropertyDataDefinition' + propertyValueCounter: + type: integer + format: int32 + type: + type: string + uniqueId: + type: string + version: + type: string + GroupingDefinition: + type: object + properties: + empty: + type: boolean + name: + type: string + normalizedName: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + uniqueId: + type: string + version: + type: string + HeatParameterDataDefinition: + type: object + properties: + currentValue: + type: string + defaultValue: + type: string + description: + type: string + empty: + type: boolean + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + uniqueId: + type: string + version: + type: string + HeatParameterDefinition: + type: object + properties: + currentValue: + type: string + defaultValue: + type: string + description: + type: string + empty: + type: boolean + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + uniqueId: + type: string + version: + type: string + InputDataDefinition: + 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 + label: + type: string + mappedToComponentProperty: + type: boolean + metadata: + type: object + additionalProperties: + type: string + model: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentPropertyType: + type: string + parentUniqueId: + type: string + password: + type: boolean + 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 + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + type: string + version: + type: string + InputDefinition: + type: object + properties: + annotations: + type: array + items: + $ref: '#/components/schemas/Annotation' + annotationsToInput: + type: array + items: + $ref: '#/components/schemas/Annotation' + writeOnly: true + constraints: + type: array + items: + $ref: '#/components/schemas/PropertyConstraint' + 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 + inputs: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceInput' + instanceUniqueId: + type: string + isDeclaredListInput: + type: boolean + label: + type: string + mappedToComponentProperty: + type: boolean + metadata: + type: object + additionalProperties: + type: string + model: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentPropertyType: + type: string + parentUniqueId: + type: string + password: + type: boolean + properties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceProperty' + 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 + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + type: string + version: + type: string + InterfaceDefinition: + type: object + properties: + creationDate: + type: integer + format: int64 + definition: + type: boolean + derivedFrom: + type: string + description: + type: string + empty: + type: boolean + inputs: + type: object + additionalProperties: + $ref: '#/components/schemas/InputDataDefinition' + lastUpdateDate: + type: integer + format: int64 + model: + type: string + operations: + type: object + additionalProperties: + $ref: '#/components/schemas/OperationDataDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + toscaResourceName: + type: string + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + version: + type: string + InterfaceInstanceDataDefinition: + type: object + properties: + empty: + type: boolean + inputs: + type: object + additionalProperties: + type: object + operations: + type: object + additionalProperties: + $ref: '#/components/schemas/OperationInstance' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + KafkaDataResponse: + type: object + properties: + distrNotificationTopicName: + type: string + distrStatusTopicName: + type: string + kafkaBootStrapServer: + type: string + ListDataDefinitionOperationInputDefinition: + type: object + properties: + empty: + type: boolean + listToscaDataDefinition: + type: array + items: + $ref: '#/components/schemas/OperationInputDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + ListDataDefinitionOperationOutputDefinition: + type: object + properties: + empty: + type: boolean + listToscaDataDefinition: + type: array + items: + $ref: '#/components/schemas/OperationOutputDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + ListDataDefinitionPropertyFilterDataDefinition: + type: object + properties: + empty: + type: boolean + listToscaDataDefinition: + type: array + items: + $ref: '#/components/schemas/PropertyFilterDataDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + ListDataDefinitionRequirementNodeFilterCapabilityDataDefinition: + type: object + properties: + empty: + type: boolean + listToscaDataDefinition: + type: array + items: + $ref: '#/components/schemas/RequirementNodeFilterCapabilityDataDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + ListDataDefinitionRequirementSubstitutionFilterCapabilityDataDefinition: + type: object + properties: + empty: + type: boolean + listToscaDataDefinition: + type: array + items: + $ref: '#/components/schemas/RequirementSubstitutionFilterCapabilityDataDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + ListDataDefinitionSubstitutionFilterPropertyDataDefinition: + type: object + properties: + empty: + type: boolean + listToscaDataDefinition: + type: array + items: + $ref: '#/components/schemas/SubstitutionFilterPropertyDataDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + MetadataKeyDataDefinition: + type: object + properties: + defaultValue: + type: string + displayName: + type: string + empty: + type: boolean + mandatory: + type: boolean + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + validValues: + type: array + items: + type: string + version: + type: string + OperationDataDefinition: + type: object + properties: + creationDate: + type: integer + format: int64 + description: + type: string + empty: + type: boolean + implementation: + $ref: '#/components/schemas/ArtifactDataDefinition' + inputs: + $ref: '#/components/schemas/ListDataDefinitionOperationInputDefinition' + lastUpdateDate: + type: integer + format: int64 + name: + type: string + outputs: + $ref: '#/components/schemas/ListDataDefinitionOperationOutputDefinition' + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + uniqueId: + type: string + version: + type: string + workflowAssociationType: + type: string + workflowId: + type: string + workflowName: + type: string + workflowVersion: + type: string + workflowVersionId: + type: string + OperationImplementation: + type: object + properties: + dependencies: + type: array + items: + type: string + primary: + type: string + OperationInputDefinition: + 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 + label: + type: string + mappedToComponentProperty: + type: boolean + metadata: + type: object + additionalProperties: + type: string + model: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentPropertyType: + type: string + parentUniqueId: + type: string + password: + type: boolean + 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 + source: + type: string + sourceProperty: + type: string + status: + type: string + subPropertyInputPath: + type: string + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + toscaDefaultValue: + type: string + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + type: string + version: + type: string + OperationInstance: + type: object + properties: + implementation: + $ref: '#/components/schemas/OperationImplementation' + inputs: + type: object + additionalProperties: + type: object + OperationOutputDefinition: + 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 + label: + type: string + mappedToComponentProperty: + type: boolean + metadata: + type: object + additionalProperties: + type: string + model: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentPropertyType: + type: string + parentUniqueId: + type: string + password: + type: boolean + 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 + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + type: string + version: + type: string + OperationUi: + type: object + properties: + implementation: + type: object + inputs: + type: array + items: + $ref: '#/components/schemas/PropertyAssignmentUi' + interfaceType: + type: string + operationType: + type: string + OutputDefinition: + type: object + properties: + attribute: + $ref: '#/components/schemas/ComponentInstanceAttribute' + attributeId: + type: string + defaultValue: + type: string + definition: + type: boolean + description: + type: string + empty: + type: boolean + entry_schema: + $ref: '#/components/schemas/EntrySchema' + getOutputAttribute: + type: boolean + getOutputValues: + type: array + items: + $ref: '#/components/schemas/GetOutputValueDataDefinition' + get_default: + type: object + instanceUniqueId: + type: string + model: + type: string + name: + type: string + outputId: + type: string + outputPath: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentUniqueId: + type: string + schema: + $ref: '#/components/schemas/SchemaDefinition' + schemaType: + type: string + status: + type: string + type: + type: string + uniqueId: + type: string + value: + type: string + version: + type: string + PolicyDefinition: + type: object + properties: + annotations: + type: array + items: + $ref: '#/components/schemas/Annotation' + componentName: + type: string + defaultValue: + type: string + definition: + type: boolean + derivedFrom: + type: string + 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 + 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 + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + targets: + type: object + additionalProperties: + type: array + items: + type: string + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + 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 + label: + type: string + mappedToComponentProperty: + type: boolean + metadata: + type: object + additionalProperties: + type: string + model: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentPropertyType: + type: string + parentUniqueId: + type: string + password: + type: boolean + 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 + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + type: string + version: + type: string + PropertyDefinition: + type: object + properties: + annotations: + type: array + items: + $ref: '#/components/schemas/Annotation' + constraints: + type: array + items: + $ref: '#/components/schemas/PropertyConstraint' + 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 + label: + type: string + mappedToComponentProperty: + type: boolean + metadata: + type: object + additionalProperties: + type: string + model: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + parentPropertyType: + type: string + parentUniqueId: + type: string + password: + type: boolean + 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 + subPropertyToscaFunctions: + type: array + items: + $ref: '#/components/schemas/SubPropertyToscaFunction' + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + toscaGetFunction: + $ref: '#/components/schemas/ToscaGetFunctionDataDefinition' + toscaGetFunctionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + type: + type: string + uniqueId: + type: string + userCreated: + type: boolean + value: + type: string + version: + type: string + PropertyFilterConstraintDataDefinition: + type: object + properties: + capabilityName: + type: string + operator: + type: string + enum: + - EQUAL + - IN_RANGE + - GREATER_THAN + - GREATER_OR_EQUAL + - LESS_OR_EQUAL + - LENGTH + - MIN_LENGTH + - MAX_LENGTH + - VALID_VALUES + - LESS_THAN + - PATTERN + - SCHEMA + propertyName: + type: string + targetType: + type: string + enum: + - CAPABILITY + - PROPERTY + value: + type: object + valueType: + type: string + enum: + - STATIC + - GET_PROPERTY + - GET_INPUT + - GET_ATTRIBUTE + - YAML + - CONCAT + PropertyFilterDataDefinition: + type: object + properties: + constraints: + type: array + items: + $ref: '#/components/schemas/PropertyFilterConstraintDataDefinition' + empty: + type: boolean + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + PropertyRule: + type: object + properties: + empty: + type: boolean + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + rule: + type: array + items: + type: string + type: + type: string + value: + type: string + version: + type: string + RelationshipImpl: + type: object + properties: + type: + type: string + RelationshipInfo: + type: object + properties: + capability: + type: string + capabilityOwnerId: + type: string + capabilityUid: + type: string + id: + type: string + relationship: + $ref: '#/components/schemas/RelationshipImpl' + relationships: + $ref: '#/components/schemas/RelationshipImpl' + requirement: + type: string + requirementOwnerId: + type: string + requirementUid: + type: string + RequirementCapabilityRelDef: + type: object + properties: + fromNode: + type: string + originUI: + type: boolean + relationships: + type: array + items: + $ref: '#/components/schemas/CapabilityRequirementRelationship' + toNode: + type: string + uid: + type: string + RequirementDataDefinition: + type: object + properties: + capability: + type: string + empty: + type: boolean + external: + type: boolean + externalName: + type: string + leftOccurrences: + type: string + maxOccurrences: + type: string + minOccurrences: + type: string + name: + type: string + node: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + ownerName: + type: string + parentName: + type: string + path: + type: array + items: + type: string + previousName: + type: string + relationship: + type: string + source: + type: string + type: + type: string + uniqueId: + type: string + version: + type: string + RequirementDefinition: + type: object + properties: + capability: + type: string + empty: + type: boolean + external: + type: boolean + externalName: + type: string + leftOccurrences: + type: string + maxOccurrences: + type: string + minOccurrences: + type: string + name: + type: string + node: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + ownerName: + type: string + parentName: + type: string + path: + type: array + items: + type: string + previousName: + type: string + relationship: + type: string + source: + type: string + type: + type: string + uniqueId: + type: string + version: + type: string + RequirementNodeFilterCapabilityDataDefinition: + type: object + properties: + empty: + type: boolean + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + properties: + $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition' + type: + type: string + version: + type: string + RequirementSubstitutionFilterCapabilityDataDefinition: + type: object + properties: + empty: + type: boolean + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + properties: + $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition' + type: + type: string + version: + type: string + Resource: + type: object + properties: + abstract: + type: boolean + actualComponentType: + type: string + additionalInformation: + type: array + items: + $ref: '#/components/schemas/AdditionalInformationDefinition' + allArtifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + allVersions: + type: object + additionalProperties: + type: string + archiveTime: + type: integer + format: int64 + archived: + type: boolean + artifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + attributes: + type: array + items: + $ref: '#/components/schemas/AttributeDefinition' + capabilities: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/CapabilityDefinition' + categories: + type: array + items: + $ref: '#/components/schemas/CategoryDefinition' + categorySpecificMetadata: + type: object + additionalProperties: + type: string + componentInstances: + type: array + items: + $ref: '#/components/schemas/ComponentInstance' + componentInstancesAttributes: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceAttribute' + componentInstancesInputs: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceInput' + componentInstancesInterfaces: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceInterface' + componentInstancesOutputs: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceOutput' + componentInstancesProperties: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ComponentInstanceProperty' + componentInstancesRelations: + type: array + items: + $ref: '#/components/schemas/RequirementCapabilityRelDef' + componentMetadataForSupportLog: + type: object + additionalProperties: + type: string + componentType: + type: string + enum: + - RESOURCE + - SERVICE + - RESOURCE_INSTANCE + - PRODUCT + - SERVICE_INSTANCE + conformanceLevel: + type: string + contactId: + type: string + cost: + type: string + creationDate: + type: integer + format: int64 + creatorFullName: + type: string + creatorUserId: + type: string + csarUUID: + type: string + csarVersion: + type: string + csarVersionId: + type: string + dataTypes: + type: array + items: + $ref: '#/components/schemas/DataTypeDefinition' + deploymentArtifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + derivedFrom: + type: array + items: + type: string + derivedFromGenericInfo: + $ref: '#/components/schemas/Resource' + derivedFromGenericType: + type: string + derivedFromGenericVersion: + type: string + derivedFromMapOfIdToName: + type: object + additionalProperties: + type: string + derivedList: + type: array + items: + type: string + description: + type: string + groups: + type: array + items: + $ref: '#/components/schemas/GroupDefinition' + highestVersion: + type: boolean + icon: + type: string + importedToscaChecksum: + type: string + inputs: + type: array + items: + $ref: '#/components/schemas/InputDefinition' + interfaces: + type: object + additionalProperties: + $ref: '#/components/schemas/InterfaceDefinition' + invariantUUID: + type: string + isDeleted: + type: boolean + lastUpdateDate: + type: integer + format: int64 + lastUpdaterFullName: + type: string + lastUpdaterUserId: + type: string + licenseType: + type: string + lifecycleState: + type: string + enum: + - CERTIFIED + - NOT_CERTIFIED_CHECKIN + - NOT_CERTIFIED_CHECKOUT + model: + type: string + name: + type: string + nodeFilterComponents: + type: object + additionalProperties: + $ref: '#/components/schemas/CINodeFilterDataDefinition' + normalizedName: + type: string + outputs: + type: array + items: + $ref: '#/components/schemas/OutputDefinition' + policies: + type: object + additionalProperties: + $ref: '#/components/schemas/PolicyDefinition' + projectCode: + type: string + properties: + type: array + items: + $ref: '#/components/schemas/PropertyDefinition' + requirements: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/RequirementDefinition' + resourceType: + type: string + enum: + - VFC + - VF + - CR + - CP + - PNF + - CVFC + - VL + - VFCMT + - Configuration + - ServiceProxy + - ABSTRACT + - SERVICE + resourceVendorModelNumber: + type: string + service: + type: boolean + specificComponetTypeArtifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + writeOnly: true + state: + type: string + enum: + - CERTIFIED + - NOT_CERTIFIED_CHECKIN + - NOT_CERTIFIED_CHECKOUT + writeOnly: true + substitutionFilter: + $ref: '#/components/schemas/SubstitutionFilterDataDefinition' + systemName: + type: string + tags: + type: array + items: + type: string + topologyTemplate: + type: boolean + toscaArtifacts: + type: object + additionalProperties: + $ref: '#/components/schemas/ArtifactDefinition' + toscaResourceName: + type: string + toscaType: + type: string + toscaVersion: + type: string + uniqueId: + type: string + uuid: + type: string + vendorName: + type: string + vendorRelease: + type: string + version: + type: string + vspArchived: + type: boolean + SchemaDefinition: + type: object + properties: + constraints: + type: array + items: + type: string + derivedFrom: + type: string + empty: + type: boolean + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + properties: + type: object + additionalProperties: + $ref: '#/components/schemas/PropertyDataDefinition' + property: + $ref: '#/components/schemas/PropertyDataDefinition' + type: + type: string + version: + type: string + SubCategoryDefinition: + type: object + properties: + empty: + type: boolean + groupings: + type: array + items: + $ref: '#/components/schemas/GroupingDefinition' + icons: + type: array + items: + type: string + metadataKeys: + type: array + items: + $ref: '#/components/schemas/MetadataKeyDataDefinition' + name: + type: string + normalizedName: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + uniqueId: + type: string + version: + type: string + SubPropertyToscaFunction: + type: object + properties: + subPropertyPath: + type: array + items: + type: string + toscaFunction: + $ref: '#/components/schemas/ToscaFunction' + SubstitutionFilterDataDefinition: + type: object + properties: + capabilities: + $ref: '#/components/schemas/ListDataDefinitionRequirementSubstitutionFilterCapabilityDataDefinition' + empty: + type: boolean + id: + type: string + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + properties: + $ref: '#/components/schemas/ListDataDefinitionSubstitutionFilterPropertyDataDefinition' + tosca_id: + type: object + type: + type: string + version: + type: string + SubstitutionFilterPropertyDataDefinition: + type: object + properties: + constraints: + type: array + items: + $ref: '#/components/schemas/PropertyFilterConstraintDataDefinition' + empty: + type: boolean + name: + type: string + ownerId: + type: string + ownerIdIfEmpty: + type: string + writeOnly: true + type: + type: string + version: + type: string + ToscaArtifactDataDefinition: + type: object + properties: + file: + type: string + properties: + type: object + additionalProperties: + type: object + type: + type: string + ToscaFunction: + type: object + properties: + jsonObjectValue: + type: object + type: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + - CONCAT + - YAML + - STRING + value: + type: string + ToscaGetFunctionDataDefinition: + type: object + properties: + functionType: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + propertyName: + type: string + propertyPathFromSource: + type: array + items: + type: string + propertySource: + type: string + enum: + - SELF + - INSTANCE + propertyUniqueId: + type: string + sourceName: + type: string + sourceUniqueId: + type: string + type: + type: string + enum: + - GET_INPUT + - GET_PROPERTY + - GET_ATTRIBUTE + - CONCAT + - YAML + - STRING |