diff options
| author |   Denes Nemeth <denes.nemeth@nokia.com> | 2018-02-12 20:55:54 +0100 |
|---|---|---|
| committer | Denes Nemeth <denes.nemeth@nokia.com> | 2018-02-23 11:44:45 +0100 |
| commit | b17042b955489d8a023d09abad5436ff9b900dc3 (patch) | |
| tree | 1e4392ac04a2fb1ed8d17075d504cf6594acaf16 /nokiav2/generatedapis/src/main | |
| parent | d4982f7b1777e9cdae9a4cc7d0d104263889ac69 (diff) | |
Updating Nokia driver
Change-Id: I950afe6acbdb359cd67a448024f006a45e8fc293
Signed-off-by: Denes Nemeth <denes.nemeth@nokia.com>
Issue-ID: VFC-728
Diffstat (limited to 'nokiav2/generatedapis/src/main')
9 files changed, 26612 insertions, 0 deletions
diff --git a/nokiav2/generatedapis/src/main/resources/nokia.catalog.json b/nokiav2/generatedapis/src/main/resources/nokia.catalog.json new file mode 100644 index 00000000..3f495393 --- /dev/null +++ b/nokiav2/generatedapis/src/main/resources/nokia.catalog.json @@ -0,0 +1,525 @@ +{ + "swagger": "2.0", + "info": { + "version": "v1", + "title": "Catalog adapter service" + }, + "basePath": "/adapter", + "securityDefinitions": { + "OauthPassword": { + "description": "OAuth 2.0 resource owner password credentials grant (https://tools.ietf.org/html/rfc6749#section-4.3) with bearer token type. Note: the given tokenUrl does not inherit from the basePath\n", + "type": "oauth2", + "tokenUrl": "/auth/realms/cbam/protocol/openid-connect/token", + "flow": "password", + "scopes": { + "default": "default scope" + } + }, + "OauthClient": { + "description": "OAuth 2.0 client credentials grant (https://tools.ietf.org/html/rfc6749#section-4.4) with bearer token type. Note: the given tokenUrl does not inherit from the basePath\n", + "type": "oauth2", + "tokenUrl": "/auth/realms/cbam/protocol/openid-connect/token", + "flow": "application", + "scopes": { + "default": "default scope" + } + } + }, + "security": [ + { + "OauthPassword": [ + "default" + ] + }, + { + "OauthClient": [ + "default" + ] + } + ], + "paths": { + "/vnfpackages": { + "get": { + "description": "List the available vnf packages", + "operationId": "list", + "produces": [ + "application/json", + "application/xml" + ], + "parameters": [], + "responses": { + "200": { + "description": "List of available vnf packages", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/catalog_adapter_vnfpackage" + } + } + } + } + }, + "post": { + "description": "Create a new vnf package", + "operationId": "create", + "produces": [ + "application/json", + "application/xml" + ], + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "name": "content", + "in": "formData", + "required": true, + "x-is-map": false, + "type": "file", + "format": "file", + "description": "Content of the created package" + } + ], + "responses": { + "200": { + "description": "The created vnf package", + "schema": { + "$ref": "#/definitions/catalog_adapter_vnfpackage" + } + } + } + } + }, + "/vnfpackages/{id}": { + "get": { + "description": "Returns a vnf package", + "operationId": "getById", + "produces": [ + "application/json", + "application/xml" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "x-is-map": false, + "type": "string", + "description": "ID of the queried vnf package" + } + ], + "responses": { + "200": { + "description": "The queried vnf package", + "schema": { + "$ref": "#/definitions/catalog_adapter_vnfpackage" + } + } + } + }, + "delete": { + "description": "Delete an existing vnf package", + "operationId": "delete", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "x-is-map": false, + "type": "string", + "description": "ID of the vnf package to be deleted" + } + ] + } + }, + "/vnfpackages/{vnfdId}/getbyversion": { + "get": { + "description": "Returns a vnf package", + "operationId": "getByVersion", + "produces": [ + "application/json", + "application/xml" + ], + "parameters": [ + { + "name": "vnfdId", + "in": "path", + "required": true, + "x-is-map": false, + "type": "string", + "description": "VNFD ID of the queried vnf package" + } + ], + "responses": { + "200": { + "description": "The queried vnf package", + "schema": { + "$ref": "#/definitions/catalog_adapter_vnfpackage" + } + } + } + } + }, + "/vnfpackages/{vnfdId}/addusagereference": { + "post": { + "description": "Add a usage reference to the specified vnf package", + "operationId": "addUsageReference", + "consumes": [ + "application/json", + "application/xml" + ], + "parameters": [ + { + "name": "vnfdId", + "in": "path", + "required": true, + "x-is-map": false, + "type": "string", + "description": "VNFD ID of the used vnf package" + }, + { + "name": "reference", + "in": "header", + "required": true, + "x-is-map": false, + "type": "string", + "description": "the usage reference" + } + ] + } + }, + "/vnfpackages/{vnfdId}/removeusagereference": { + "post": { + "description": "Remove a usage reference from the specified vnf package", + "operationId": "removeUsageReference", + "consumes": [ + "application/json", + "application/xml`" + ], + "parameters": [ + { + "name": "vnfdId", + "in": "path", + "required": true, + "x-is-map": false, + "type": "string", + "description": "VNFD ID of the vnf package" + }, + { + "name": "reference", + "in": "header", + "required": true, + "x-is-map": false, + "type": "string", + "description": "the usage reference" + } + ] + } + }, + "/vnfpackages/{vnfdId}/artifacts/{filePath}": { + "get": { + "description": "Download a file from a vnf package", + "operationId": "viewArtifact", + "produces": [ + "application/octet-stream" + ], + "parameters": [ + { + "name": "vnfdId", + "in": "path", + "required": true, + "x-is-map": false, + "type": "string", + "description": "VNFD ID of the vnf package" + }, + { + "name": "filePath", + "in": "path", + "required": true, + "x-is-map": false, + "type": "string", + "description": "Path of the requested file" + } + ], + "responses": { + "200": { + "schema": { + "type": "file" + }, + "description": "Content of the requested file" + } + } + } + }, + "/vnfpackages/{vnfdId}/content": { + "get": { + "description": "Download a vnf package", + "operationId": "content", + "produces": [ + "application/octet-stream" + ], + "parameters": [ + { + "name": "vnfdId", + "in": "path", + "required": true, + "x-is-map": false, + "type": "string", + "description": "VNFD ID of the vnf package to download" + } + ], + "responses": { + "200": { + "schema": { + "type": "file" + }, + "description": "Content of the vnf package" + } + } + } + }, + "/vnfpackages/{id}/vnfversions": { + "get": { + "description": "List the available versions of a vnf package", + "operationId": "vnfversions", + "produces": [ + "application/json", + "application/xml" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "x-is-map": false, + "type": "string", + "description": "ID of the vnf package" + } + ], + "responses": { + "200": { + "description": "The list of available versions (with full representations)", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/catalog_adapter_vnfpackage" + } + } + } + } + } + }, + "/vnfpackages/{id}/versions": { + "get": { + "description": "List the available versions of a vnf package", + "operationId": "versions", + "produces": [ + "application/json", + "application/xml" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "x-is-map": false, + "type": "string", + "description": "ID of the vnf package" + } + ], + "responses": { + "200": { + "description": "The list of available versions", + "schema": { + "$ref": "#/definitions/catalog_adapter_vnf_package_versions" + } + } + } + } + }, + "/export": { + "get": { + "description": "Export all vnf packages", + "operationId": "exportAllVnfs", + "produces": [ + "application/octet-stream" + ], + "parameters": [], + "responses": { + "200": { + "schema": { + "type": "file" + }, + "description": "Content of the vnf packages" + } + } + } + }, + "/export/{id}": { + "get": { + "description": "Export a vnf package", + "operationId": "exportOneVnf", + "produces": [ + "application/octet-stream" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "x-is-map": false, + "type": "string", + "description": "ID of the vnf package to export" + } + ], + "responses": { + "200": { + "schema": { + "type": "file" + }, + "description": "Content of the vnf package" + } + } + } + }, + "/import": { + "post": { + "description": "Import vnf packages", + "operationId": "importVnf", + "produces": [ + "application/json", + "application/xml" + ], + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "name": "content", + "in": "formData", + "required": true, + "x-is-map": false, + "type": "file", + "format": "file", + "description": "Content of the imported packages" + }, + { + "name": "Content-MD5", + "in": "header", + "required": true, + "x-is-map": false, + "type": "string", + "description": "The checksum of content" + } + ], + "responses": { + "200": { + "description": "List of vnf packages", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/catalog_adapter_vnfpackage" + } + } + } + } + } + } + }, + "definitions": { + "catalog_adapter_vnf_package_versions": { + "title": "catalog_adapter_vnf_package_versions", + "type": "object", + "properties": { + "result": { + "description": "Result of the versions query operation", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "result" + ] + }, + "catalog_adapter_artifact": { + "title": "catalog_adapter_artifact", + "type": "object", + "properties": { + "name": { + "description": "The name of artifact element. It shall match with the full file path in the ZIP.", + "type": "string" + }, + "type": { + "description": "The type of artifact element. Default is other." + } + }, + "required": [ + "name" + ] + }, + "catalog_adapter_vnfpackage": { + "title": "catalog_adapter_vnfpackage", + "type": "object", + "properties": { + "id": { + "description": "The ID of the vnf package, which is composed of provider~productName~swVersion", + "type": "string" + }, + "vnfdId": { + "description": "The VNFD ID of the vnf package, which is composed of provider~productName~swVersion~version", + "type": "string" + }, + "name": { + "type": "string" + }, + "version": { + "description": "The VNFD version of vnf package", + "type": "string" + }, + "allVersions": { + "description": "List of available versions of the package", + "type": "array", + "items": { + "type": "string" + } + }, + "provider": { + "description": "Provider of the vnf package", + "type": "string" + }, + "productName": { + "description": "Product name of the vnf package", + "type": "string" + }, + "swVersion": { + "description": "Software version of the vnf package", + "type": "string" + }, + "vimType": { + "description": "Vim type of the vnf package. Can be openstack or vmware.", + "type": "string" + }, + "references": { + "description": "references attribute", + "type": "array", + "items": { + "type": "string" + } + }, + "artifacts": { + "description": "The list of files in the vnf package zip", + "type": "array", + "items": { + "$ref": "#/definitions/catalog_adapter_artifact" + } + } + }, + "required": [ + "references", + "artifacts" + ] + } + } +} diff --git a/nokiav2/generatedapis/src/main/resources/nokia.vnfm.api.v3.lcm.json b/nokiav2/generatedapis/src/main/resources/nokia.vnfm.api.v3.lcm.json new file mode 100644 index 00000000..4f2966f7 --- /dev/null +++ b/nokiav2/generatedapis/src/main/resources/nokia.vnfm.api.v3.lcm.json @@ -0,0 +1,4112 @@ +{ + "swagger": "2.0", + "info": { + "version": "v3.2", + "title": "Nokia VNFM API version 3.2 WIP - VNF Lifecycle Management interface" + }, + "basePath": "/vnfm/lcm/v3", + "schemes": [ + "https" + ], + "securityDefinitions": { + "OauthPassword": { + "description": "OAuth 2.0 resource owner password credentials grant (https://tools.ietf.org/html/rfc6749#section-4.3) with bearer token type. Note: the given tokenUrl does not inherit from the basePath\n", + "type": "oauth2", + "tokenUrl": "/auth/realms/cbam/protocol/openid-connect/token", + "flow": "password", + "scopes": { + "default": "default scope" + } + }, + "OauthClient": { + "description": "OAuth 2.0 client credentials grant (https://tools.ietf.org/html/rfc6749#section-4.4) with bearer token type. Note: the given tokenUrl does not inherit from the basePath\n", + "type": "oauth2", + "tokenUrl": "/auth/realms/cbam/protocol/openid-connect/token", + "flow": "application", + "scopes": { + "default": "default scope" + } + } + }, + "security": [ + { + "OauthPassword": [ + "default" + ] + }, + { + "OauthClient": [ + "default" + ] + } + ], + "produces": [ + "application/json", + "application/problem+json" + ], + "consumes": [ + "application/json" + ], + "tags": [ + { + "name": "vnfs" + }, + { + "name": "operation_executions" + } + ], + "paths": { + "/versions": { + "get": { + "description": "Gets the supported microversions for this base url\n", + "responses": { + "200": { + "description": "Microversion information", + "schema": { + "type": "object", + "required": [ + "version", + "minVersion" + ], + "properties": { + "version": { + "description": "The most recent version", + "type": "string" + }, + "minVersion": { + "description": "The oldest supported version\n", + "type": "string" + }, + "defaultVersion": { + "description": "The version that is served automatically if no version header is provided. Defaults to the minVersion if not given.\n", + "type": "string" + } + } + }, + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "versions" + ], + "parameters": [ + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ] + } + }, + "/operation_executions/{operationExecutionId}": { + "get": { + "description": "Gets a single operation execution resource.", + "parameters": [ + { + "$ref": "#/parameters/operationExecutionId" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "200": { + "description": "Successful response, the operation is not executing.", + "schema": { + "$ref": "#/definitions/OperationExecution" + }, + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "202": { + "description": "Successful response, the operation is still ongoing.", + "schema": { + "$ref": "#/definitions/OperationExecution" + }, + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "operation_executions" + ] + } + }, + "/operation_executions/{operationExecutionId}/end_notification": { + "get": { + "description": "Gets the lifecycle change notification correponding to the result of the operation if the execution has finished. **Nokia extension to ETSI NFV IFA007.**\n", + "parameters": [ + { + "$ref": "#/parameters/operationExecutionId" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "200": { + "description": "Successful response, the operation is finished", + "schema": { + "$ref": "#/definitions/AbstractVnfNotification" + }, + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "operation_executions" + ] + } + }, + "/operation_executions/{operationExecutionId}/operation_params": { + "get": { + "description": "Gets the operation parameters correponding to the respective operation execution. **Nokia extension to ETSI NFV IFA007.**\n", + "parameters": [ + { + "$ref": "#/parameters/operationExecutionId" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "type": "object", + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + }, + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "operation_executions" + ] + } + }, + "/operation_executions/{operationExecutionId}/additional_data": { + "get": { + "description": "Gets the implementation specific data corresponding to the respective operation execution. **Nokia extension to ETSI NFV IFA007.**\n", + "parameters": [ + { + "$ref": "#/parameters/operationExecutionId" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "type": "object", + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + }, + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "operation_executions" + ] + } + }, + "/operation_executions/{operationExecutionId}/cancel": { + "post": { + "description": "Cancel the operation execution (if the operation supports it). This has no effect if the operation is not running. The state of the operation execution will change to FAILED when it has been canceled. **Nokia extension to ETSI NFV IFA007.**\n", + "parameters": [ + { + "$ref": "#/parameters/operationExecutionId" + }, + { + "name": "cancelOperationRequest", + "required": true, + "description": "Input parameters for the cancelling of an operation execution", + "in": "body", + "schema": { + "$ref": "#/definitions/CancelOperationRequest" + } + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "200": { + "description": "Operation execution canceled", + "schema": { + "$ref": "#/definitions/OperationExecution" + }, + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "202": { + "description": "Cancel is pending", + "schema": { + "$ref": "#/definitions/OperationExecution" + }, + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "400": { + "description": "Cancel for the given operation is not supported or not meaningful", + "schema": { + "$ref": "#/definitions/ProblemDetails" + }, + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "operation_executions" + ] + } + }, + "/vnfs": { + "post": { + "description": "Creates VNF object", + "parameters": [ + { + "name": "createVnfRequest", + "description": "Parameters for the creation of a VNF instance", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CreateVnfRequest" + } + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "201": { + "description": "Created VNF instance", + "headers": { + "Location": { + "description": "The url of the VNF instance", + "type": "string", + "format": "url" + }, + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "schema": { + "$ref": "#/definitions/VnfInfo" + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "vnfs" + ] + }, + "get": { + "description": "Gets the list of VNF objects.\n", + "responses": { + "200": { + "description": "Successful response", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VnfInfo" + } + }, + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "vnfs" + ], + "parameters": [ + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ] + } + }, + "/vnfs/{vnfInstanceId}": { + "get": { + "description": "Gets VNF object", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/VnfInfo" + }, + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "vnfs" + ] + }, + "delete": { + "description": "Delete VNF instance from VNFM database. This can only be done if the VNF is not currently instantiated\n", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "204": { + "description": "Successful response", + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "vnfs" + ] + }, + "patch": { + "description": "Modifies the VnfInfo. This corresponds to the ModifyVnfInfo operation in IFA007. **Due to the ongoing discussions in ETSI regarding the implementation of this operation, this operation specification should not be considered stable**\n", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "name": "modifyVnfInfoRequest", + "description": "Input parameters for VNF info modification", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ModifyVnfInfoRequest" + } + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "202": { + "$ref": "#/responses/operationExecutionCreated", + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "vnfs" + ] + } + }, + "/vnfs/{vnfInstanceId}/instantiate": { + "post": { + "description": "Instantiates VNF with the given parameters", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "name": "instantiateVnfRequest", + "required": true, + "description": "Input parameters for the instantiation of the VNF instance", + "in": "body", + "schema": { + "$ref": "#/definitions/InstantiateVnfRequest" + } + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "202": { + "$ref": "#/responses/operationExecutionCreated", + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "vnfs" + ] + } + }, + "/vnfs/{vnfInstanceId}/scale": { + "post": { + "description": "Scales the VNF according to the given parameters", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "name": "scaleVnfRequest", + "description": "Input parameters for the scaling operation", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ScaleVnfRequest" + } + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "202": { + "$ref": "#/responses/operationExecutionCreated", + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "vnfs" + ] + } + }, + "/vnfs/{vnfInstanceId}/terminate": { + "post": { + "description": "Terminates the VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "name": "terminateVnfRequest", + "description": "Input parameters for VNF termination", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/TerminateVnfRequest" + } + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "202": { + "$ref": "#/responses/operationExecutionCreated", + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "vnfs" + ] + } + }, + "/vnfs/{vnfInstanceId}/heal": { + "post": { + "description": "Heals the VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "name": "healVnfRequest", + "description": "Input parameters for VNF healing", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/HealVnfRequest" + } + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "202": { + "$ref": "#/responses/operationExecutionCreated", + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "vnfs" + ] + } + }, + "/vnfs/{vnfInstanceId}/upgrade": { + "post": { + "description": "Upgrades the VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "name": "upgradeVnfRequest", + "description": "Input parameters for VNF upgrade", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/UpgradeVnfRequest" + } + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "202": { + "$ref": "#/responses/operationExecutionCreated", + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "vnfs" + ] + } + }, + "/vnfs/{vnfInstanceId}/custom/{customOperationName}": { + "post": { + "description": "Executes custom operation. **Nokia VNFM proprietary extension.**\n", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "name": "customOperationName", + "in": "path", + "description": "The identifier of the custom operation", + "required": true, + "type": "string" + }, + { + "name": "customOperationRequest", + "description": "Input parameters for custom operation", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/CustomOperationRequest" + } + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "202": { + "$ref": "#/responses/operationExecutionCreated", + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "vnfs" + ] + } + }, + "/vnfs/{vnfInstanceId}/instantiated_vnf_info": { + "get": { + "tags": [ + "vnfs" + ], + "description": "Gets the requested instantiated info resource of a VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "$ref": "#/definitions/InstantiatedVnfInfo" + } + } + } + } + }, + "/vnfs/{vnfInstanceId}/operation_executions": { + "get": { + "tags": [ + "vnfs" + ], + "description": "Gets the operation execution resources of a VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "items": { + "$ref": "#/definitions/OperationExecution" + }, + "type": "array" + } + } + } + } + }, + "/vnfs/{vnfInstanceId}/vnfc_resource_info": { + "get": { + "tags": [ + "vnfs" + ], + "description": "Gets the VNFC resources of a VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "items": { + "$ref": "#/definitions/VnfcResourceInfo" + }, + "type": "array" + } + } + } + } + }, + "/vnfs/{vnfInstanceId}/vnfc_resource_info/{vnfcId}": { + "get": { + "tags": [ + "vnfs" + ], + "description": "Gets the requested VNFC resource of a VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "description": "The identifier of the VNFC", + "required": true, + "type": "string", + "name": "vnfcId", + "in": "path" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "$ref": "#/definitions/VnfcResourceInfo" + } + } + } + } + }, + "/vnfs/{vnfInstanceId}/virtual_link_resource_info": { + "get": { + "tags": [ + "vnfs" + ], + "description": "Gets the virtual link resources of a VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "items": { + "$ref": "#/definitions/VirtualLinkResourceInfo" + }, + "type": "array" + } + } + } + } + }, + "/vnfs/{vnfInstanceId}/virtual_link_resource_info/{virtualLinkId}": { + "get": { + "tags": [ + "vnfs" + ], + "description": "Gets the requested virtual link resource of a VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "description": "The identifier of the virtual link", + "required": true, + "type": "string", + "name": "virtualLinkId", + "in": "path" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "$ref": "#/definitions/VirtualLinkResourceInfo" + } + } + } + } + }, + "/vnfs/{vnfInstanceId}/virtual_storage_resource_info": { + "get": { + "tags": [ + "vnfs" + ], + "description": "Gets the virtual storage resources of a VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "items": { + "$ref": "#/definitions/VirtualStorageResourceInfo" + }, + "type": "array" + } + } + } + } + }, + "/vnfs/{vnfInstanceId}/virtual_storage_resource_info/{virtualStorageId}": { + "get": { + "tags": [ + "vnfs" + ], + "description": "Gets the requested virtual storage resource of a VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "description": "The identifier of the virtual storage", + "required": true, + "type": "string", + "name": "virtualStorageId", + "in": "path" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "$ref": "#/definitions/VirtualStorageResourceInfo" + } + } + } + } + }, + "/vnfs/{vnfInstanceId}/ext_cp_info": { + "get": { + "tags": [ + "vnfs" + ], + "description": "Gets the external connection points resources of a VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "items": { + "$ref": "#/definitions/VnfExtCpInfo" + }, + "type": "array" + } + } + } + } + }, + "/vnfs/{vnfInstanceId}/ext_cp_info/{extCpId}": { + "get": { + "tags": [ + "vnfs" + ], + "description": "Gets the requested external connection points resource of a VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "description": "The identifier of the external connection points", + "required": true, + "type": "string", + "name": "extCpId", + "in": "path" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "$ref": "#/definitions/VnfExtCpInfo" + } + } + } + } + }, + "/vnfs/{vnfInstanceId}/ext_virtual_link_info": { + "get": { + "tags": [ + "vnfs" + ], + "description": "Gets the external virtual links resources of a VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "items": { + "$ref": "#/definitions/ExtVirtualLinkInfo" + }, + "type": "array" + } + } + } + } + }, + "/vnfs/{vnfInstanceId}/extensions": { + "get": { + "tags": [ + "vnfs" + ], + "description": "Gets the extension resources of a VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "items": { + "$ref": "#/definitions/VnfProperty" + }, + "type": "array" + } + } + } + } + }, + "/vnfs/{vnfInstanceId}/vnf_configurable_properties": { + "get": { + "tags": [ + "vnfs" + ], + "description": "Gets the configurable porperties resources of a VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "items": { + "$ref": "#/definitions/VnfProperty" + }, + "type": "array" + } + } + } + } + }, + "/vnfs/{vnfInstanceId}/scale_status": { + "get": { + "tags": [ + "vnfs" + ], + "description": "Gets the scaling aspect resources of a VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "items": { + "$ref": "#/definitions/ScaleInfo" + }, + "type": "array" + } + } + } + } + }, + "/vnfs/{vnfInstanceId}/scale_status/{scalingAspectId}": { + "get": { + "tags": [ + "vnfs" + ], + "description": "Gets the requested scaling aspect resource of a VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "description": "The identifier of the scaling aspect", + "required": true, + "type": "string", + "name": "scalingAspectId", + "in": "path" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "$ref": "#/definitions/ScaleInfo" + } + } + } + } + }, + "/vnfs/{vnfInstanceId}/vim_info": { + "get": { + "tags": [ + "vnfs" + ], + "description": "Gets the vim info resources of a VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "items": { + "$ref": "#/definitions/VimInfo" + }, + "type": "array" + } + } + } + } + }, + "/vnfs/{vnfInstanceId}/vim_info/{vimId}": { + "put": { + "tags": [ + "vnfs" + ], + "description": "Updates the specific vim info resource", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "description": "The identifier of the vim info", + "required": true, + "type": "string", + "name": "vimId", + "in": "path" + }, + { + "schema": { + "$ref": "#/definitions/VimInfo" + }, + "required": true, + "name": "updated resource", + "in": "body" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "$ref": "#/definitions/VimInfo" + } + } + } + }, + "get": { + "tags": [ + "vnfs" + ], + "description": "Gets the requested vim info resource of a VNF", + "parameters": [ + { + "$ref": "#/parameters/vnfInstanceId" + }, + { + "description": "The identifier of the vim info", + "required": true, + "type": "string", + "name": "vimId", + "in": "path" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + }, + "200": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Successful response", + "schema": { + "$ref": "#/definitions/VimInfo" + } + } + } + } + } + }, + "parameters": { + "vnfInstanceId": { + "name": "vnfInstanceId", + "in": "path", + "description": "The identifier of the VNF instance", + "required": true, + "type": "string" + }, + "operationExecutionId": { + "name": "operationExecutionId", + "in": "path", + "description": "The identifier of the operation execution", + "required": true, + "type": "string" + } + }, + "responses": { + "operationExecutionCreated": { + "description": "Created operation execution", + "headers": { + "Location": { + "description": "The url of the operation execution", + "type": "string", + "format": "url" + } + }, + "schema": { + "$ref": "#/definitions/OperationExecution" + } + } + }, + "definitions": { + "CreateVnfRequest": { + "type": "object", + "required": [ + "vnfdId" + ], + "properties": { + "vnfdId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "name": { + "description": "The name of the vnf instance\n", + "type": "string" + }, + "description": { + "description": "The description string of the vnf instance\n", + "type": "string" + } + } + }, + "InstantiateVnfRequest": { + "type": "object", + "required": [ + "flavourId", + "vims", + "extVirtualLinks" + ], + "properties": { + "flavourId": { + "description": "An identifier that is unique within a VNF descriptor.\n", + "type": "string" + }, + "instantiationLevelId": { + "description": "An identifier that is unique within a VNF descriptor.\n", + "type": "string" + }, + "vims": { + "description": "Vim information given for instantiation (in this API version only one VIM per VNF is supported). **Nokia extension to ETSI NFV IFA007.** **The vim information is factored out from the external virtual link data structure.**\n", + "type": "array", + "items": { + "$ref": "#/definitions/VimInfo" + } + }, + "extVirtualLinks": { + "description": "References to external virtual links to connect the VNF to.\n", + "type": "array", + "items": { + "$ref": "#/definitions/ExtVirtualLinkData" + } + }, + "extManagedVirtualLinks": { + "description": "References to internal virtual links that are managed by other entities than the VNFM\n", + "type": "array", + "items": { + "$ref": "#/definitions/ExtManagedVirtualLinkData" + } + }, + "localizationLanguage": { + "type": "string" + }, + "additionalParams": { + "description": "Additional parameters passed by the NFVO as input to the instantiation process, specific to the VNF being instantiated.\n", + "type": "object", + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + }, + "grantlessMode": { + "description": "**Nokia VNFM proprietary property.** The NOKIA VNFM API may be used in an environment without an NFVO. This switch determines whether the VNFM should operate without requesting grants from an NFVO. In this case all information that would be passed in the grant responses needs to be passed with the instantiation parameters. The value of this switch applies to all subsequent operations until the VNF is terminated. **Note: Actual grant support is not currently part of the NOKIA VNFM API specification**\n", + "type": "boolean", + "default": false + }, + "computeResourceFlavours": { + "description": "**Nokia VNFM proprietary property.** Mappings between VirtualComputeDescriptors defined in the VNFD and compute resource flavours managed in the VIM. **Only used in grantless operation mode.**\n", + "type": "array", + "items": { + "$ref": "#/definitions/VimComputeResourceFlavour" + } + }, + "softwareImages": { + "description": "**Nokia VNFM proprietary property.** Mappings between software images defined in the VNFD and software images managed in the VIM. **Only used in grantless operation mode.**\n", + "type": "array", + "items": { + "$ref": "#/definitions/VimSoftwareImage" + } + }, + "zones": { + "description": "**Nokia VNFM proprietary property.** Identifies resource zones where the resources are approved to be allocated by the VNFM. **Only used in grantless operation mode.**\n", + "type": "array", + "items": { + "$ref": "#/definitions/ZoneInfo" + } + } + } + }, + "OperationExecution": { + "description": "**Apart from id and status, all other fields represent Nokia extensions to IFA007.** The operation end notification can be retrieved as sub-resource of the operation execution resource itself. Additionally all the input parameters for the operation are stored.\n", + "type": "object", + "required": [ + "vnfInstanceId", + "operationType", + "status", + "id", + "startTime", + "isCancelPending" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "vnfInstanceId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "operationType": { + "description": "Type of the operation that this structure is related to\n", + "$ref": "#/definitions/OperationType" + }, + "operationName": { + "description": "Name of the operation (mostly useful for distinguishing custom operations)\n", + "type": "string" + }, + "status": { + "description": "Execution status of the operation that this structure is related to\n", + "$ref": "#/definitions/OperationStatus" + }, + "isCancelPending": { + "description": "If the LCM operation occurrence is in executing state and the operation is being cancelled, this attribute shall be set to true. Otherwise, it shall be set to false.\n", + "type": "boolean" + }, + "cancelMode": { + "$ref": "#/definitions/CancelMode" + }, + "error": { + "description": "If the status of the notification is \"finished\" and there was error during the execution, then it will be reported in this field\n", + "$ref": "#/definitions/ProblemDetails" + }, + "startTime": { + "description": "Date-time of the beginning of the operation execution (formatted according to RFC-3339)\n", + "type": "string", + "format": "date-time" + }, + "finishTime": { + "description": "Date-time of the end of the operation execution (formatted according to RFC-3339)\n", + "type": "string", + "format": "date-time" + }, + "grantId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "operationParams": { + "description": "**This property is only returned when the containing resource is queried by id and not listed.** Original input parameters for the operation.\n", + "type": "object", + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + }, + "additionalData": { + "description": "**This property is only returned when the containing resource is queried by id and not listed.** Implementation-specific data for the execution, e.g. internal workflow id.\n", + "type": "object", + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + }, + "metadata": { + "description": "Additional metadata related to the operation execution.\n", + "type": "object", + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + }, + "_links": { + "required": [ + "self" + ], + "type": "object", + "description": "Link relations for this object", + "properties": { + "self": { + "$ref": "#/definitions/Link" + }, + "operationParams": { + "$ref": "#/definitions/Link" + }, + "additionalData": { + "$ref": "#/definitions/Link" + }, + "list": { + "$ref": "#/definitions/Link" + }, + "cancel": { + "$ref": "#/definitions/Link" + }, + "vnf": { + "$ref": "#/definitions/Link" + }, + "endNotification": { + "$ref": "#/definitions/Link" + } + } + } + } + }, + "CancelMode": { + "type": "string", + "description": "Cancellation mode.\n", + "enum": [ + "GRACEFUL", + "FORCEFUL" + ] + }, + "CancelOperationRequest": { + "type": "object", + "required": [ + "cancelMode" + ], + "properties": { + "cancelMode": { + "$ref": "#/definitions/CancelMode" + } + } + }, + "TerminateVnfRequest": { + "type": "object", + "required": [ + "terminationType" + ], + "properties": { + "terminationType": { + "description": "Signals whether forceful or graceful termination is requested. In case of forceful termination, the VNF is shut down immediately, and resources are released. Note that if the VNF is still in service, this may adversely impact network service, and therefore, operator policies apply to determine if forceful termination is allowed in the particular situation. In case of graceful termination, the VNFM first arranges to take the VNF out of service (by means out of scope of the present specification, e.g. involving interaction with EM, if required). Once this was successful, or after a timeout, the VNFM shuts down the VNF and releases the resources.\n", + "$ref": "#/definitions/TerminationType" + }, + "gracefulTerminationTimeout": { + "description": "The time interval (in seconds) to wait for the VNF to be taken out of service during graceful termination, before shutting down the VNF and releasing the resources. If not given, it is expected that the VNFM waits for the successful taking out of service of the VNF, no matter how long it takes, before shutting down the VNF and releasing the resources (see note). Minimum timeout or timeout range are specified by the VNF Provider (e.g. defined in the VNFD or communicated by other means). Not relevant in case of forceful termination.\n", + "type": "integer" + }, + "additionalParams": { + "description": "Additional parameters passed by the NFVO as input to the scaling process. **Nokia extension to ETSI NFV IFA007.**\n", + "type": "object", + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + } + } + }, + "TerminationType": { + "type": "string", + "enum": [ + "GRACEFUL", + "FORCEFUL" + ] + }, + "ScaleVnfRequest": { + "type": "object", + "required": [ + "type", + "aspectId" + ], + "properties": { + "type": { + "description": "Defines the type of the scale operation requested (scale out, scale in). The set of types actually supported depends on the capabilities of the VNF being managed, as declared in the VNFD.\n", + "$ref": "#/definitions/ScaleDirection" + }, + "aspectId": { + "description": "An identifier that is unique within a VNF descriptor.\n", + "type": "string" + }, + "numberOfSteps": { + "description": "Number of scaling steps to be executed as part of this ScaleVnf operation. It shall be a positive number. Defaults to 1.\n", + "type": "integer", + "default": 1 + }, + "additionalParams": { + "description": "Additional parameters passed by the NFVO as input to the scaling process.\n", + "type": "object", + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + } + } + }, + "ScaleDirection": { + "type": "string", + "enum": [ + "OUT", + "IN" + ] + }, + "HealVnfRequest": { + "type": "object", + "properties": { + "cause": { + "description": "Indicates the reason why a healing procedure is required.\n", + "type": "string" + }, + "additionalParams": { + "description": "Additional parameters passed by the NFVO as input to the healing process, specific to the VNF being healed.\n", + "type": "object", + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + } + } + }, + "UpgradeVnfRequest": { + "description": "**Nokia extension to ETSI NFV IFA007**\n", + "type": "object", + "required": [ + "vnfdId" + ], + "properties": { + "vnfdId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "add": { + "description": "New external resource information to be added (to the usable set of external resources for the VNF) according to the requirements of the new VNFD.\n", + "$ref": "#/definitions/UpgradeAddResources" + }, + "remove": { + "description": "External resource information to be removed (from the usable set of external resources for the VNF) according to the requirements of the new VNFD. Resources currently used by the VNF cannot be removed.\n", + "$ref": "#/definitions/UpgradeRemoveResources" + }, + "modify": { + "description": "External resource information and parameters to be modified according to the requirements of the new VNFD\n", + "$ref": "#/definitions/UpgradeModifyResources" + }, + "additionalParams": { + "description": "Additional parameters passed to the upgrade process, specific to the VNF being upgraded and the new VNFD.\n", + "type": "object", + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + } + } + }, + "UpgradeAddResources": { + "type": "object", + "properties": { + "extVirtualLinks": { + "description": "External virtual link information and external connection point information to add (including new addresses to use)\n", + "type": "array", + "items": { + "$ref": "#/definitions/ExtVirtualLinkData" + } + }, + "extManagedVirtualLinks": { + "description": "External managed virtual links to add.\n", + "type": "array", + "items": { + "$ref": "#/definitions/ExtManagedVirtualLinkData" + } + }, + "zones": { + "description": "Zones to add. Only used in grantless mode.\n", + "type": "array", + "items": { + "$ref": "#/definitions/ZoneInfo" + } + } + } + }, + "UpgradeRemoveResources": { + "type": "object", + "properties": { + "extVirtualLinks": { + "description": "External virtual link information and external connection point information to remove (including addresses to remove)\n", + "type": "array", + "items": { + "$ref": "#/definitions/ExtVirtualLinkData" + } + }, + "extManagedVirtualLinks": { + "description": "External managed virtual links to remove.\n", + "type": "array", + "items": { + "$ref": "#/definitions/ExtManagedVirtualLinkData" + } + }, + "zones": { + "description": "Zones to remove. Only used in grantless mode.\n", + "type": "array", + "items": { + "$ref": "#/definitions/ZoneInfo" + } + } + } + }, + "UpgradeModifyResources": { + "type": "object", + "properties": { + "computeResourceFlavours": { + "description": "Mappings between VirtualComputeDescriptors defined in the (new) VNFD and compute resource flavours managed in the VIM. If applicable, existing VNFCs should be changed to use these compute resource flavours.\n", + "type": "array", + "items": { + "$ref": "#/definitions/VimComputeResourceFlavour" + } + }, + "softwareImages": { + "description": "Mappings between software images defined in the (new) VNFD and software images managed in the VIM. If applicable, existing VNFCs should be changed to use these software images.\n", + "type": "array", + "items": { + "$ref": "#/definitions/VimSoftwareImage" + } + }, + "extensions": { + "description": "The new extension values that should be set. These extensions may affect the upgrade and should take into consideration the extension set provided by the new VNFD\n", + "type": "array", + "items": { + "$ref": "#/definitions/VnfProperty" + } + } + } + }, + "CustomOperationRequest": { + "type": "object", + "properties": { + "additionalParams": { + "description": "Additional parameters passed by the NFVO as input to the custom operation.\n", + "type": "object", + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + } + } + }, + "VnfInfo": { + "description": "Information about a VNF instance.\n", + "type": "object", + "required": [ + "id", + "vnfdId", + "vnfSoftwareVersion", + "vnfdVersion", + "onboardedVnfPkgInfoId", + "instantiationState" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "name": { + "description": "VNF instance name.\n", + "type": "string" + }, + "description": { + "description": "Human-readable description of the VNF instance.\n", + "type": "string" + }, + "vnfdId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "vnfProvider": { + "description": "Name of the person or company providing the VNF.\n", + "type": "string" + }, + "vnfProductName": { + "description": "Name of the Vnf prodct.\n", + "type": "string" + }, + "vnfSoftwareVersion": { + "type": "string" + }, + "vnfdVersion": { + "type": "string" + }, + "onboardedVnfPkgInfoId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "instantiationState": { + "description": "Current state of the instantiation of the VNF\n", + "$ref": "#/definitions/InstantiationState" + }, + "operationExecutions": { + "description": "**This property is only returned when the containing resource is queried by id and not listed.** Operations executed on the VNF instance\n", + "type": "array", + "items": { + "$ref": "#/definitions/OperationExecution" + } + }, + "instantiatedVnfInfo": { + "description": "**This property is only returned when the containing resource is queried by id and not listed.** Information specific to an instantiated VNF instance.\n", + "$ref": "#/definitions/InstantiatedVnfInfo" + }, + "vnfConfigurableProperties": { + "description": "**This property is only returned when the containing resource is queried by id and not listed.** Current values of the configurable properties of the VNF instance.\n", + "type": "array", + "items": { + "$ref": "#/definitions/VnfProperty" + } + }, + "extensions": { + "description": "**This property is only returned when the containing resource is queried by id and not listed.** VNF-specific attributes.\n", + "type": "array", + "items": { + "$ref": "#/definitions/VnfProperty" + } + }, + "metadata": { + "description": "Additional metadata describing the VNF instance.\n", + "type": "object", + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + }, + "_links": { + "required": [ + "self" + ], + "type": "object", + "description": "Link relations for this object", + "properties": { + "self": { + "$ref": "#/definitions/Link" + }, + "operationExecutions": { + "$ref": "#/definitions/Link" + }, + "instantiatedVnfInfo": { + "$ref": "#/definitions/Link" + }, + "vnfConfigurableProperties": { + "$ref": "#/definitions/Link" + }, + "extensions": { + "$ref": "#/definitions/Link" + }, + "list": { + "$ref": "#/definitions/Link" + }, + "delete": { + "$ref": "#/definitions/Link" + }, + "instantiate": { + "$ref": "#/definitions/Link" + }, + "scale": { + "$ref": "#/definitions/Link" + }, + "terminate": { + "$ref": "#/definitions/Link" + }, + "modifyInfo": { + "$ref": "#/definitions/Link" + }, + "heal": { + "$ref": "#/definitions/Link" + } + } + } + } + }, + "InstantiationState": { + "type": "string", + "enum": [ + "NOT_INSTANTIATED", + "INSTANTIATED" + ] + }, + "InstantiatedVnfInfo": { + "type": "object", + "required": [ + "flavourId", + "vnfState" + ], + "properties": { + "flavourId": { + "description": "An identifier that is unique within a VNF descriptor.\n", + "type": "string" + }, + "localizationLanguage": { + "type": "string" + }, + "vnfState": { + "description": "The state of the VNF instance.\n", + "$ref": "#/definitions/VnfState" + }, + "scaleStatus": { + "description": "Scale status of the VNF, one entry per aspect. Shall be present if the VNF supports scaling.\n", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleInfo" + } + }, + "extCpInfo": { + "description": "**This property is only returned when the containing resource is queried by id and not listed.** External connection points exposed by the VNF instance.\n", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/VnfExtCpInfo" + } + }, + "extVirtualLinkInfo": { + "description": "**This property is only returned when the containing resource is queried by id and not listed.** External virtual links the VNF instance is connected to.\n", + "type": "array", + "items": { + "$ref": "#/definitions/ExtVirtualLinkInfo" + } + }, + "extManagedVirtualLinkInfo": { + "description": "**This property is only returned when the containing resource is queried by id and not listed.** External virtual links the VNF instance is connected to.\n", + "type": "array", + "items": { + "$ref": "#/definitions/ExtManagedVirtualLinkInfo" + } + }, + "vimInfo": { + "description": "**This property is only returned when the containing resource is queried by id and not listed.** Information about VIM(s) that manage resources for the VNF instance.\n", + "type": "array", + "items": { + "$ref": "#/definitions/VimInfo" + } + }, + "vnfcResourceInfo": { + "description": "**This property is only returned when the containing resource is queried by id and not listed.** Information on the virtualised compute and storage resource(s) used by the VNFCs of the VNF instance.\n", + "type": "array", + "items": { + "$ref": "#/definitions/VnfcResourceInfo" + } + }, + "virtualLinkResourceInfo": { + "description": "**This property is only returned when the containing resource is queried by id and not listed.** Information on the virtualised network resource(s) used by the VLs of the VNF instance.\n", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualLinkResourceInfo" + } + }, + "virtualStorageResourceInfo": { + "description": "**This property is only returned when the containing resource is queried by id and not listed.** Information on the virtualised storage resource(s) used as storage for the VNF instance.\n", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualStorageResourceInfo" + } + }, + "_links": { + "required": [ + "self" + ], + "type": "object", + "description": "Link relations for this object", + "properties": { + "self": { + "$ref": "#/definitions/Link" + }, + "extCpInfo": { + "$ref": "#/definitions/Link" + }, + "extVirtualLinkInfo": { + "$ref": "#/definitions/Link" + }, + "extManagedVirtualLinkInfo": { + "$ref": "#/definitions/Link" + }, + "vimInfo": { + "$ref": "#/definitions/Link" + }, + "vnfcResourceInfo": { + "$ref": "#/definitions/Link" + }, + "virtualLinkResourceInfo": { + "$ref": "#/definitions/Link" + }, + "virtualStorageResourceInfo": { + "$ref": "#/definitions/Link" + }, + "vnf": { + "$ref": "#/definitions/Link" + } + } + } + } + }, + "VnfcResourceInfo": { + "allOf": [ + { + "$ref": "#/definitions/AbstractVnfcResourceInfo" + }, + { + "type": "object", + "properties": { + "_links": { + "required": [ + "self" + ], + "type": "object", + "description": "Link relations for this object", + "properties": { + "self": { + "$ref": "#/definitions/Link" + }, + "vnf": { + "$ref": "#/definitions/Link" + } + } + } + } + } + ] + }, + "VirtualLinkResourceInfo": { + "allOf": [ + { + "$ref": "#/definitions/AbstractVirtualLinkResourceInfo" + }, + { + "type": "object", + "properties": { + "_links": { + "required": [ + "self" + ], + "type": "object", + "description": "Link relations for this object", + "properties": { + "self": { + "$ref": "#/definitions/Link" + }, + "vnf": { + "$ref": "#/definitions/Link" + } + } + } + } + } + ] + }, + "VirtualStorageResourceInfo": { + "allOf": [ + { + "$ref": "#/definitions/AbstractVirtualStorageResourceInfo" + }, + { + "type": "object", + "properties": { + "_links": { + "required": [ + "self" + ], + "type": "object", + "description": "Link relations for this object", + "properties": { + "self": { + "$ref": "#/definitions/Link" + }, + "vnf": { + "$ref": "#/definitions/Link" + } + } + } + } + } + ] + }, + "ExtVirtualLinkInfo": { + "type": "object", + "required": [ + "resource" + ], + "properties": { + "extVirtualLinkId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "resource": { + "description": "The resource realizing this VL.\n", + "$ref": "#/definitions/ResourceInfo" + }, + "linkPorts": { + "description": "Link ports of this VL.\n", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/VnfLinkPort" + } + } + } + }, + "ExtManagedVirtualLinkInfo": { + "type": "object", + "required": [ + "virtualLinkResourceInfoId" + ], + "properties": { + "extManagedVirtualLinkId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "virtualLinkResourceInfoId": { + "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type": "string" + }, + "linkPorts": { + "description": "Link ports of this VL. This is optional even if there are linkports allocated to this VL.\n", + "type": "array", + "items": { + "$ref": "#/definitions/VnfLinkPort" + } + } + } + }, + "VnfLinkPort": { + "type": "object", + "required": [ + "resource" + ], + "properties": { + "resource": { + "description": "Identifier of the virtualised network resource realizing this link port.\n", + "$ref": "#/definitions/ResourceHandle" + }, + "cpInstanceId": { + "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type": "string" + } + } + }, + "VnfExtCpInfo": { + "type": "object", + "required": [ + "id", + "cpdId" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type": "string" + }, + "cpdId": { + "description": "An identifier that is unique within a VNF descriptor.\n", + "type": "string" + }, + "addresses": { + "description": "List of network addresses configured on the connection point instance.\n", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkAddress" + } + }, + "metadata": { + "description": "**Nokia extension to ETSI NFV IFA007.** Metadata for the external connection point.\n", + "type": "object", + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + }, + "_links": { + "required": [ + "self" + ], + "type": "object", + "description": "Link relations for this object", + "properties": { + "self": { + "$ref": "#/definitions/Link" + }, + "vnf": { + "$ref": "#/definitions/Link" + } + } + } + } + }, + "VnfState": { + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "ERROR" + ] + }, + "ScaleInfo": { + "required": [ + "aspect", + "scaleLevel" + ], + "type": "object", + "properties": { + "aspect": { + "description": "An identifier that is unique within a VNF descriptor.\n", + "type": "string" + }, + "scaleLevel": { + "description": "Current level of the scaling aspect.\n", + "type": "integer" + }, + "maxScaleLevel": { + "description": "**Nokia VNFM proprietary property.** The maximum level that the scaling aspect can have.\n", + "type": "integer" + }, + "_links": { + "required": [ + "self" + ], + "type": "object", + "description": "Link relations for this object", + "properties": { + "self": { + "$ref": "#/definitions/Link" + }, + "vnf": { + "$ref": "#/definitions/Link" + } + } + } + } + }, + "Link": { + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "The URL that references the target resource.\n", + "type": "string", + "format": "url" + } + } + }, + "AbstractVnfNotification": { + "description": "This is a base type that has derivatives. In all places where it is referenced the following types should be expected: ['VnfIdentifierCreationNotification', 'VnfIdentifierDeletionNotification', 'OtherNotification', 'VnfInfoAttributeValueChangeNotification', 'VnfLifecycleChangeNotification']. The actual type is determined by the field 'notificationType' which contains the type name.", + "type": "object", + "required": [ + "notificationType", + "vnfInstanceId", + "timestamp" + ], + "discriminator": "notificationType", + "properties": { + "notificationType": { + "description": "discriminator type for different notifications", + "$ref": "#/definitions/VnfNotificationType" + }, + "subscriptionId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "timestamp": { + "description": "Date-time of the generation of the notification (formatted according to RFC-3339)\n", + "type": "string", + "format": "date-time" + }, + "vnfInstanceId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + } + } + }, + "VnfIdentifierCreationNotification": { + "allOf": [ + { + "$ref": "#/definitions/AbstractVnfNotification" + } + ] + }, + "VnfIdentifierDeletionNotification": { + "allOf": [ + { + "$ref": "#/definitions/AbstractVnfNotification" + } + ] + }, + "OtherNotification": { + "allOf": [ + { + "$ref": "#/definitions/AbstractVnfNotification" + }, + { + "type": "object" + } + ] + }, + "VnfProperty": { + "type": "object", + "required": [ + "name", + "value" + ], + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + }, + "properties": { + "name": { + "description": "The name of the respective property\n", + "type": "string" + }, + "description": { + "description": "The description of the respective property\n", + "type": "string" + }, + "value": { + "description": "Any json value\n", + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ], + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + } + } + }, + "ModifyVnfInfoRequest": { + "description": "Contents of the ModifyVnfInfoRequest will be merged with VnfInfo according to JSON Merge Patch (RFC 7396) with the following extensions: VnfProperty arrays can be selectively updated with the given properties, also extensions and vnfConfigurableProperties cannot be deleted or added\n", + "type": "object", + "properties": { + "name": { + "description": "The new name to be set for the VNF instance\n", + "type": "string" + }, + "description": { + "description": "The new description to be set for the VNF instance\n", + "type": "string" + }, + "metadata": { + "description": "The new metadata to be set for the VNF instance.\n", + "type": "object", + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + }, + "vnfConfigurableProperties": { + "description": "The new configurable properties that should be set. (Configurable properties that are not provided won't be modified.)\n", + "type": "array", + "items": { + "$ref": "#/definitions/VnfProperty" + } + }, + "extensions": { + "description": "New extension values that should be set. (Extensions that are not provided won't be modified.)\n", + "type": "array", + "items": { + "$ref": "#/definitions/VnfProperty" + } + } + } + }, + "AttributeValueChanges": { + "allOf": [ + { + "$ref": "#/definitions/ModifyVnfInfoRequest" + }, + { + "type": "object", + "properties": { + "vnfdId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "vnfProvider": { + "description": "Name of the person or company providing the VNF. **Inclusion of this field means that the respective value changed as a result of a template package update on the VNF instance.**\n", + "type": "string" + }, + "vnfProductName": { + "description": "Name of the Vnf prodct. **Inclusion of this field means that the respective value changed as a result of a template package update on the VNF instance.**\n", + "type": "string" + }, + "vnfSoftwareVersion": { + "type": "string" + }, + "vnfdVersion": { + "type": "string" + }, + "onboardedVnfPkgInfoId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + } + } + } + ] + }, + "VnfInfoAttributeValueChangeNotification": { + "allOf": [ + { + "$ref": "#/definitions/AbstractVnfNotification" + }, + { + "type": "object", + "required": [ + "changedInfo" + ], + "properties": { + "changedInfo": { + "$ref": "#/definitions/AttributeValueChanges" + } + } + } + ] + }, + "VnfLifecycleChangeNotification": { + "allOf": [ + { + "$ref": "#/definitions/AbstractVnfNotification" + }, + { + "type": "object", + "required": [ + "operation", + "status", + "lifecycleOperationOccurrenceId" + ], + "properties": { + "lifecycleOperationOccurrenceId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "operation": { + "description": "Type of the operation that this structure is related to\n", + "$ref": "#/definitions/OperationType" + }, + "status": { + "description": "Execution status of the operation that this structure is related to\n", + "$ref": "#/definitions/OperationStatus" + }, + "error": { + "description": "If the status of the notification is \"finished\" and there was error during the execution, then it will be reported in this field\n", + "$ref": "#/definitions/ProblemDetails" + }, + "affectedVnfcs": { + "description": "Information about VNFC instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation.\n", + "type": "array", + "items": { + "$ref": "#/definitions/AffectedVnfc" + } + }, + "affectedVirtualLinks": { + "description": "Information about VL instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation.\n", + "type": "array", + "items": { + "$ref": "#/definitions/AffectedVirtualLink" + } + }, + "affectedVirtualStorages": { + "description": "Information about virtualised storage instances that were affected during the lifecycle operation, if this notification represents the result of a lifecycle operation.\n", + "type": "array", + "items": { + "$ref": "#/definitions/AffectedVirtualStorage" + } + } + } + } + ] + }, + "OperationStatus": { + "description": "**FINISHED** means successful completion as opposed to FAILED, which means unsuccessful completion of the operation. **OTHER** is reserved for forward compatibility with later microversions.\n", + "type": "string", + "enum": [ + "STARTED", + "FINISHED", + "FAILED", + "OTHER" + ] + }, + "AbstractVnfcResourceInfo": { + "description": "Abstract type, not used in itself\n", + "type": "object", + "required": [ + "id", + "vduId", + "computeResource" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type": "string" + }, + "vduId": { + "description": "An identifier that is unique within a VNF descriptor.\n", + "type": "string" + }, + "computeResource": { + "description": "The compute resource in the VIM\n", + "$ref": "#/definitions/ResourceHandle" + }, + "storageResourceIds": { + "description": "Instance identifiers of associated storage resources\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type": "string" + } + } + } + }, + "AbstractVirtualLinkResourceInfo": { + "description": "Abstract type, not used in itself\n", + "type": "object", + "required": [ + "id", + "virtualLinkDescId" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type": "string" + }, + "virtualLinkDescId": { + "description": "An identifier that is unique within a VNF descriptor.\n", + "type": "string" + }, + "resource": { + "description": "The network resource in the VIM\n", + "$ref": "#/definitions/ResourceHandle" + } + } + }, + "AbstractVirtualStorageResourceInfo": { + "description": "Abstract type, not used in itself\n", + "type": "object", + "required": [ + "id", + "virtualStorageDescId" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type": "string" + }, + "virtualStorageDescId": { + "description": "An identifier that is unique within a VNF descriptor.\n", + "type": "string" + }, + "resource": { + "description": "The storage resource in the VIM\n", + "$ref": "#/definitions/ResourceHandle" + } + } + }, + "ChangedResource": { + "type": "object", + "required": [ + "changeType" + ], + "properties": { + "changeType": { + "description": "The type of change of the resource\n", + "$ref": "#/definitions/ChangeType" + } + } + }, + "AffectedVnfc": { + "allOf": [ + { + "$ref": "#/definitions/AbstractVnfcResourceInfo" + }, + { + "$ref": "#/definitions/ChangedResource" + } + ] + }, + "AffectedVirtualLink": { + "allOf": [ + { + "$ref": "#/definitions/AbstractVirtualLinkResourceInfo" + }, + { + "$ref": "#/definitions/ChangedResource" + } + ] + }, + "AffectedVirtualStorage": { + "allOf": [ + { + "$ref": "#/definitions/AbstractVirtualStorageResourceInfo" + }, + { + "$ref": "#/definitions/ChangedResource" + } + ] + }, + "ChangeType": { + "type": "string", + "enum": [ + "ADDED", + "REMOVED", + "MODIFIED" + ] + }, + "EndpointInfo": { + "type": "object", + "required": [ + "endpoint" + ], + "properties": { + "endpoint": { + "description": "The url representing the interface endpoint.\n", + "type": "string", + "format": "url" + }, + "trustedCertificates": { + "description": "A collection of base64 encoded certificates to be trusted in relation to the endpoint.\n", + "type": "array", + "items": { + "type": "string", + "format": "byte" + } + }, + "skipCertificateVerification": { + "description": "Certificate verification for the endpoint can be skipped by setting this field to true. (Only meaningful for connections with certificate exchange)\n", + "type": "boolean", + "default": false + }, + "skipCertificateHostnameCheck": { + "description": "Certificate hostname check for the endpoint can be skipped by setting this field to true. (Only meaningful for connections with certificate exchange)\n", + "type": "boolean", + "default": false + } + } + }, + "UsernamePassword": { + "type": "object", + "required": [ + "username" + ], + "properties": { + "username": { + "description": "the username to use for access\n", + "type": "string" + }, + "password": { + "description": "the password to use for access. **Note: required for input, not returned on output**\n", + "type": "string", + "format": "password" + } + } + }, + "VimInfo": { + "type": "object", + "required": [ + "id", + "vimInfoType" + ], + "discriminator": "vimInfoType", + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "vimInfoType": { + "description": "**Nokia extension to ETSI NFV IFA007.** Type of the VIM info structure. This field will be used as a discriminator for different types of VIMs. OTHER_VIM_INFO is provided for forward compatibility with later microversions of the API.\n", + "type": "string", + "enum": [ + "OPENSTACK_V2_INFO", + "OPENSTACK_V3_INFO", + "VMWARE_VCLOUD_INFO", + "OTHER_VIM_INFO" + ] + } + }, + "description": "This is a base type that has derivatives. In all places where it is referenced the following types should be expected: ['OPENSTACK_V2_INFO', 'OPENSTACK_V3_INFO', 'VMWARE_VCLOUD_INFO', 'OTHER_VIM_INFO']. The actual type is determined by the field 'vimInfoType' which contains the type name." + }, + "OPENSTACK_V2_INFO": { + "description": "OpenStack connection information for Keystone V2\n", + "allOf": [ + { + "$ref": "#/definitions/VimInfo" + }, + { + "type": "object", + "required": [ + "interfaceInfo", + "accessInfo" + ], + "properties": { + "interfaceInfo": { + "description": "The Keystone endpoint information\n", + "$ref": "#/definitions/EndpointInfo" + }, + "accessInfo": { + "description": "Access information for Keystone V2\n", + "$ref": "#/definitions/OpenStackAccessInfoV2" + } + } + } + ] + }, + "OPENSTACK_V3_INFO": { + "description": "OpenStack connection information for Keystone V3\n", + "allOf": [ + { + "$ref": "#/definitions/VimInfo" + }, + { + "type": "object", + "required": [ + "interfaceInfo", + "accessInfo" + ], + "properties": { + "interfaceInfo": { + "description": "The Keystone endpoint information\n", + "$ref": "#/definitions/EndpointInfo" + }, + "accessInfo": { + "description": "Access information for Keystone V3\n", + "$ref": "#/definitions/OpenStackAccessInfoV3" + } + } + } + ] + }, + "OpenStackAccessInfoV2": { + "description": "OpenStack access information for Keystone V2\n", + "allOf": [ + { + "$ref": "#/definitions/UsernamePassword" + }, + { + "type": "object", + "required": [ + "region", + "tenant" + ], + "properties": { + "region": { + "description": "The OpenStack region to use for the VIM connection\n", + "type": "string" + }, + "tenant": { + "description": "The OpenStack tenant to use for the VIM connection\n", + "type": "string" + } + } + } + ] + }, + "OpenStackAccessInfoV3": { + "description": "OpenStack access information for Keystone V3\n", + "allOf": [ + { + "$ref": "#/definitions/UsernamePassword" + }, + { + "type": "object", + "required": [ + "region", + "project", + "domain" + ], + "properties": { + "region": { + "description": "The OpenStack region to use for the VIM connection\n", + "type": "string" + }, + "project": { + "description": "The OpenStack project to use for the VIM connection\n", + "type": "string" + }, + "domain": { + "description": "The OpenStack domain to use for the VIM connection\n", + "type": "string" + } + } + } + ] + }, + "VMWARE_VCLOUD_INFO": { + "description": "Connection information for a VMware vCloud with optional vROPS support\n", + "allOf": [ + { + "$ref": "#/definitions/VimInfo" + }, + { + "type": "object", + "required": [ + "interfaceInfo", + "accessInfo" + ], + "properties": { + "interfaceInfo": { + "description": "Interface information for the vCloud endpoint\n", + "$ref": "#/definitions/EndpointInfo" + }, + "accessInfo": { + "$ref": "#/definitions/VCloudAccessInfo" + } + } + } + ] + }, + "VCloudAccessInfo": { + "allOf": [ + { + "$ref": "#/definitions/UsernamePassword" + }, + { + "type": "object", + "required": [ + "organization" + ], + "properties": { + "organization": { + "description": "The organization to use for the VIM connection\n", + "type": "string" + } + } + } + ] + }, + "OTHER_VIM_INFO": { + "allOf": [ + { + "$ref": "#/definitions/VimInfo" + }, + { + "type": "object" + } + ] + }, + "ZoneInfo": { + "description": "**Nokia change to ETSI NFV IFA007: zoneInfoId and zoneId merged into id.**\n", + "allOf": [ + { + "$ref": "#/definitions/ResourceInfo" + }, + { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n", + "type": "string" + } + } + } + ] + }, + "VimComputeResourceFlavour": { + "allOf": [ + { + "$ref": "#/definitions/ResourceInfo" + }, + { + "type": "object", + "required": [ + "vnfdVirtualComputeDescId" + ], + "properties": { + "vnfdVirtualComputeDescId": { + "description": "An identifier that is unique within a VNF descriptor.\n", + "type": "string" + } + } + } + ] + }, + "VimSoftwareImage": { + "allOf": [ + { + "$ref": "#/definitions/ResourceInfo" + }, + { + "type": "object", + "required": [ + "vnfdSoftwareImageId" + ], + "properties": { + "vnfdSoftwareImageId": { + "description": "An identifier that is unique within a VNF descriptor.\n", + "type": "string" + } + } + } + ] + }, + "ExtManagedVirtualLinkData": { + "description": "**Nokia change to ETSI NFV IFA007: factored out vim info.**\n", + "allOf": [ + { + "$ref": "#/definitions/ResourceInfo" + }, + { + "type": "object", + "required": [ + "virtualLinkDescId" + ], + "properties": { + "extManagedVirtualLinkId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "virtualLinkDescId": { + "description": "An identifier that is unique within a VNF descriptor.\n", + "type": "string" + } + } + } + ] + }, + "ExtVirtualLinkData": { + "description": "**Nokia change to ETSI NFV IFA007: factored out vim info.**\n", + "allOf": [ + { + "$ref": "#/definitions/ResourceInfo" + }, + { + "type": "object", + "required": [ + "extCps" + ], + "properties": { + "extVirtualLinkId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "extCps": { + "description": "External connection points of the VNF to be connected to this virtual link.\n", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/VnfExtCpData" + } + } + } + } + ] + }, + "VnfExtCpData": { + "type": "object", + "required": [ + "cpdId" + ], + "properties": { + "cpdId": { + "description": "An identifier that is unique within a VNF descriptor.\n", + "type": "string" + }, + "addresses": { + "description": "List of (fixed) network addresses that need to be configured on the connection point. It shall be provided for configuring fixed addresses.\n", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkAddress" + } + }, + "numDynamicAddresses": { + "description": "Number of dynamic addresses that may be allocated for the external connection point\n", + "type": "integer" + } + } + }, + "NetworkAddress": { + "description": "A type representing network addresses", + "type": "object", + "properties": { + "subnetId": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "mac": { + "type": "string" + } + } + }, + "OperationType": { + "type": "string", + "enum": [ + "INSTANTIATE", + "SCALE", + "SCALE_TO_LEVEL", + "MODIFY_INFO", + "CHANGE_FLAVOUR", + "OPERATE", + "HEAL", + "UPGRADE", + "TERMINATE", + "OTHER" + ] + }, + "ResourceInfo": { + "required": [ + "resourceId" + ], + "type": "object", + "description": "VIM and VIM-related identification for resources. Only direct mode is supported.\n", + "properties": { + "vimId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "resourceId": { + "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n", + "type": "string" + } + } + }, + "ResourceHandle": { + "required": [ + "resourceId" + ], + "type": "object", + "description": "VIM and VIM-related identification for resources. **Nokia VNFM specific change: only direct mode is supported, so resourceProviderId is removed.**\n", + "properties": { + "vimId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "resourceId": { + "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n", + "type": "string" + }, + "resourceType": { + "description": "**Nokia extension to ETSI NFV IFA007.** Type of the resource on the VIM. Possible values are implementation dependent and not detailed in this API.\n", + "type": "string" + }, + "additionalData": { + "description": "**Nokia extension to ETSI NFV IFA007.** VIM-specific resource representation. Intended for debugging and presentational purposes. Contents of this property are VIM- and implementation specific and should not be relied upon.\n", + "type": "object", + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + }, + "metadata": { + "description": "**Nokia extension to ETSI NFV IFA007.** VNF-specific metadata related to the resource.\n", + "type": "object", + "additionalProperties": { + "type": [ + "string", + "number", + "boolean", + "array", + "object" + ] + } + } + } + }, + "ProblemDetails": { + "description": "Problem detail object based on RFC7807\n", + "type": "object", + "required": [ + "status", + "detail" + ], + "properties": { + "type": { + "description": "A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be \"about:blank\".\n", + "type": "string", + "format": "URI" + }, + "title": { + "description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type": "string" + }, + "status": { + "description": "The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type": "integer" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.\n", + "type": "string" + }, + "instance": { + "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n", + "type": "string", + "format": "URI" + } + } + }, + "VnfNotificationType": { + "description": "**OtherNotification** is provided for forward compatibility with subsequent API microversions.\n", + "type": "string", + "enum": [ + "VnfIdentifierCreationNotification", + "VnfIdentifierDeletionNotification", + "VnfLifecycleChangeNotification", + "VnfInfoAttributeValueChangeNotification", + "OtherNotification" + ] + } + } +}
\ No newline at end of file diff --git a/nokiav2/generatedapis/src/main/resources/nokia.vnfm.api.v3.lcn.subscription.json b/nokiav2/generatedapis/src/main/resources/nokia.vnfm.api.v3.lcn.subscription.json new file mode 100644 index 00000000..8c19b383 --- /dev/null +++ b/nokiav2/generatedapis/src/main/resources/nokia.vnfm.api.v3.lcn.subscription.json @@ -0,0 +1,499 @@ +{ + "swagger": "2.0", + "info": { + "version": "v3.2", + "title": "Nokia VNFM API version 3.2 WIP - VNF Lifecycle Change Notification - Subscription interface" + }, + "basePath": "/vnfm/lcn/v3", + "schemes": [ + "https" + ], + "securityDefinitions": { + "OauthPassword": { + "description": "OAuth 2.0 resource owner password credentials grant (https://tools.ietf.org/html/rfc6749#section-4.3) with bearer token type. Note: the given tokenUrl does not inherit from the basePath\n", + "type": "oauth2", + "tokenUrl": "/auth/realms/cbam/protocol/openid-connect/token", + "flow": "password", + "scopes": { + "default": "default scope" + } + }, + "OauthClient": { + "description": "OAuth 2.0 client credentials grant (https://tools.ietf.org/html/rfc6749#section-4.4) with bearer token type. Note: the given tokenUrl does not inherit from the basePath\n", + "type": "oauth2", + "tokenUrl": "/auth/realms/cbam/protocol/openid-connect/token", + "flow": "application", + "scopes": { + "default": "default scope" + } + } + }, + "security": [ + { + "OauthPassword": [ + "default" + ] + }, + { + "OauthClient": [ + "default" + ] + } + ], + "produces": [ + "application/json", + "application/problem+json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/subscriptions": { + "post": { + "description": "Creates subscription to notifications.\n", + "parameters": [ + { + "name": "subscriptionRequest", + "description": "Parameters for the subscription to be created", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CreateSubscriptionRequest" + } + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "201": { + "description": "Created subscription", + "headers": { + "Location": { + "description": "The url of the subscription", + "type": "string", + "format": "url" + }, + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "schema": { + "$ref": "#/definitions/Subscription" + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "subscriptions" + ] + }, + "get": { + "description": "Lists subscriptions", + "parameters": [ + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Subscription" + } + }, + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "subscriptions" + ] + } + }, + "/subscriptions/{subscriptionId}": { + "get": { + "description": "Gets specific subscription data", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "The identifier of the subscription", + "required": true, + "type": "string" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/Subscription" + }, + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "subscriptions" + ] + }, + "delete": { + "description": "Delete the subscription\n", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "The identifier of the subscription", + "required": true, + "type": "string" + }, + { + "enum": [ + "3.2" + ], + "name": "Nokia-VNFM-API-Version", + "required": true, + "in": "header", + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + ], + "responses": { + "204": { + "description": "Successful response", + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + } + }, + "default": { + "headers": { + "Nokia-VNFM-API-Version": { + "enum": [ + "3.2" + ], + "type": "string", + "description": "The microversion corresponding to the version of the current specification" + } + }, + "description": "Error payload", + "schema": { + "$ref": "#/definitions/ProblemDetails" + } + } + }, + "tags": [ + "subscriptions" + ] + } + } + }, + "definitions": { + "CreateSubscriptionRequest": { + "type": "object", + "required": [ + "callbackUrl" + ], + "properties": { + "filter": { + "description": "Filter settings for this subscription. Omitting this field indicates that all notifications should be sent to the subscriber.\n", + "$ref": "#/definitions/SubscriptionFilter" + }, + "callbackUrl": { + "description": "The URL to use as endpoint when sending notifications corresponding to this subscription request. **Nokia extension to ETSI NFV IFA007.**\n", + "type": "string" + }, + "authentication": { + "description": "Authentication parameters to use when sending notifications corresponding to this subscription. **Nokia extension to ETSI NFV IFA007.**\n", + "$ref": "#/definitions/SubscriptionAuthentication" + } + } + }, + "OperationType": { + "type": "string", + "enum": [ + "INSTANTIATE", + "SCALE", + "SCALE_TO_LEVEL", + "MODIFY_INFO", + "CHANGE_FLAVOUR", + "OPERATE", + "HEAL", + "UPGRADE", + "TERMINATE", + "OTHER" + ] + }, + "SubscriptionFilter": { + "description": "Filter settings for subscriptions. Multiple filter options mean that all should be satisfied (AND relation). **Options may be expanded in later API specification updates.**\n", + "type": "object", + "properties": { + "vnfdId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "vnfProductName": { + "description": "Subscribe to notifications of VNFs with the given product name\n", + "type": "string" + }, + "vnfSoftwareVersion": { + "description": "Subscribe to notifications of VNFs with the given software version (to be used in conjunction with vnfProductName)\n", + "type": "string" + }, + "vnfInstanceId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "notificationTypes": { + "description": "Only send notifications of the included types. If no types are given, all notifications will be sent.\n", + "type": "array", + "items": { + "$ref": "#/definitions/VnfNotificationType" + } + }, + "operationTypes": { + "description": "Only send notifications of the included operation types. Only valid for VnfLifecycleChangeNotification notification type.\n", + "type": "array", + "items": { + "$ref": "#/definitions/OperationType" + } + } + } + }, + "SubscriptionAuthentication": { + "description": "Authentication parameters to use when sending notifications for subscriptions. **Options may be expanded in later API specification updates.**\n", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "type of authentication. OAUTH2_PASSWD means the \"resource owner password credentials grant\" flow. OAUTH2_CLIENT means the \"client credentials grant\" flow.\n", + "type": "string", + "enum": [ + "NONE", + "BASIC", + "OAUTH2_PASSWD", + "OAUTH2_CLIENT" + ] + }, + "userName": { + "description": "The name of the user to authenticate with. Used for basic- and OAUTH2_PASSWD authentication. This corresponds to the \"resource owner\" user in case of Oauth 2.\n", + "type": "string" + }, + "password": { + "description": "The password of the user to authenticate with. Used for basic- and OAUTH2_PASSWD authentication.\n", + "type": "string", + "format": "password" + }, + "clientName": { + "description": "The client designation to be used for Oauth 2 authentication (both flows)\n", + "type": "string" + }, + "clientPassword": { + "description": "The client password to be used for Oauth 2 authentication (both flows)\n", + "type": "string" + }, + "tokenUrl": { + "description": "The endpoint where the authentication token can be obtained. Used for Oauth 2 authentication (both flows)\n", + "type": "string" + } + } + }, + "Subscription": { + "type": "object", + "required": [ + "id", + "callbackUrl" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "lcnApiVersion": { + "description": "Version of the API on which the subscription was created. This may influence the occurrence and contents and of the LCN notifications sent to the subscriber.\n", + "type": "string" + }, + "filter": { + "description": "Filter settings for this subscription.\n", + "$ref": "#/definitions/SubscriptionFilter" + }, + "callbackUrl": { + "description": "The URL to use as endpoint when sending notifications corresponding to this subscription\n", + "type": "string" + }, + "_links": { + "required": [ + "self" + ], + "type": "object", + "description": "Link relations for this object", + "properties": { + "self": { + "$ref": "#/definitions/Link" + }, + "list": { + "$ref": "#/definitions/Link" + }, + "create": { + "$ref": "#/definitions/Link" + }, + "delete": { + "$ref": "#/definitions/Link" + } + } + } + } + }, + "Link": { + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "The URL that references the target resource.\n", + "type": "string", + "format": "url" + } + } + }, + "ProblemDetails": { + "description": "Problem detail object based on RFC7807\n", + "type": "object", + "required": [ + "status", + "detail" + ], + "properties": { + "type": { + "description": "A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be \"about:blank\".\n", + "type": "string", + "format": "URI" + }, + "title": { + "description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n", + "type": "string" + }, + "status": { + "description": "The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n", + "type": "integer" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.\n", + "type": "string" + }, + "instance": { + "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n", + "type": "string", + "format": "URI" + } + } + }, + "VnfNotificationType": { + "description": "**OtherNotification** is provided for forward compatibility with subsequent API microversions.\n", + "type": "string", + "enum": [ + "VnfIdentifierCreationNotification", + "VnfIdentifierDeletionNotification", + "VnfLifecycleChangeNotification", + "VnfInfoAttributeValueChangeNotification", + "OtherNotification" + ] + } + } +}
\ No newline at end of file diff --git a/nokiav2/generatedapis/src/main/resources/patch b/nokiav2/generatedapis/src/main/resources/patch new file mode 100644 index 00000000..e19dd1a0 --- /dev/null +++ b/nokiav2/generatedapis/src/main/resources/patch @@ -0,0 +1,239 @@ +diff -Naur old/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/JSON.java new/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/JSON.java +--- old/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/JSON.java 2018-02-19 17:32:34.000000000 +0100 ++++ new/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/JSON.java 2018-02-19 17:34:43.000000000 +0100 +@@ -13,14 +13,12 @@ + + package com.nokia.cbam.lcm.v32; + +-import com.google.gson.Gson; +-import com.google.gson.GsonBuilder; +-import com.google.gson.JsonParseException; +-import com.google.gson.TypeAdapter; ++import com.google.gson.*; ++import com.google.gson.internal.Streams; + import com.google.gson.internal.bind.util.ISO8601Utils; + import com.google.gson.stream.JsonReader; ++import com.google.gson.stream.JsonToken; + import com.google.gson.stream.JsonWriter; +-import com.google.gson.JsonElement; + import io.gsonfire.GsonFireBuilder; + import io.gsonfire.TypeSelector; + import org.threeten.bp.LocalDate; +@@ -46,6 +44,8 @@ + private SqlDateTypeAdapter sqlDateTypeAdapter = new SqlDateTypeAdapter(); + private OffsetDateTimeTypeAdapter offsetDateTimeTypeAdapter = new OffsetDateTimeTypeAdapter(); + private LocalDateTypeAdapter localDateTypeAdapter = new LocalDateTypeAdapter(); ++ private VimInfoTypeAdapter vimInfoTypeAdapter = new VimInfoTypeAdapter(); ++ private LcnAdapter lcnAdapter = new LcnAdapter(); + + public static GsonBuilder createGson() { + GsonFireBuilder fireBuilder = new GsonFireBuilder() +@@ -75,6 +75,8 @@ + .registerTypeAdapter(java.sql.Date.class, sqlDateTypeAdapter) + .registerTypeAdapter(OffsetDateTime.class, offsetDateTimeTypeAdapter) + .registerTypeAdapter(LocalDate.class, localDateTypeAdapter) ++ .registerTypeAdapter(VimInfo.class, vimInfoTypeAdapter) ++ .registerTypeAdapter(AbstractVnfNotification.class, lcnAdapter) + .create(); + } + +@@ -349,6 +351,67 @@ + } + } + ++ static abstract class AbstractTypeAdapter<T> extends TypeAdapter<T>{ ++ ++ @Override ++ public void write(JsonWriter out, T value) throws IOException { ++ out.jsonValue(new Gson().toJson(value)); ++ } ++ ++ @Override ++ public T read(JsonReader in) throws IOException { ++ switch (in.peek()) { ++ case NULL: ++ in.nextNull(); ++ return null; ++ default: ++ JsonElement object = Streams.parse(in); ++ String type = object.getAsJsonObject().get(getTypeField()).getAsString(); ++ Type typeOfT = getTypeMap().get(type); ++ return new Gson().fromJson(object, typeOfT); ++ } ++ } ++ ++ abstract protected String getTypeField(); ++ abstract protected Map<String, Type> getTypeMap(); ++ ++ } ++ ++ public static class VimInfoTypeAdapter extends AbstractTypeAdapter<VimInfo> { ++ ++ @Override ++ protected String getTypeField() { ++ return "vimInfoType"; ++ } ++ ++ @Override ++ protected Map<String, Type> getTypeMap() { ++ Map<String,Type> myMap = new HashMap<String,Type>(); ++ myMap.put(VimInfo.VimInfoTypeEnum.OPENSTACK_V2_INFO.name(), OPENSTACKV2INFO.class); ++ myMap.put(VimInfo.VimInfoTypeEnum.OPENSTACK_V3_INFO.name(), OPENSTACKV3INFO.class); ++ myMap.put(VimInfo.VimInfoTypeEnum.VMWARE_VCLOUD_INFO.name(), VMWAREVCLOUDINFO.class); ++ return myMap; ++ } ++ } ++ ++ public static class LcnAdapter extends AbstractTypeAdapter<AbstractVnfNotification>{ ++ @Override ++ protected String getTypeField() { ++ return "notificationType"; ++ } ++ ++ @Override ++ protected Map<String, Type> getTypeMap() { ++ Map<String,Type> myMap = new HashMap<String,Type>(); ++ myMap.put(VnfNotificationType.VNFIDENTIFIERCREATIONNOTIFICATION.name(), VnfIdentifierCreationNotification.class); ++ myMap.put(VnfNotificationType.VNFIDENTIFIERDELETIONNOTIFICATION.name(), VnfIdentifierDeletionNotification.class); ++ myMap.put(VnfNotificationType.VNFINFOATTRIBUTEVALUECHANGENOTIFICATION.name(), VnfInfoAttributeValueChangeNotification.class); ++ myMap.put(VnfNotificationType.VNFLIFECYCLECHANGENOTIFICATION.name(), VnfLifecycleChangeNotification.class); ++ myMap.put(VnfNotificationType.OTHERNOTIFICATION.name(), OtherNotification.class); ++ return myMap; ++ } ++ } ++ + public JSON setDateFormat(DateFormat dateFormat) { + dateTypeAdapter.setFormat(dateFormat); + return this; +diff -Naur old/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/OTHERVIMINFO.java new/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/OTHERVIMINFO.java +--- old/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/OTHERVIMINFO.java 2018-02-19 17:32:33.000000000 +0100 ++++ new/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/OTHERVIMINFO.java 2018-02-19 17:34:43.000000000 +0100 +@@ -43,13 +43,13 @@ + return false; + } + OTHERVIMINFO OTHER_VIM_INFO = (OTHERVIMINFO) o; +- return && ++ return + super.equals(o); + } + + @Override + public int hashCode() { +- return Objects.hash(, super.hashCode()); ++ return Objects.hash( super.hashCode()); + } + + +diff -Naur old/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/OtherNotification.java new/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/OtherNotification.java +--- old/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/OtherNotification.java 2018-02-19 17:32:33.000000000 +0100 ++++ new/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/OtherNotification.java 2018-02-19 17:34:43.000000000 +0100 +@@ -45,13 +45,13 @@ + return false; + } + OtherNotification otherNotification = (OtherNotification) o; +- return && ++ return + super.equals(o); + } + + @Override + public int hashCode() { +- return Objects.hash(, super.hashCode()); ++ return Objects.hash( super.hashCode()); + } + + +diff -Naur old/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/VnfIdentifierCreationNotification.java new/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/VnfIdentifierCreationNotification.java +--- old/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/VnfIdentifierCreationNotification.java 2018-02-19 17:32:33.000000000 +0100 ++++ new/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/VnfIdentifierCreationNotification.java 2018-02-19 17:34:43.000000000 +0100 +@@ -45,13 +45,13 @@ + return false; + } + VnfIdentifierCreationNotification vnfIdentifierCreationNotification = (VnfIdentifierCreationNotification) o; +- return && ++ return + super.equals(o); + } + + @Override + public int hashCode() { +- return Objects.hash(, super.hashCode()); ++ return Objects.hash(super.hashCode()); + } + + +diff -Naur old/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/VnfIdentifierDeletionNotification.java new/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/VnfIdentifierDeletionNotification.java +--- old/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/VnfIdentifierDeletionNotification.java 2018-02-19 17:32:33.000000000 +0100 ++++ new/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/VnfIdentifierDeletionNotification.java 2018-02-19 17:34:43.000000000 +0100 +@@ -45,13 +45,13 @@ + return false; + } + VnfIdentifierDeletionNotification vnfIdentifierDeletionNotification = (VnfIdentifierDeletionNotification) o; +- return && ++ return + super.equals(o); + } + + @Override + public int hashCode() { +- return Objects.hash(, super.hashCode()); ++ return Objects.hash( super.hashCode()); + } + + +diff -Naur old/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/VnfProperty.java new/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/VnfProperty.java +--- old/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/VnfProperty.java 2018-02-19 17:32:33.000000000 +0100 ++++ new/cbam/src/gen/java/main/com/nokia/cbam/lcm/v32/model/VnfProperty.java 2018-02-19 17:38:08.000000000 +0100 +@@ -40,6 +40,10 @@ + @SerializedName("description") + private String description = null; + ++ @XmlElement(name = "value") ++ @SerializedName("value") ++ private Object value = null; ++ + public VnfProperty name(String name) { + this.name = name; + return this; +@@ -76,6 +80,18 @@ + this.description = description; + } + ++ /** ++ * The value of the respective property ++ * @return value ++ **/ ++ @ApiModelProperty(value = "The value of the respective property ") ++ public Object getValue() { ++ return value; ++ } ++ ++ public void setValue(Object value) { ++ this.value = value; ++ } + + @Override + public boolean equals(java.lang.Object o) { +@@ -87,12 +103,13 @@ + } + VnfProperty vnfProperty = (VnfProperty) o; + return Objects.equals(this.name, vnfProperty.name) && ++ Objects.equals(this.value, vnfProperty.value) && + Objects.equals(this.description, vnfProperty.description); + } + + @Override + public int hashCode() { +- return Objects.hash(name, description); ++ return Objects.hash(name, description, value); + } + + +@@ -102,6 +119,7 @@ + sb.append("class VnfProperty {\n"); + + sb.append(" name: ").append(toIndentedString(name)).append("\n"); ++ sb.append(" value: ").append(toIndentedString(value)).append("\n"); + sb.append(" description: ").append(toIndentedString(description)).append("\n"); + sb.append("}"); + return sb.toString(); diff --git a/nokiav2/generatedapis/src/main/resources/resource.manager.json b/nokiav2/generatedapis/src/main/resources/resource.manager.json new file mode 100644 index 00000000..6a315916 --- /dev/null +++ b/nokiav2/generatedapis/src/main/resources/resource.manager.json @@ -0,0 +1,1100 @@ +{ + "swagger": "2.0", + "info": { + "title": "Resource Management API", + "description": "Resource Management API", + "version": "1.0.0" + }, + "tags": [ + { + "name": "Resource Management services" + } + ], + "basePath": "/api/resmgr/v1", + "paths": { + "/limits": { + "get": { + "summary": "Query limits information", + "description": "Query limits information", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "vimId", + "in": "query", + "description": "vim Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully Query limits information", + "schema": { + "$ref": "#/definitions/QueryLimts" + } + }, + "401": { + "description": "Unauthorized" + }, + "404": { + "description": "Limits Not Found" + }, + "500": { + "description": "Limits failed to process the request", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/resource/grant": { + "put": { + "summary": "Grant VNF Life Cycle Operation", + "description": "Grant Resource", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "open-o", + "description": "OPEN-O Interface.", + "required": true, + "schema": { + "$ref": "#/definitions/GrantResource" + } + } + ], + "responses": { + "200": { + "description": "VNF Resource Response", + "schema": { + "$ref": "#/definitions/GrantResourceResponse" + } + }, + "401": { + "description": "Unauthorized" + }, + "404": { + "description": "VNF Resource Not Found" + }, + "500": { + "description": "VNF resource failed to process the request", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/vl": { + "post": { + "summary": "Create virtual link resource", + "description": "virtual link Resource", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "open-o", + "description": "OPEN-O Interface.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualLink" + } + } + ], + "responses": { + "202": { + "description": "Successfully Created VNF Resource", + "schema": { + "$ref": "#/definitions/VirtualLinkResponse" + } + }, + "401": { + "description": "Unauthorized" + }, + "404": { + "description": "VNF Resource Not Found" + }, + "500": { + "description": "VNF resource failed to process the request", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/vl/{id}": { + "delete": { + "summary": "Delete virtual link resource", + "description": "Delete virtual link Resource", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "VNF Resource Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully Deleted VNF Resource" + }, + "401": { + "description": "Unauthorized" + }, + "404": { + "description": "VNF Resource Not Found" + }, + "500": { + "description": "VNF resource failed to process the request", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/vnf": { + "post": { + "summary": "Create VNF instance resource", + "description": "Create VNF Resource", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "open-o", + "description": "OPEN-O Interface.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateVNFResource" + } + } + ], + "responses": { + "201": { + "description": "Successfully Created VNF Resource", + "schema": { + "$ref": "#/definitions/CreateVNFResponse" + } + }, + "401": { + "description": "Unauthorized" + }, + "404": { + "description": "VNF Resource Not Found" + }, + "500": { + "description": "VNF resource failed to process the request", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/vnfinfo": { + "post": { + "summary": "Write VNF status information", + "description": "VNF Status", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "open-o", + "description": "OPEN-O Interface.", + "required": true, + "schema": { + "$ref": "#/definitions/VNFStatusInfo" + } + } + ], + "responses": { + "201": { + "description": "Successfully write VNF status" + }, + "401": { + "description": "Unauthorized" + }, + "404": { + "description": "VNF Resource Not Found" + }, + "500": { + "description": "VNF resource failed to process the request", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/vnfdetailinfo": { + "post": { + "summary": "Write VNF detail information", + "description": "VNF detail info", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "open-o", + "description": "OPEN-O Interface", + "required": true, + "schema": { + "$ref": "#/definitions/VNFDetailInfo" + } + } + ], + "responses": { + "201": { + "description": "Successfully write VNF detail Info" + }, + "401": { + "description": "Unauthorized" + }, + "404": { + "description": "VNF Resource Not Found" + }, + "500": { + "description": "VNF resource failed to process the request", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + } + }, + "definitions": { + "QueryLimts": { + "type": "object", + "description": "Query Limits Response.", + "required": [ + "vimId", + "vimName", + "totalCPU", + "totalMemory", + "totalDisk", + "usedCPU", + "usedMemory", + "usedDisk" + ], + "properties": { + "vimId": { + "type": "string", + "description": "Identifier of vimId." + }, + "vimName": { + "type": "string", + "description": "Name." + }, + "totalCPU": { + "type": "string" + }, + "totalMemory": { + "type": "string" + }, + "totalDisk": { + "type": "string" + }, + "usedCPU": { + "type": "string" + }, + "usedMemory": { + "type": "string" + }, + "usedDisk": { + "type": "string" + } + } + }, + "VirtualLinkResponse": { + "type": "object", + "description": "Virtual Link Response.", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "string", + "description": "Identifier of VL." + }, + "Name": { + "type": "string", + "description": "Name of VL." + } + } + }, + "CreateVNFResponse": { + "type": "object", + "description": "Create VNF Response.", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "string", + "description": "UUID." + }, + "Name": { + "type": "string", + "description": "Instance Name." + } + } + }, + "VNFDetailInfo": { + "type": "object", + "description": "List of Vm to be added or deleted", + "required": [ + "vnfInstanceId", + "nsId", + "vnfmId", + "Vms" + ], + "properties": { + "vnfInstanceId": { + "type": "string", + "description": "The id of VNF instance" + }, + "nsId": { + "type": "string", + "description": "NS ID" + }, + "vnfmId": { + "type": "string", + "description": "VNFM ID" + }, + "Vms": { + "type": "array", + "items": { + "$ref": "#/definitions/Vm" + } + } + } + }, + "VNFStatusInfo": { + "type": "object", + "description": "Write VNF Status.", + "required": [ + "vnfInstanceId", + "jobId", + "nsId", + "vnfmId", + "responseDescriptor", + "status", + "progress", + "sStatusDescription", + "errorCode", + "responseId", + "responseHistoryList", + "addVm", + "delVm" + ], + "properties": { + "vnfInstanceId": { + "type": "string", + "description": "The Id of VNF Instance." + }, + "jobId": { + "type": "string", + "description": "The ID of workflow." + }, + "nsId": { + "type": "string", + "description": "NS ID." + }, + "vnfmId": { + "type": "string", + "description": "The VNFM ID." + }, + "responseDescriptor": { + "type": "string", + "description": "The name of VNFM." + }, + "status": { + "type": "string", + "description": "Status of VNF - started processing finished error." + }, + "progress": { + "type": "integer", + "description": "progress (1-100)." + }, + "sStatusDescription": { + "type": "string", + "description": "current Progress Description." + }, + "errorCode": { + "type": "integer", + "description": "Error code." + }, + "responseId": { + "type": "integer", + "description": "Message Number." + }, + "responseHistoryList": { + "type": "array", + "items": { + "$ref": "#/definitions/progressInfo" + } + }, + "addVm": { + "type": "array", + "items": { + "$ref": "#/definitions/Vm" + } + }, + "delVm": { + "type": "array", + "items": { + "$ref": "#/definitions/Vm" + } + } + } + }, + "progressInfo": { + "type": "object", + "description": "List of Vm to be added or deleted", + "required": [ + "progress", + "status", + "statusDescription", + "errorCode", + "responseId", + "responseHistoryList" + ], + "properties": { + "progress": { + "type": "integer", + "description": "progress (1 - 100)" + }, + "status": { + "type": "string", + "description": "status" + }, + "statusDescription": { + "type": "string", + "description": "status description" + }, + "errorCode": { + "type": "integer", + "description": "Error Code" + }, + "responseId": { + "type": "integer", + "description": "Id" + }, + "responseHistoryList": { + "type": "array", + "items": { + "$ref": "#/definitions/historyInfo" + } + } + } + }, + "historyInfo": { + "type": "object", + "description": "List of Vm to be added or deleted", + "required": [ + "progress", + "status", + "statusDescription", + "errorCode", + "responseId" + ], + "properties": { + "progress": { + "type": "integer", + "description": "progress (1 - 100)" + }, + "status": { + "type": "string", + "description": "status" + }, + "statusDescription": { + "type": "string", + "description": "status description" + }, + "errorCode": { + "type": "integer", + "description": "Error Code" + }, + "responseId": { + "type": "integer", + "description": "Id" + } + } + }, + "Vm": { + "type": "object", + "description": "List of Vm to be added or deleted", + "required": [ + "vmId", + "vmName", + "vmStatus" + ], + "properties": { + "vmId": { + "type": "string", + "description": "The ID of VM" + }, + "vmName": { + "type": "string", + "description": "The name of VM" + }, + "vmStatus": { + "type": "string", + "description": "The Status of VM" + } + } + }, + "CreateVNFResource": { + "type": "object", + "description": "Create VNF Resource.", + "required": [ + "vnfInstanceId", + "vnfInstanceName", + "nsId", + "nsName", + "vnfmId", + "vnfmName", + "vnfPackageName", + "vnfDescriptorName", + "vimId", + "vimName", + "vimTenant", + "jobId", + "vnfStatus", + "vnfType", + "maxVm", + "maxCpu", + "maxDisk", + "maxRam", + "maxShd", + "maxNet" + ], + "properties": { + "vnfInstanceId": { + "type": "string", + "description": "The Identifier of VNF Instance." + }, + "vnfInstanceName": { + "type": "string", + "description": "The name of VNF." + }, + "nsId": { + "type": "string", + "description": "NS ID." + }, + "nsName": { + "type": "string", + "description": "NS name." + }, + "vnfmId": { + "type": "string", + "description": "The ID of VNFM." + }, + "vnfmName": { + "type": "string", + "description": "The name of VNFM." + }, + "vnfPackageName": { + "type": "string", + "description": "The description of VNF Package." + }, + "vnfDescriptorName": { + "type": "string", + "description": "The Description of VNFD." + }, + "vimId": { + "type": "string", + "description": "Vim ID." + }, + "vimName": { + "type": "string", + "description": "The Name of VIM." + }, + "vimTenant": { + "type": "string", + "description": "The tenant of VIM." + }, + "jobId": { + "type": "string", + "description": "The ID of workflow." + }, + "vnfStatus": { + "type": "string", + "description": "The status of VNF." + }, + "vnfType": { + "type": "string", + "description": "The type of VNF." + }, + "maxVm": { + "type": "integer", + "description": "Max Vm in this VNF." + }, + "maxCpu": { + "type": "integer", + "description": "Max CPU in this VNF." + }, + "maxDisk": { + "type": "integer", + "description": "Max Disk in this VNF." + }, + "maxRam": { + "type": "integer", + "description": "Max Memory in this VNF." + }, + "maxShd": { + "type": "integer", + "description": "Max Share Disk in this VNF." + }, + "maxNet": { + "type": "integer", + "description": "Max logical Network in this VNF." + } + } + }, + "VirtualLink": { + "type": "object", + "description": "Virtual Link Resource.", + "required": [ + "name", + "backendId", + "isPublic", + "dcName", + "vimId", + "vimName", + "physicialNet", + "nsId", + "nsName", + "description", + "networkType", + "segmentation", + "mtu", + "vlanTransparent", + "routerExternal", + "resourceProviderType", + "resourceProviderId" + ], + "properties": { + "name": { + "type": "string", + "description": "Logical Network Name." + }, + "backendId": { + "type": "string", + "description": "The backend id on VIM." + }, + "isPublic": { + "type": "string", + "description": "Sharable - True or False." + }, + "dcName": { + "type": "string", + "description": "The DataCenter name." + }, + "vimId": { + "type": "string", + "description": "vim Id." + }, + "vimName": { + "type": "string", + "description": "The name of VIM." + }, + "physicialNet": { + "type": "string", + "description": "Physicial Network." + }, + "nsId": { + "type": "string", + "description": "NsId." + }, + "nsName": { + "type": "string", + "description": "The name of NS." + }, + "description": { + "type": "string", + "description": "Description." + }, + "networkType": { + "type": "string", + "description": "Network Type - gre/vlan/vxlan." + }, + "segmentation": { + "type": "string", + "description": "Segmentation Id just like vlan id." + }, + "mtu": { + "type": "string", + "description": "MTU value." + }, + "vlanTransparent": { + "type": "string", + "description": "Support vlan transparent- True/False." + }, + "routerExternal": { + "type": "string", + "description": "Support External Router - True / False." + }, + "resourceProviderType": { + "type": "string", + "description": "The location to be deployed in one of the list - VIM/DC/Zone/Host." + }, + "resourceProviderId": { + "type": "string", + "description": "The location ID to be deployed." + } + } + }, + "GrantResourceResponse": { + "type": "object", + "description": "Resource Response.", + "required": [ + "vim", + "zone", + "zoneGroup", + "addResource", + "tempResource", + "removeResource", + "updateResource", + "vimAssets", + "additionalParam" + ], + "properties": { + "vim": { + "$ref": "#/definitions/VimInfo" + }, + "zone": { + "type": "string" + }, + "zoneGroup": { + "type": "string" + }, + "addResource": { + "$ref": "#/definitions/GrantInfo" + }, + "tempResource": { + "$ref": "#/definitions/GrantInfo" + }, + "removeResource": { + "$ref": "#/definitions/GrantInfo" + }, + "updateResource": { + "$ref": "#/definitions/GrantInfo" + }, + "vimAssets": { + "type": "string" + }, + "additionalParam": { + "type": "string" + } + } + }, + "VimInfo": { + "type": "object", + "description": "Information about the VIM that manages this resource.", + "required": [ + "vimInfoId", + "vimId", + "interfaceInfo", + "accessInfo", + "interfaceEndpoint" + ], + "properties": { + "vimInfoId": { + "type": "string", + "description": "The identifier of this VimInfo instance, for the purpose of referencing it from other information elements." + }, + "vimId": { + "type": "string", + "description": "The identifier of the VIM.." + }, + "interfaceInfo": { + "$ref": "#/definitions/interfaceInfo" + }, + "accessInfo": { + "$ref": "#/definitions/accessInfo" + }, + "interfaceEndpoint": { + "type": "string", + "description": "Information about the interface endpoint. An example is a URL." + } + } + }, + "interfaceInfo": { + "type": "object", + "description": "Information about the interface to the VIM, including VIM provider type, API version, and protocol type..", + "required": [ + "vimType", + "apiVersion", + "protocolType" + ], + "properties": { + "vimType": { + "type": "string", + "description": "vim" + }, + "apiVersion": { + "type": "string", + "description": "api version" + }, + "protocolType": { + "type": "string", + "description": "Type of the protocol" + } + } + }, + "accessInfo": { + "type": "object", + "description": "Authentication credentials for accessing the VIM. Examples may include those to support different authentication schemes, e.g., OAuth, Token, etc..", + "required": [ + "tenant", + "username", + "password" + ], + "properties": { + "tenant": { + "type": "string", + "description": "Tenant Name of tenant" + }, + "username": { + "type": "string", + "description": "Username for login" + }, + "password": { + "type": "string", + "description": "Password of login user" + } + } + }, + "GrantInfo": { + "type": "object", + "description": "Grant Information.", + "required": [ + "resourceDefinitionId", + "reservationId", + "vimId", + "resourceProviderId", + "zoneId" + ], + "properties": { + "resourceDefinitionId": { + "type": "string", + "description": "Identifier of the related ResourceDefinition information from Grant Request" + }, + "reservationId": { + "type": "string", + "description": "Reservation Identifier applicable to the VNFC/VL." + }, + "vimId": { + "type": "string", + "description": "Reference to the identifier of the VimInfo information element defining the VIM under whose control this resource to be placed." + }, + "resourceProviderId": { + "type": "string", + "description": "Identifies the entity responsible for the management of the virtualized resource." + }, + "zoneId": { + "type": "string", + "description": "Reference of the identifier of the zoneInfo information element defining the resource zone in which resource to be placed." + } + } + }, + "GrantResource": { + "type": "object", + "description": "Grant Resource Request Body.", + "required": [ + "vnfInstanceId", + "addResource", + "vimId", + "additionalParam" + ], + "properties": { + "vnfInstanceId": { + "type": "string", + "description": "Identifier Instance." + }, + "vimId": { + "type": "string", + "description": "Identifier vim." + }, + "addResource": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceDefinition" + }, + "description": "Information sufficient to identify the VNF Descriptor which defines the VNF to be created." + }, + "removeResource": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceDefinition" + } + }, + "additionalParam": { + "type": "object", + "description": "additionalParam.", + "required": [ + "vnfmid" + ], + "properties": { + "vnfmid": { + "type": "string" + }, + "vimid": { + "type": "string" + }, + "tenant": { + "type": "string" + } + } + } + } + }, + "ResourceDefinition": { + "type": "object", + "description": "List of resources to be added / deleted / updated.", + "required": [ + "resourceDefinitionId", + "resourceTemplate", + "type", + "vdu" + ], + "properties": { + "resourceDefinitionId": { + "type": "string", + "description": "Identifier of this ResourceDefinition information element, unique at least within the scope of the Grant request." + }, + "resourceTemplate": { + "$ref": "#/definitions/ResourceTemplate" + }, + "type": { + "default": "compute", + "enum": [ + "compute", + "VL", + "CP", + "Storage" + ], + "description": "Currently only support tosca.nodes.nfv.VDU." + }, + "vdu": { + "type": "string", + "description": "Reference to the related Vdu applicable to this resource in the VNFD." + } + } + }, + "ResourceTemplate": { + "type": "object", + "description": "Resource templates.", + "required": [ + "VirtualComputeDescriptor", + "VirtualStorageDescriptor" + ], + "properties": { + "VirtualComputeDescriptor": { + "$ref": "#/definitions/VirtualComputeDescriptor" + }, + "VirtualStorageDescriptor": { + "$ref": "#/definitions/VirtualStorageDescriptor" + } + } + }, + "VirtualComputeDescriptor": { + "type": "object", + "description": "Reference to a resource template.", + "required": [ + "virtualCpu", + "virtualMemory" + ], + "properties": { + "virtualCpu": { + "type": "integer", + "format": "int32", + "description": "Number of virtual CPUs" + }, + "virtualMemory": { + "type": "integer", + "format": "int32", + "description": "Amount of virtual Memory" + } + } + }, + "VirtualStorageDescriptor": { + "type": "object", + "description": "Reference to a resource template.", + "required": [ + "typeOfStorage", + "sizeOfStorage", + "swImageDescriptor" + ], + "properties": { + "typeOfStorage": { + "type": "string", + "description": "Type of virtualized storage resource" + }, + "sizeOfStorage": { + "type": "integer", + "format": "int32", + "description": "Size of virtualized storage resource" + }, + "swImageDescriptor": { + "type": "string", + "description": "Software image to be loaded on the Virtual Storage" + } + } + }, + "Error": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + } + } + } + } +}
\ No newline at end of file diff --git a/nokiav2/generatedapis/src/main/resources/sdc.internal.json b/nokiav2/generatedapis/src/main/resources/sdc.internal.json new file mode 100644 index 00000000..9791daac --- /dev/null +++ b/nokiav2/generatedapis/src/main/resources/sdc.internal.json @@ -0,0 +1,9902 @@ +{ + "basePath": "/sdc2/rest", + "definitions": { + "AdditionalInfoParameterInfo": { + "properties": { + "empty": { + "type": "boolean" + }, + "key": { + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "uniqueId": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "AdditionalInformationDefinition": { + "properties": { + "creationTime": { + "format": "int64", + "type": "integer" + }, + "empty": { + "type": "boolean" + }, + "lastCreatedCounter": { + "format": "int32", + "type": "integer" + }, + "modificationTime": { + "format": "int64", + "type": "integer" + }, + "ownerId": { + "type": "string" + }, + "parameters": { + "items": { + "$ref": "#/definitions/AdditionalInfoParameterInfo" + }, + "type": "array" + }, + "parentUniqueId": { + "type": "string" + }, + "uniqueId": { + "type": "string" + } + }, + "type": "object" + }, + "ArtifactDataDefinition": { + "properties": { + "apiUrl": { + "type": "string" + }, + "artifactChecksum": { + "type": "string" + }, + "artifactCreator": { + "type": "string" + }, + "artifactDisplayName": { + "type": "string" + }, + "artifactGroupType": { + "enum": [ + "INFORMATIONAL", + "DEPLOYMENT", + "LIFE_CYCLE", + "SERVICE_API", + "TOSCA", + "OTHER" + ], + "type": "string" + }, + "artifactLabel": { + "type": "string" + }, + "artifactName": { + "type": "string" + }, + "artifactRef": { + "type": "string" + }, + "artifactRepository": { + "type": "string" + }, + "artifactType": { + "type": "string" + }, + "artifactUUID": { + "type": "string" + }, + "artifactVersion": { + "type": "string" + }, + "creationDate": { + "format": "int64", + "type": "integer" + }, + "creatorFullName": { + "type": "string" + }, + "description": { + "type": "string" + }, + "duplicated": { + "type": "boolean" + }, + "empty": { + "type": "boolean" + }, + "esId": { + "type": "string" + }, + "generated": { + "type": "boolean" + }, + "generatedFromId": { + "type": "string" + }, + "heatParameters": { + "items": { + "$ref": "#/definitions/HeatParameterDataDefinition" + }, + "type": "array" + }, + "heatParamsUpdateDate": { + "format": "int64", + "type": "integer" + }, + "lastUpdateDate": { + "format": "int64", + "type": "integer" + }, + "mandatory": { + "type": "boolean" + }, + "ownerId": { + "type": "string" + }, + "payloadUpdateDate": { + "format": "int64", + "type": "integer" + }, + "requiredArtifacts": { + "items": { + "type": "string" + }, + "type": "array" + }, + "serviceApi": { + "type": "boolean" + }, + "timeout": { + "format": "int32", + "type": "integer" + }, + "uniqueId": { + "type": "string" + }, + "updaterFullName": { + "type": "string" + }, + "userIdCreator": { + "type": "string" + }, + "userIdLastUpdater": { + "type": "string" + } + }, + "type": "object" + }, + "ArtifactDefinition": { + "properties": { + "apiUrl": { + "type": "string" + }, + "artifactChecksum": { + "type": "string" + }, + "artifactCreator": { + "type": "string" + }, + "artifactDisplayName": { + "type": "string" + }, + "artifactGroupType": { + "enum": [ + "INFORMATIONAL", + "DEPLOYMENT", + "LIFE_CYCLE", + "SERVICE_API", + "TOSCA", + "OTHER" + ], + "type": "string" + }, + "artifactLabel": { + "type": "string" + }, + "artifactName": { + "type": "string" + }, + "artifactRef": { + "type": "string" + }, + "artifactRepository": { + "type": "string" + }, + "artifactType": { + "type": "string" + }, + "artifactUUID": { + "type": "string" + }, + "artifactVersion": { + "type": "string" + }, + "creationDate": { + "format": "int64", + "type": "integer" + }, + "creatorFullName": { + "type": "string" + }, + "description": { + "type": "string" + }, + "duplicated": { + "type": "boolean" + }, + "empty": { + "type": "boolean" + }, + "esId": { + "type": "string" + }, + "generated": { + "type": "boolean" + }, + "generatedFromId": { + "type": "string" + }, + "heatParameters": { + "items": { + "$ref": "#/definitions/HeatParameterDataDefinition" + }, + "type": "array" + }, + "heatParamsUpdateDate": { + "format": "int64", + "type": "integer" + }, + "lastUpdateDate": { + "format": "int64", + "type": "integer" + }, + "listHeatParameters": { + "items": { + "$ref": "#/definitions/HeatParameterDefinition" + }, + "type": "array" + }, + "mandatory": { + "type": "boolean" + }, + "ownerId": { + "type": "string" + }, + "payloadData": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "payloadUpdateDate": { + "format": "int64", + "type": "integer" + }, + "requiredArtifacts": { + "items": { + "type": "string" + }, + "type": "array" + }, + "serviceApi": { + "type": "boolean" + }, + "timeout": { + "format": "int32", + "type": "integer" + }, + "uniqueId": { + "type": "string" + }, + "updaterFullName": { + "type": "string" + }, + "userIdCreator": { + "type": "string" + }, + "userIdLastUpdater": { + "type": "string" + } + }, + "type": "object" + }, + "CapabilityDefinition": { + "properties": { + "capabilitySources": { + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "leftOccurrences": { + "type": "string" + }, + "maxOccurrences": { + "type": "string" + }, + "minOccurrences": { + "type": "string" + }, + "name": { + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "ownerName": { + "type": "string" + }, + "parentName": { + "type": "string" + }, + "path": { + "items": { + "type": "string" + }, + "type": "array" + }, + "properties": { + "items": { + "$ref": "#/definitions/ComponentInstanceProperty" + }, + "type": "array" + }, + "source": { + "type": "string" + }, + "type": { + "type": "string" + }, + "uniqueId": { + "type": "string" + }, + "validSourceTypes": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Category": { + "properties": { + "name": { + "type": "string" + } + }, + "type": "object" + }, + "CategoryDefinition": { + "properties": { + "empty": { + "type": "boolean" + }, + "icons": { + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "type": "string" + }, + "normalizedName": { + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "subcategories": { + "items": { + "$ref": "#/definitions/SubCategoryDefinition" + }, + "type": "array" + }, + "uniqueId": { + "type": "string" + } + }, + "type": "object" + }, + "ComponentInstance": { + "properties": { + "artifacts": { + "additionalProperties": { + "$ref": "#/definitions/ArtifactDefinition" + }, + "type": "object" + }, + "attributeValueCounter": { + "format": "int32", + "type": "integer" + }, + "capabilities": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/CapabilityDefinition" + }, + "type": "array" + }, + "type": "object" + }, + "componentName": { + "type": "string" + }, + "componentUid": { + "type": "string" + }, + "componentVersion": { + "type": "string" + }, + "creationTime": { + "format": "int64", + "type": "integer" + }, + "customizationUUID": { + "type": "string" + }, + "deploymentArtifacts": { + "additionalProperties": { + "$ref": "#/definitions/ArtifactDefinition" + }, + "type": "object" + }, + "description": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "groupInstances": { + "items": { + "$ref": "#/definitions/GroupInstance" + }, + "type": "array" + }, + "icon": { + "type": "string" + }, + "inputValueCounter": { + "format": "int32", + "type": "integer" + }, + "invariantName": { + "type": "string" + }, + "modificationTime": { + "format": "int64", + "type": "integer" + }, + "name": { + "type": "string" + }, + "normalizedName": { + "type": "string" + }, + "originType": { + "enum": [ + "PRODUCT", + "SERVICE", + "VF", + "VFC", + "CP", + "VL", + "VFCMT", + "CVFC", + "PNF" + ], + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "posX": { + "type": "string" + }, + "posY": { + "type": "string" + }, + "propertyValueCounter": { + "format": "int32", + "type": "integer" + }, + "requirements": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/RequirementDefinition" + }, + "type": "array" + }, + "type": "object" + }, + "toscaComponentName": { + "type": "string" + }, + "uniqueId": { + "type": "string" + } + }, + "type": "object" + }, + "ComponentInstanceInput": { + "properties": { + "componentInstanceId": { + "type": "string" + }, + "componentInstanceName": { + "type": "string" + }, + "constraints": { + "items": { + "$ref": "#/definitions/PropertyConstraint" + }, + "type": "array" + }, + "defaultValue": { + "type": "string" + }, + "definition": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "getInputValues": { + "items": { + "$ref": "#/definitions/GetInputValueDataDefinition" + }, + "type": "array" + }, + "hidden": { + "type": "boolean" + }, + "immutable": { + "type": "boolean" + }, + "inputId": { + "type": "string" + }, + "inputPath": { + "type": "string" + }, + "inputs": { + "items": { + "$ref": "#/definitions/ComponentInstanceInput" + }, + "type": "array" + }, + "instanceUniqueId": { + "type": "string" + }, + "label": { + "type": "string" + }, + "name": { + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "parentUniqueId": { + "type": "string" + }, + "password": { + "type": "boolean" + }, + "path": { + "items": { + "type": "string" + }, + "type": "array" + }, + "properties": { + "items": { + "$ref": "#/definitions/ComponentInstanceProperty" + }, + "type": "array" + }, + "propertyId": { + "type": "string" + }, + "required": { + "type": "boolean" + }, + "rules": { + "items": { + "$ref": "#/definitions/PropertyRule" + }, + "type": "array" + }, + "schema": { + "$ref": "#/definitions/SchemaDefinition" + }, + "status": { + "type": "string" + }, + "type": { + "type": "string" + }, + "uniqueId": { + "type": "string" + }, + "value": { + "type": "string" + }, + "valueUniqueUid": { + "type": "string" + } + }, + "type": "object" + }, + "ComponentInstanceProperty": { + "properties": { + "componentInstanceId": { + "type": "string" + }, + "componentInstanceName": { + "type": "string" + }, + "constraints": { + "items": { + "$ref": "#/definitions/PropertyConstraint" + }, + "type": "array" + }, + "defaultValue": { + "type": "string" + }, + "definition": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "getInputValues": { + "items": { + "$ref": "#/definitions/GetInputValueDataDefinition" + }, + "type": "array" + }, + "hidden": { + "type": "boolean" + }, + "immutable": { + "type": "boolean" + }, + "inputId": { + "type": "string" + }, + "inputPath": { + "type": "string" + }, + "instanceUniqueId": { + "type": "string" + }, + "label": { + "type": "string" + }, + "name": { + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "parentUniqueId": { + "type": "string" + }, + "password": { + "type": "boolean" + }, + "path": { + "items": { + "type": "string" + }, + "type": "array" + }, + "propertyId": { + "type": "string" + }, + "required": { + "type": "boolean" + }, + "rules": { + "items": { + "$ref": "#/definitions/PropertyRule" + }, + "type": "array" + }, + "schema": { + "$ref": "#/definitions/SchemaDefinition" + }, + "status": { + "type": "string" + }, + "type": { + "type": "string" + }, + "uniqueId": { + "type": "string" + }, + "value": { + "type": "string" + }, + "valueUniqueUid": { + "type": "string" + } + }, + "type": "object" + }, + "ComponentMetadataDataDefinition": { + "properties": { + "allVersions": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "componentType": { + "enum": [ + "RESOURCE", + "SERVICE", + "RESOURCE_INSTANCE", + "PRODUCT", + "SERVICE_INSTANCE" + ], + "type": "string" + }, + "conformanceLevel": { + "type": "string" + }, + "contactId": { + "type": "string" + }, + "creationDate": { + "format": "int64", + "type": "integer" + }, + "creatorFullName": { + "type": "string" + }, + "creatorUserId": { + "type": "string" + }, + "csarUUID": { + "type": "string" + }, + "csarVersion": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "highestVersion": { + "type": "boolean" + }, + "icon": { + "type": "string" + }, + "importedToscaChecksum": { + "type": "string" + }, + "invariantUUID": { + "type": "string" + }, + "isDeleted": { + "type": "boolean" + }, + "isHighestVersion": { + "type": "boolean" + }, + "lastUpdateDate": { + "format": "int64", + "type": "integer" + }, + "lastUpdaterFullName": { + "type": "string" + }, + "lastUpdaterUserId": { + "type": "string" + }, + "lifecycleState": { + "type": "string" + }, + "name": { + "type": "string" + }, + "normalizedName": { + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "projectCode": { + "type": "string" + }, + "state": { + "type": "string" + }, + "systemName": { + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "uniqueId": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "type": "object" + }, + "ComponentMetadataDefinition": { + "properties": { + "metadataDataDefinition": { + "$ref": "#/definitions/ComponentMetadataDataDefinition" + } + }, + "type": "object" + }, + "ConsumerDefinition": { + "properties": { + "consumerDetailsLastupdatedtime": { + "format": "int64", + "type": "integer" + }, + "consumerLastAuthenticationTime": { + "format": "int64", + "type": "integer" + }, + "consumerName": { + "type": "string" + }, + "consumerPassword": { + "type": "string" + }, + "consumerSalt": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "lastModfierAtuid": { + "type": "string" + }, + "ownerId": { + "type": "string" + } + }, + "type": "object" + }, + "DistributionStatusInfo": { + "properties": { + "errorReason": { + "type": "string" + }, + "omfComponentID": { + "type": "string" + }, + "status": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "type": "object" + }, + "DistributionStatusListResponse": { + "properties": { + "distributionStatusList": { + "items": { + "$ref": "#/definitions/DistributionStatusInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetInputValueDataDefinition": { + "properties": { + "empty": { + "type": "boolean" + }, + "getInputIndex": { + "$ref": "#/definitions/GetInputValueDataDefinition" + }, + "indexValue": { + "format": "int32", + "type": "integer" + }, + "inputId": { + "type": "string" + }, + "inputName": { + "type": "string" + }, + "list": { + "type": "boolean" + }, + "ownerId": { + "type": "string" + }, + "propName": { + "type": "string" + } + }, + "type": "object" + }, + "GroupDefinition": { + "properties": { + "artifacts": { + "items": { + "type": "string" + }, + "type": "array" + }, + "artifactsUuid": { + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "groupUUID": { + "type": "string" + }, + "invariantUUID": { + "type": "string" + }, + "members": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "name": { + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "properties": { + "items": { + "$ref": "#/definitions/PropertyDataDefinition" + }, + "type": "array" + }, + "propertyValueCounter": { + "format": "int32", + "type": "integer" + }, + "type": { + "type": "string" + }, + "typeUid": { + "type": "string" + }, + "uniqueId": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "type": "object" + }, + "GroupInstance": { + "properties": { + "artifacts": { + "items": { + "type": "string" + }, + "type": "array" + }, + "artifactsUuid": { + "items": { + "type": "string" + }, + "type": "array" + }, + "creationTime": { + "format": "int64", + "type": "integer" + }, + "customizationUUID": { + "type": "string" + }, + "description": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "groupInstanceArtifacts": { + "items": { + "type": "string" + }, + "type": "array" + }, + "groupInstanceArtifactsUuid": { + "items": { + "type": "string" + }, + "type": "array" + }, + "groupName": { + "type": "string" + }, + "groupUUID": { + "type": "string" + }, + "groupUid": { + "type": "string" + }, + "invariantUUID": { + "type": "string" + }, + "modificationTime": { + "format": "int64", + "type": "integer" + }, + "name": { + "type": "string" + }, + "normalizedName": { + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "posX": { + "type": "string" + }, + "posY": { + "type": "string" + }, + "properties": { + "items": { + "$ref": "#/definitions/PropertyDataDefinition" + }, + "type": "array" + }, + "propertyValueCounter": { + "format": "int32", + "type": "integer" + }, + "type": { + "type": "string" + }, + "uniqueId": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "type": "object" + }, + "GroupingDefinition": { + "properties": { + "empty": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "normalizedName": { + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "uniqueId": { + "type": "string" + } + }, + "type": "object" + }, + "HeatParameterDataDefinition": { + "properties": { + "currentValue": { + "type": "string" + }, + "defaultValue": { + "type": "string" + }, + "description": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "type": { + "type": "string" + }, + "uniqueId": { + "type": "string" + } + }, + "type": "object" + }, + "HeatParameterDefinition": { + "properties": { + "currentValue": { + "type": "string" + }, + "defaultValue": { + "type": "string" + }, + "description": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "type": { + "type": "string" + }, + "uniqueId": { + "type": "string" + } + }, + "type": "object" + }, + "InputDefinition": { + "properties": { + "constraints": { + "items": { + "$ref": "#/definitions/PropertyConstraint" + }, + "type": "array" + }, + "defaultValue": { + "type": "string" + }, + "definition": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "getInputValues": { + "items": { + "$ref": "#/definitions/GetInputValueDataDefinition" + }, + "type": "array" + }, + "hidden": { + "type": "boolean" + }, + "immutable": { + "type": "boolean" + }, + "inputId": { + "type": "string" + }, + "inputPath": { + "type": "string" + }, + "inputs": { + "items": { + "$ref": "#/definitions/ComponentInstanceInput" + }, + "type": "array" + }, + "instanceUniqueId": { + "type": "string" + }, + "label": { + "type": "string" + }, + "name": { + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "parentUniqueId": { + "type": "string" + }, + "password": { + "type": "boolean" + }, + "properties": { + "items": { + "$ref": "#/definitions/ComponentInstanceProperty" + }, + "type": "array" + }, + "propertyId": { + "type": "string" + }, + "required": { + "type": "boolean" + }, + "schema": { + "$ref": "#/definitions/SchemaDefinition" + }, + "status": { + "type": "string" + }, + "type": { + "type": "string" + }, + "uniqueId": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "InterfaceDefinition": { + "properties": { + "creationDate": { + "format": "int64", + "type": "integer" + }, + "definition": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "lastUpdateDate": { + "format": "int64", + "type": "integer" + }, + "operations": { + "additionalProperties": { + "$ref": "#/definitions/OperationDataDefinition" + }, + "type": "object" + }, + "operationsMap": { + "additionalProperties": { + "$ref": "#/definitions/Operation" + }, + "type": "object" + }, + "ownerId": { + "type": "string" + }, + "type": { + "type": "string" + }, + "uniqueId": { + "type": "string" + } + }, + "type": "object" + }, + "LifecycleChangeInfoWithAction": { + "properties": { + "action": { + "enum": [ + "CREATE_FROM_CSAR", + "UPDATE_FROM_EXTERNAL_API" + ], + "type": "string" + }, + "userRemarks": { + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "properties": { + "creationDate": { + "format": "int64", + "type": "integer" + }, + "definition": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "implementation": { + "$ref": "#/definitions/ArtifactDataDefinition" + }, + "implementationArtifact": { + "$ref": "#/definitions/ArtifactDefinition" + }, + "inputs": { + "additionalProperties": { + "$ref": "#/definitions/PropertyDataDefinition" + }, + "type": "object" + }, + "lastUpdateDate": { + "format": "int64", + "type": "integer" + }, + "ownerId": { + "type": "string" + }, + "uniqueId": { + "type": "string" + } + }, + "type": "object" + }, + "OperationDataDefinition": { + "properties": { + "creationDate": { + "format": "int64", + "type": "integer" + }, + "description": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "implementation": { + "$ref": "#/definitions/ArtifactDataDefinition" + }, + "inputs": { + "additionalProperties": { + "$ref": "#/definitions/PropertyDataDefinition" + }, + "type": "object" + }, + "lastUpdateDate": { + "format": "int64", + "type": "integer" + }, + "ownerId": { + "type": "string" + }, + "uniqueId": { + "type": "string" + } + }, + "type": "object" + }, + "Product": { + "properties": { + "additionalInformation": { + "items": { + "$ref": "#/definitions/AdditionalInformationDefinition" + }, + "type": "array" + }, + "allArtifacts": { + "additionalProperties": { + "$ref": "#/definitions/ArtifactDefinition" + }, + "type": "object" + }, + "allVersions": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "artifacts": { + "additionalProperties": { + "$ref": "#/definitions/ArtifactDefinition" + }, + "type": "object" + }, + "capabilities": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/CapabilityDefinition" + }, + "type": "array" + }, + "type": "object" + }, + "categories": { + "items": { + "$ref": "#/definitions/CategoryDefinition" + }, + "type": "array" + }, + "componentInstances": { + "items": { + "$ref": "#/definitions/ComponentInstance" + }, + "type": "array" + }, + "componentInstancesAttributes": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/ComponentInstanceProperty" + }, + "type": "array" + }, + "type": "object" + }, + "componentInstancesInputs": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/ComponentInstanceInput" + }, + "type": "array" + }, + "type": "object" + }, + "componentInstancesProperties": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/ComponentInstanceProperty" + }, + "type": "array" + }, + "type": "object" + }, + "componentInstancesRelations": { + "items": { + "$ref": "#/definitions/RequirementCapabilityRelDef" + }, + "type": "array" + }, + "componentMetadataDefinition": { + "$ref": "#/definitions/ComponentMetadataDefinition" + }, + "componentType": { + "enum": [ + "RESOURCE", + "SERVICE", + "RESOURCE_INSTANCE", + "PRODUCT", + "SERVICE_INSTANCE" + ], + "type": "string" + }, + "conformanceLevel": { + "type": "string" + }, + "contactId": { + "type": "string" + }, + "contacts": { + "items": { + "type": "string" + }, + "type": "array" + }, + "creationDate": { + "format": "int64", + "type": "integer" + }, + "creatorFullName": { + "type": "string" + }, + "creatorUserId": { + "type": "string" + }, + "csarUUID": { + "type": "string" + }, + "csarVersion": { + "type": "string" + }, + "deploymentArtifacts": { + "additionalProperties": { + "$ref": "#/definitions/ArtifactDefinition" + }, + "type": "object" + }, + "derivedFromGenericType": { + "type": "string" + }, + "derivedFromGenericVersion": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fullName": { + "type": "string" + }, + "groups": { + "items": { + "$ref": "#/definitions/GroupDefinition" + }, + "type": "array" + }, + "highestVersion": { + "type": "boolean" + }, + "icon": { + "type": "string" + }, + "importedToscaChecksum": { + "type": "string" + }, + "inputs": { + "items": { + "$ref": "#/definitions/InputDefinition" + }, + "type": "array" + }, + "invariantUUID": { + "type": "string" + }, + "isActive": { + "type": "boolean" + }, + "isDeleted": { + "type": "boolean" + }, + "lastUpdateDate": { + "format": "int64", + "type": "integer" + }, + "lastUpdaterFullName": { + "type": "string" + }, + "lastUpdaterUserId": { + "type": "string" + }, + "lifecycleState": { + "enum": [ + "READY_FOR_CERTIFICATION", + "CERTIFICATION_IN_PROGRESS", + "CERTIFIED", + "NOT_CERTIFIED_CHECKIN", + "NOT_CERTIFIED_CHECKOUT" + ], + "type": "string" + }, + "name": { + "type": "string" + }, + "normalizedName": { + "type": "string" + }, + "projectCode": { + "type": "string" + }, + "requirements": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/RequirementDefinition" + }, + "type": "array" + }, + "type": "object" + }, + "systemName": { + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "toscaArtifacts": { + "additionalProperties": { + "$ref": "#/definitions/ArtifactDefinition" + }, + "type": "object" + }, + "toscaType": { + "type": "string" + }, + "uniqueId": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "type": "object" + }, + "PropertyConstraint": { + "type": "object" + }, + "PropertyDataDefinition": { + "properties": { + "defaultValue": { + "type": "string" + }, + "definition": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "getInputValues": { + "items": { + "$ref": "#/definitions/GetInputValueDataDefinition" + }, + "type": "array" + }, + "hidden": { + "type": "boolean" + }, + "immutable": { + "type": "boolean" + }, + "inputId": { + "type": "string" + }, + "inputPath": { + "type": "string" + }, + "instanceUniqueId": { + "type": "string" + }, + "label": { + "type": "string" + }, + "name": { + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "parentUniqueId": { + "type": "string" + }, + "password": { + "type": "boolean" + }, + "propertyId": { + "type": "string" + }, + "required": { + "type": "boolean" + }, + "schema": { + "$ref": "#/definitions/SchemaDefinition" + }, + "status": { + "type": "string" + }, + "type": { + "type": "string" + }, + "uniqueId": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "PropertyDefinition": { + "properties": { + "constraints": { + "items": { + "$ref": "#/definitions/PropertyConstraint" + }, + "type": "array" + }, + "defaultValue": { + "type": "string" + }, + "definition": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "getInputValues": { + "items": { + "$ref": "#/definitions/GetInputValueDataDefinition" + }, + "type": "array" + }, + "hidden": { + "type": "boolean" + }, + "immutable": { + "type": "boolean" + }, + "inputId": { + "type": "string" + }, + "inputPath": { + "type": "string" + }, + "instanceUniqueId": { + "type": "string" + }, + "label": { + "type": "string" + }, + "name": { + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "parentUniqueId": { + "type": "string" + }, + "password": { + "type": "boolean" + }, + "propertyId": { + "type": "string" + }, + "required": { + "type": "boolean" + }, + "schema": { + "$ref": "#/definitions/SchemaDefinition" + }, + "status": { + "type": "string" + }, + "type": { + "type": "string" + }, + "uniqueId": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "PropertyRule": { + "properties": { + "empty": { + "type": "boolean" + }, + "firstToken": { + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "rule": { + "items": { + "type": "string" + }, + "type": "array" + }, + "ruleSize": { + "format": "int32", + "type": "integer" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "RelationshipImpl": { + "properties": { + "type": { + "type": "string" + } + }, + "type": "object" + }, + "RequirementAndRelationshipPair": { + "properties": { + "capability": { + "type": "string" + }, + "capabilityOwnerId": { + "type": "string" + }, + "capabilityUid": { + "type": "string" + }, + "id": { + "type": "string" + }, + "relationship": { + "$ref": "#/definitions/RelationshipImpl" + }, + "requirement": { + "type": "string" + }, + "requirementOwnerId": { + "type": "string" + }, + "requirementUid": { + "type": "string" + } + }, + "type": "object" + }, + "RequirementCapabilityRelDef": { + "properties": { + "fromNode": { + "type": "string" + }, + "relationships": { + "items": { + "$ref": "#/definitions/RequirementAndRelationshipPair" + }, + "type": "array" + }, + "toNode": { + "type": "string" + }, + "uid": { + "type": "string" + } + }, + "type": "object" + }, + "RequirementDefinition": { + "properties": { + "capability": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "leftOccurrences": { + "type": "string" + }, + "maxOccurrences": { + "type": "string" + }, + "minOccurrences": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node": { + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "ownerName": { + "type": "string" + }, + "parentName": { + "type": "string" + }, + "path": { + "items": { + "type": "string" + }, + "type": "array" + }, + "relationship": { + "type": "string" + }, + "source": { + "type": "string" + }, + "uniqueId": { + "type": "string" + } + }, + "type": "object" + }, + "Resource": { + "properties": { + "abstract": { + "type": "boolean" + }, + "additionalInformation": { + "items": { + "$ref": "#/definitions/AdditionalInformationDefinition" + }, + "type": "array" + }, + "allArtifacts": { + "additionalProperties": { + "$ref": "#/definitions/ArtifactDefinition" + }, + "type": "object" + }, + "allVersions": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "artifacts": { + "additionalProperties": { + "$ref": "#/definitions/ArtifactDefinition" + }, + "type": "object" + }, + "attributes": { + "items": { + "$ref": "#/definitions/PropertyDefinition" + }, + "type": "array" + }, + "capabilities": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/CapabilityDefinition" + }, + "type": "array" + }, + "type": "object" + }, + "categories": { + "items": { + "$ref": "#/definitions/CategoryDefinition" + }, + "type": "array" + }, + "componentInstances": { + "items": { + "$ref": "#/definitions/ComponentInstance" + }, + "type": "array" + }, + "componentInstancesAttributes": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/ComponentInstanceProperty" + }, + "type": "array" + }, + "type": "object" + }, + "componentInstancesInputs": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/ComponentInstanceInput" + }, + "type": "array" + }, + "type": "object" + }, + "componentInstancesProperties": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/ComponentInstanceProperty" + }, + "type": "array" + }, + "type": "object" + }, + "componentInstancesRelations": { + "items": { + "$ref": "#/definitions/RequirementCapabilityRelDef" + }, + "type": "array" + }, + "componentMetadataDefinition": { + "$ref": "#/definitions/ComponentMetadataDefinition" + }, + "componentType": { + "enum": [ + "RESOURCE", + "SERVICE", + "RESOURCE_INSTANCE", + "PRODUCT", + "SERVICE_INSTANCE" + ], + "type": "string" + }, + "conformanceLevel": { + "type": "string" + }, + "contactId": { + "type": "string" + }, + "cost": { + "type": "string" + }, + "creationDate": { + "format": "int64", + "type": "integer" + }, + "creatorFullName": { + "type": "string" + }, + "creatorUserId": { + "type": "string" + }, + "csarUUID": { + "type": "string" + }, + "csarVersion": { + "type": "string" + }, + "defaultCapabilities": { + "items": { + "type": "string" + }, + "type": "array" + }, + "deploymentArtifacts": { + "additionalProperties": { + "$ref": "#/definitions/ArtifactDefinition" + }, + "type": "object" + }, + "derivedFrom": { + "items": { + "type": "string" + }, + "type": "array" + }, + "derivedFromGenericType": { + "type": "string" + }, + "derivedFromGenericVersion": { + "type": "string" + }, + "derivedList": { + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "type": "string" + }, + "groups": { + "items": { + "$ref": "#/definitions/GroupDefinition" + }, + "type": "array" + }, + "highestVersion": { + "type": "boolean" + }, + "icon": { + "type": "string" + }, + "importedToscaChecksum": { + "type": "string" + }, + "inputs": { + "items": { + "$ref": "#/definitions/InputDefinition" + }, + "type": "array" + }, + "interfaces": { + "additionalProperties": { + "$ref": "#/definitions/InterfaceDefinition" + }, + "type": "object" + }, + "invariantUUID": { + "type": "string" + }, + "isDeleted": { + "type": "boolean" + }, + "lastUpdateDate": { + "format": "int64", + "type": "integer" + }, + "lastUpdaterFullName": { + "type": "string" + }, + "lastUpdaterUserId": { + "type": "string" + }, + "licenseType": { + "type": "string" + }, + "lifecycleState": { + "enum": [ + "READY_FOR_CERTIFICATION", + "CERTIFICATION_IN_PROGRESS", + "CERTIFIED", + "NOT_CERTIFIED_CHECKIN", + "NOT_CERTIFIED_CHECKOUT" + ], + "type": "string" + }, + "name": { + "type": "string" + }, + "normalizedName": { + "type": "string" + }, + "projectCode": { + "type": "string" + }, + "properties": { + "items": { + "$ref": "#/definitions/PropertyDefinition" + }, + "type": "array" + }, + "requirements": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/RequirementDefinition" + }, + "type": "array" + }, + "type": "object" + }, + "resourceType": { + "enum": [ + "VFC", + "VF", + "CP", + "PNF", + "CVFC", + "VL", + "VFCMT", + "ABSTRACT" + ], + "type": "string" + }, + "resourceVendorModelNumber": { + "type": "string" + }, + "systemName": { + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "toscaArtifacts": { + "additionalProperties": { + "$ref": "#/definitions/ArtifactDefinition" + }, + "type": "object" + }, + "toscaResourceName": { + "type": "string" + }, + "toscaType": { + "type": "string" + }, + "uniqueId": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "vendorName": { + "type": "string" + }, + "vendorRelease": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "type": "object" + }, + "SchemaDefinition": { + "properties": { + "constraints": { + "items": { + "type": "string" + }, + "type": "array" + }, + "derivedFrom": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "ownerId": { + "type": "string" + }, + "properties": { + "additionalProperties": { + "$ref": "#/definitions/PropertyDataDefinition" + }, + "type": "object" + }, + "property": { + "$ref": "#/definitions/PropertyDataDefinition" + } + }, + "type": "object" + }, + "Service": { + "properties": { + "additionalInformation": { + "items": { + "$ref": "#/definitions/AdditionalInformationDefinition" + }, + "type": "array" + }, + "allArtifacts": { + "additionalProperties": { + "$ref": "#/definitions/ArtifactDefinition" + }, + "type": "object" + }, + "allVersions": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "artifacts": { + "additionalProperties": { + "$ref": "#/definitions/ArtifactDefinition" + }, + "type": "object" + }, + "capabilities": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/CapabilityDefinition" + }, + "type": "array" + }, + "type": "object" + }, + "categories": { + "items": { + "$ref": "#/definitions/CategoryDefinition" + }, + "type": "array" + }, + "componentInstances": { + "items": { + "$ref": "#/definitions/ComponentInstance" + }, + "type": "array" + }, + "componentInstancesAttributes": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/ComponentInstanceProperty" + }, + "type": "array" + }, + "type": "object" + }, + "componentInstancesInputs": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/ComponentInstanceInput" + }, + "type": "array" + }, + "type": "object" + }, + "componentInstancesProperties": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/ComponentInstanceProperty" + }, + "type": "array" + }, + "type": "object" + }, + "componentInstancesRelations": { + "items": { + "$ref": "#/definitions/RequirementCapabilityRelDef" + }, + "type": "array" + }, + "componentMetadataDefinition": { + "$ref": "#/definitions/ComponentMetadataDefinition" + }, + "componentType": { + "enum": [ + "RESOURCE", + "SERVICE", + "RESOURCE_INSTANCE", + "PRODUCT", + "SERVICE_INSTANCE" + ], + "type": "string" + }, + "conformanceLevel": { + "type": "string" + }, + "contactId": { + "type": "string" + }, + "creationDate": { + "format": "int64", + "type": "integer" + }, + "creatorFullName": { + "type": "string" + }, + "creatorUserId": { + "type": "string" + }, + "csarUUID": { + "type": "string" + }, + "csarVersion": { + "type": "string" + }, + "deploymentArtifacts": { + "additionalProperties": { + "$ref": "#/definitions/ArtifactDefinition" + }, + "type": "object" + }, + "derivedFromGenericType": { + "type": "string" + }, + "derivedFromGenericVersion": { + "type": "string" + }, + "description": { + "type": "string" + }, + "distributionStatus": { + "enum": [ + "DISTRIBUTION_NOT_APPROVED", + "DISTRIBUTION_APPROVED", + "DISTRIBUTED", + "DISTRIBUTION_REJECTED" + ], + "type": "string" + }, + "ecompGeneratedNaming": { + "type": "boolean" + }, + "groups": { + "items": { + "$ref": "#/definitions/GroupDefinition" + }, + "type": "array" + }, + "highestVersion": { + "type": "boolean" + }, + "icon": { + "type": "string" + }, + "importedToscaChecksum": { + "type": "string" + }, + "inputs": { + "items": { + "$ref": "#/definitions/InputDefinition" + }, + "type": "array" + }, + "invariantUUID": { + "type": "string" + }, + "isDeleted": { + "type": "boolean" + }, + "lastUpdateDate": { + "format": "int64", + "type": "integer" + }, + "lastUpdaterFullName": { + "type": "string" + }, + "lastUpdaterUserId": { + "type": "string" + }, + "lifecycleState": { + "enum": [ + "READY_FOR_CERTIFICATION", + "CERTIFICATION_IN_PROGRESS", + "CERTIFIED", + "NOT_CERTIFIED_CHECKIN", + "NOT_CERTIFIED_CHECKOUT" + ], + "type": "string" + }, + "name": { + "type": "string" + }, + "namingPolicy": { + "type": "string" + }, + "normalizedName": { + "type": "string" + }, + "projectCode": { + "type": "string" + }, + "requirements": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/RequirementDefinition" + }, + "type": "array" + }, + "type": "object" + }, + "serviceApiArtifacts": { + "additionalProperties": { + "$ref": "#/definitions/ArtifactDefinition" + }, + "type": "object" + }, + "serviceRole": { + "type": "string" + }, + "serviceType": { + "type": "string" + }, + "systemName": { + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "toscaArtifacts": { + "additionalProperties": { + "$ref": "#/definitions/ArtifactDefinition" + }, + "type": "object" + }, + "toscaType": { + "type": "string" + }, + "uniqueId": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "type": "object" + }, + "SubCategoryDefinition": { + "properties": { + "empty": { + "type": "boolean" + }, + "groupings": { + "items": { + "$ref": "#/definitions/GroupingDefinition" + }, + "type": "array" + }, + "icons": { + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "type": "string" + }, + "normalizedName": { + "type": "string" + }, + "ownerId": { + "type": "string" + }, + "uniqueId": { + "type": "string" + } + }, + "type": "object" + }, + "User": { + "properties": { + "email": { + "type": "string" + }, + "firstName": { + "type": "string" + }, + "fullName": { + "type": "string" + }, + "lastLoginTime": { + "format": "int64", + "type": "integer" + }, + "lastName": { + "type": "string" + }, + "role": { + "type": "string" + }, + "status": { + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + }, + "userId": { + "type": "string" + } + }, + "type": "object" + } + }, + "info": { + "title": "Internal API's", + "version": "1.0.0" + }, + "paths": { + "/healthCheck": { + "get": { + "consumes": [ + "application/json" + ], + "description": "return BE health check", + "operationId": "getHealthCheck", + "parameters": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Titan, ES and BE are all up" + }, + "500": { + "description": "One or more BE components (Titan, ES, BE) are down" + } + }, + "summary": "return aggregate BE health check of Titan, ES and BE", + "tags": [ + "BE Monitoring" + ] + } + }, + "/monitoring": { + "post": { + "consumes": [ + "application/json" + ], + "operationId": "processMonitoringMetrics", + "parameters": [ + { + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "default": { + "description": "successful operation" + } + }, + "tags": [ + "BE Monitoring" + ] + } + }, + "/v1/artifactTypes": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Retrieve all artifactTypes", + "operationId": "getArtifactTypes", + "parameters": [ + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns artifactTypes Ok" + }, + "404": { + "description": "No artifactTypes were found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Retrieve all artifactTypes", + "tags": [ + "Element Servlet" + ] + } + }, + "/v1/catalog/audit-records/{componentType}/{componentUniqueId}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "get audit records for a service or a resource", + "operationId": "getComponentAuditRecords", + "parameters": [ + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentUniqueId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Service found" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "get component audit records", + "tags": [ + "Service Catalog" + ] + } + }, + "/v1/catalog/dataTypes": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns data types", + "operationId": "getAllDataTypesServlet", + "parameters": [ + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "datatypes" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Data types not found" + } + }, + "summary": "Get data types", + "tags": [ + "Types Fetch Servlet" + ] + } + }, + "/v1/catalog/products": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns created product", + "operationId": "createProduct", + "parameters": [ + { + "description": "Product object to be created", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "USER_ID of product strategist user", + "in": "header", + "name": "USER_ID", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/Product" + } + }, + "201": { + "description": "Product created" + }, + "400": { + "description": "Invalid/missing content" + }, + "403": { + "description": "Restricted operation / Empty USER_ID header" + }, + "409": { + "description": "Product already exists / User not found / Wrong user role" + } + }, + "summary": "Create product", + "tags": [ + "Product Catalog" + ] + } + }, + "/v1/catalog/products/productName/{productName}/productVersion/{productVersion}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns product according to name and version", + "operationId": "getServiceByNameAndVersion", + "parameters": [ + { + "in": "path", + "name": "productName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "productVersion", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Product found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Product not found" + } + }, + "summary": "Retrieve Service", + "tags": [ + "Product Catalog" + ] + } + }, + "/v1/catalog/products/validate-name/{productName}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "checks if the chosen product name is available ", + "operationId": "validateServiceName", + "parameters": [ + { + "in": "path", + "name": "productName", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Service found" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "validate product name", + "tags": [ + "Product Catalog" + ] + } + }, + "/v1/catalog/products/{productId}": { + "delete": { + "operationId": "deleteProduct", + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "type": "string" + } + ], + "responses": { + "default": { + "description": "successful operation" + } + }, + "tags": [ + "Product Catalog" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns product according to productId", + "operationId": "getProductById", + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Product found" + }, + "403": { + "description": "Missing information" + }, + "404": { + "description": "Product not found" + }, + "409": { + "description": "Restricted operation" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Retrieve product", + "tags": [ + "Product Catalog" + ] + } + }, + "/v1/catalog/products/{productId}/metadata": { + "put": { + "consumes": [ + "application/json" + ], + "description": "Returns updated product", + "operationId": "updateProductMetadata", + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "type": "string" + }, + { + "description": "Product object to be Updated", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Product Updated" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update Product Metadata", + "tags": [ + "Product Catalog" + ] + } + }, + "/v1/catalog/resources": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns created resource", + "operationId": "createResource", + "parameters": [ + { + "description": "Resource object to be created", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/Resource" + } + }, + "201": { + "description": "Resource created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Resource already exist" + } + }, + "summary": "Create Resource", + "tags": [ + "Resources Catalog" + ] + } + }, + "/v1/catalog/resources/certified/abstract": { + "get": { + "consumes": [ + "application/json" + ], + "operationId": "getCertifiedAbstractResources", + "parameters": [ + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "default": { + "description": "successful operation" + } + }, + "tags": [ + "Resources Catalog" + ] + } + }, + "/v1/catalog/resources/certified/notabstract": { + "get": { + "consumes": [ + "application/json" + ], + "operationId": "getCertifiedNotAbstractResources", + "parameters": [ + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "default": { + "description": "successful operation" + } + }, + "tags": [ + "Resources Catalog" + ] + } + }, + "/v1/catalog/resources/csar/{csaruuid}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns resource created from csar uuid", + "operationId": "getResourceFromCsar", + "parameters": [ + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "in": "path", + "name": "csaruuid", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/Resource" + } + }, + "201": { + "description": "Resource retrieced" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Create Resource", + "tags": [ + "Resources Catalog" + ] + } + }, + "/v1/catalog/resources/resourceName/{resourceName}/resourceVersion/{resourceVersion}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns resource according to resourceId", + "operationId": "getResourceByNameAndVersion", + "parameters": [ + { + "in": "path", + "name": "resourceName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceVersion", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Resource found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Resource not found" + } + }, + "summary": "Retrieve Resource by name and version", + "tags": [ + "Resources Catalog" + ] + } + }, + "/v1/catalog/resources/validate-name/{resourceName}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "checks if the chosen resource name is available ", + "operationId": "validateResourceName", + "parameters": [ + { + "in": "path", + "name": "resourceName", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "subtype", + "required": false, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Resource found" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "validate resource name", + "tags": [ + "Resources Catalog" + ] + } + }, + "/v1/catalog/resources/{resourceId}": { + "delete": { + "operationId": "deleteResource", + "parameters": [ + { + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + } + ], + "responses": { + "default": { + "description": "successful operation" + } + }, + "tags": [ + "Resources Catalog" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns resource according to resourceId", + "operationId": "getResourceById", + "parameters": [ + { + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Resource found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Resource not found" + } + }, + "summary": "Retrieve Resource", + "tags": [ + "Resources Catalog" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "Returns updated resource", + "operationId": "updateResource", + "parameters": [ + { + "description": "Resource object to be updated", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Resource updated" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Resource already exist" + } + }, + "summary": "Update Resource", + "tags": [ + "Resources Catalog" + ] + } + }, + "/v1/catalog/resources/{resourceId}/additionalinfo": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns Additional Inforamtion property", + "operationId": "getAllResourceAdditionalInformationLabel", + "parameters": [ + { + "description": "resource id to update with new property", + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "list of additional information" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Additional information key already exist" + } + }, + "summary": "Get all Additional Information under resource", + "tags": [ + "Additional Information Servlet" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns created Additional Inforamtion property", + "operationId": "createResourceAdditionalInformationLabel", + "parameters": [ + { + "description": "resource id to update with new property", + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "description": "Additional information key value to be created", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Additional information created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Additional information key already exist" + } + }, + "summary": "Create Additional Information Label and Value", + "tags": [ + "Additional Information Servlet" + ] + } + }, + "/v1/catalog/resources/{resourceId}/additionalinfo/{labelId}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "Returns deleted Additional Inforamtion property", + "operationId": "updateResourceAdditionalInformationLabel", + "parameters": [ + { + "description": "resource id to update with new property", + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "description": "label id", + "in": "path", + "name": "labelId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Additional information deleted" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Additional information key already exist" + } + }, + "summary": "Create Additional Information Label and Value", + "tags": [ + "Additional Information Servlet" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns Additional Inforamtion property", + "operationId": "getResourceAdditionalInformationLabel", + "parameters": [ + { + "description": "resource id to update with new property", + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "description": "label id", + "in": "path", + "name": "labelId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "fetched additional information" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Additional information key already exist" + } + }, + "summary": "Get Additional Information by id", + "tags": [ + "Additional Information Servlet" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "Returns updated Additional Inforamtion property", + "operationId": "updateResourceAdditionalInformationLabel", + "parameters": [ + { + "description": "resource id to update with new property", + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "description": "label id", + "in": "path", + "name": "labelId", + "required": true, + "type": "string" + }, + { + "description": "Additional information key value to be created", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Additional information updated" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Additional information key already exist" + } + }, + "summary": "Update Additional Information Label and Value", + "tags": [ + "Additional Information Servlet" + ] + } + }, + "/v1/catalog/resources/{resourceId}/artifacts": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns created ArtifactDefinition", + "operationId": "loadArtifact", + "parameters": [ + { + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "description": "json describe the artifact", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Resource created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Artifact already exist" + } + }, + "summary": "Create Artifact", + "tags": [ + "Resource Artifact Servlet" + ] + } + }, + "/v1/catalog/resources/{resourceId}/artifacts/{artifactId}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "Returns delete artifact", + "operationId": "deleteArtifact", + "parameters": [ + { + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "artifactId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Resource created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Delete Artifact", + "tags": [ + "Resource Artifact Servlet" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns downloaded artifact", + "operationId": "downloadResourceArtifactBase64", + "parameters": [ + { + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "artifactId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Resource artifact downloaded" + }, + "404": { + "description": "Resource/Artifact not found" + } + }, + "summary": "Download resource Artifact in Base64", + "tags": [ + "Resource Artifact Servlet" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns updated artifact", + "operationId": "updateArtifact", + "parameters": [ + { + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "artifactId", + "required": true, + "type": "string" + }, + { + "description": "json describe the artifact", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Resource created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update Artifact", + "tags": [ + "Resource Artifact Servlet" + ] + } + }, + "/v1/catalog/resources/{resourceId}/attributes": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns created resource attribute", + "operationId": "createAttribute", + "parameters": [ + { + "description": "resource id to update with new attribute", + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "description": "Resource attribute to be created", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Resource property created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Resource attribute already exist" + } + }, + "summary": "Create Resource Attribute", + "tags": [ + "Resource Attribute Servlet" + ] + } + }, + "/v1/catalog/resources/{resourceId}/attributes/{attributeId}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "Returns deleted attribute", + "operationId": "deleteAttribute", + "parameters": [ + { + "description": "resource id of attribute", + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "description": "Attribute id to delete", + "in": "path", + "name": "attributeId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "deleted attribute" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Resource property not found" + } + }, + "summary": "Create Resource Attribute", + "tags": [ + "Resource Attribute Servlet" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "Returns updated attribute", + "operationId": "updateAttribute", + "parameters": [ + { + "description": "resource id to update with new attribute", + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "description": "attribute id to update", + "in": "path", + "name": "attributeId", + "required": true, + "type": "string" + }, + { + "description": "Resource attribute to update", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Resource attribute updated" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update Resource Attribute", + "tags": [ + "Resource Attribute Servlet" + ] + } + }, + "/v1/catalog/resources/{resourceId}/metadata": { + "put": { + "consumes": [ + "application/json" + ], + "description": "Returns updated resource metadata", + "operationId": "updateResourceMetadata", + "parameters": [ + { + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "description": "Resource metadata to be updated", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Resource metadata updated" + }, + "400": { + "description": "Invalid content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update Resource Metadata", + "tags": [ + "Resources Catalog" + ] + } + }, + "/v1/catalog/resources/{resourceId}/properties": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns created resource property", + "operationId": "createProperty", + "parameters": [ + { + "description": "resource id to update with new property", + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "description": "Resource property to be created", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Resource property created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Resource property already exist" + } + }, + "summary": "Create Resource Property", + "tags": [ + "Resource Property Servlet" + ] + } + }, + "/v1/catalog/resources/{resourceId}/properties/{propertyId}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "Returns deleted property", + "operationId": "deleteProperty", + "parameters": [ + { + "description": "resource id of property", + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "description": "Property id to delete", + "in": "path", + "name": "propertyId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "deleted property" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Resource property not found" + } + }, + "summary": "Create Resource Property", + "tags": [ + "Resource Property Servlet" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns property of resource", + "operationId": "getProperty", + "parameters": [ + { + "description": "resource id of property", + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "description": "proerty id to get", + "in": "path", + "name": "propertyId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "property" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Resource property not found" + } + }, + "summary": "Create Resource Property", + "tags": [ + "Resource Property Servlet" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "Returns updated property", + "operationId": "updateProperty", + "parameters": [ + { + "description": "resource id to update with new property", + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "description": "proerty id to update", + "in": "path", + "name": "propertyId", + "required": true, + "type": "string" + }, + { + "description": "Resource property to update", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Resource property updated" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update Resource Property", + "tags": [ + "Resource Property Servlet" + ] + } + }, + "/v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns created resource", + "operationId": "loadArtifactToInterface", + "parameters": [ + { + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "interfaceType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "operation", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "in": "header", + "name": "Content-MD5", + "required": false, + "type": "string" + }, + { + "description": "json describe the artifact", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Resource created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Artifact already exist" + } + }, + "summary": "Create Artifact and Attach to interface", + "tags": [ + "Resource Artifact Servlet" + ] + } + }, + "/v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts/{artifactId}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "delete matching artifact from interface", + "operationId": "deleteArtifactToInterface", + "parameters": [ + { + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "interfaceType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "operation", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "artifactId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "delete artifact under interface deleted" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Artifact already exist" + } + }, + "summary": "delete Artifact from interface", + "tags": [ + "Resource Artifact Servlet" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "updates artifact by interface", + "operationId": "updateArtifactToInterface", + "parameters": [ + { + "in": "path", + "name": "resourceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "interfaceType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "operation", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "artifactId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "in": "header", + "name": "Content-MD5", + "required": false, + "type": "string" + }, + { + "description": "json describe the artifact", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "delete artifact under interface deleted" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Artifact already exist" + } + }, + "summary": "update Artifact Attach to interface", + "tags": [ + "Resource Artifact Servlet" + ] + } + }, + "/v1/catalog/resources/{resourceName}/{version}": { + "delete": { + "operationId": "deleteResourceByNameAndVersion", + "parameters": [ + { + "in": "path", + "name": "resourceName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "required": true, + "type": "string" + } + ], + "responses": { + "default": { + "description": "successful operation" + } + }, + "tags": [ + "Resources Catalog" + ] + } + }, + "/v1/catalog/services": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns created service", + "operationId": "createService", + "parameters": [ + { + "description": "Service object to be created", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/Service" + } + }, + "201": { + "description": "Service created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Service already exist" + } + }, + "summary": "Create Service", + "tags": [ + "Service Catalog" + ] + } + }, + "/v1/catalog/services/distribution/{did}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Return the list of distribution status objects", + "operationId": "getListOfDistributionStatuses", + "parameters": [ + { + "in": "path", + "name": "did", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Service found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Status not found" + } + }, + "summary": "Retrieve Distributions", + "tags": [ + "Distribution Service Servlet" + ] + } + }, + "/v1/catalog/services/serviceName/{serviceName}/serviceVersion/{serviceVersion}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns service according to name and version", + "operationId": "getServiceByNameAndVersion", + "parameters": [ + { + "in": "path", + "name": "serviceName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "serviceVersion", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Service found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Service not found" + } + }, + "summary": "Retrieve Service", + "tags": [ + "Service Catalog" + ] + } + }, + "/v1/catalog/services/toscatoheat/{artifactName}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns downloaded artifact", + "operationId": "downloadServiceArtifact", + "parameters": [ + { + "in": "path", + "name": "artifactName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/octet-stream" + ], + "responses": { + "200": { + "description": "Artifact downloaded" + }, + "401": { + "description": "Authorization required" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Artifact not found" + } + }, + "summary": "Download service artifact", + "tags": [ + "Service Catalog" + ] + } + }, + "/v1/catalog/services/validate-name/{serviceName}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "checks if the chosen service name is available ", + "operationId": "validateServiceName", + "parameters": [ + { + "in": "path", + "name": "serviceName", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Service found" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "validate service name", + "tags": [ + "Service Catalog" + ] + } + }, + "/v1/catalog/services/{componentId}/inputs": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns Inputs list", + "operationId": "getComponentInputs", + "parameters": [ + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "fromId", + "required": false, + "type": "string" + }, + { + "format": "int32", + "in": "query", + "name": "amount", + "required": false, + "type": "integer" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Component found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Component not found" + } + }, + "summary": "Get Inputs only", + "tags": [ + "Input Catalog" + ] + } + }, + "/v1/catalog/services/{serviceId}": { + "delete": { + "operationId": "deleteService", + "parameters": [ + { + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + } + ], + "responses": { + "default": { + "description": "successful operation" + } + }, + "tags": [ + "Service Catalog" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns service according to serviceId", + "operationId": "getServiceById", + "parameters": [ + { + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Service found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Service not found" + } + }, + "summary": "Retrieve Service", + "tags": [ + "Service Catalog" + ] + } + }, + "/v1/catalog/services/{serviceId}/additionalinfo": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns Additional Inforamtion property", + "operationId": "getAllServiceAdditionalInformationLabel", + "parameters": [ + { + "description": "service id to update with new property", + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "list of additional information" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Additional information key already exist" + } + }, + "summary": "Get all Additional Information under service", + "tags": [ + "Additional Information Servlet" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns created Additional Inforamtion property", + "operationId": "createServiceAdditionalInformationLabel", + "parameters": [ + { + "description": "service id to update with new property", + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "description": "Additional information key value to be created", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Additional information created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Additional information key already exist" + } + }, + "summary": "Create Additional Information Label and Value", + "tags": [ + "Additional Information Servlet" + ] + } + }, + "/v1/catalog/services/{serviceId}/additionalinfo/{labelId}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "Returns deleted Additional Inforamtion property", + "operationId": "deleteServiceAdditionalInformationLabel", + "parameters": [ + { + "description": "service id to update with new property", + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "description": "label id", + "in": "path", + "name": "labelId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Additional information deleted" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Additional information key already exist" + } + }, + "summary": "Create Additional Information Label and Value", + "tags": [ + "Additional Information Servlet" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns Additional Inforamtion property", + "operationId": "getServiceAdditionalInformationLabel", + "parameters": [ + { + "description": "service id to update with new property", + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "description": "label id", + "in": "path", + "name": "labelId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "fetched additional information" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Additional information key already exist" + } + }, + "summary": "Get Additional Information by id", + "tags": [ + "Additional Information Servlet" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "Returns updated Additional Inforamtion property", + "operationId": "updateServiceAdditionalInformationLabel", + "parameters": [ + { + "description": "service id to update with new property", + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "description": "label id", + "in": "path", + "name": "labelId", + "required": true, + "type": "string" + }, + { + "description": "Additional information key value to be created", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Additional information updated" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Additional information key already exist" + } + }, + "summary": "Update Additional Information Label and Value", + "tags": [ + "Additional Information Servlet" + ] + } + }, + "/v1/catalog/services/{serviceId}/artifacts": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns created ArtifactDefinition", + "operationId": "loadInformationArtifact", + "parameters": [ + { + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "description": "json describe the artifact", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Resource created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Artifact already exist" + } + }, + "summary": "Create Artifact", + "tags": [ + "Resource Artifact Servlet" + ] + } + }, + "/v1/catalog/services/{serviceId}/artifacts/api/{artifactId}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "Returns Deleted ArtifactDefinition", + "operationId": "deleteApiArtifact", + "parameters": [ + { + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "artifactId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "in": "header", + "name": "Content-MD5", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Api Artifact deleted" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Delete Api Artifact", + "tags": [ + "Resource Artifact Servlet" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns created ArtifactDefinition", + "operationId": "updateApiArtifact", + "parameters": [ + { + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "artifactId", + "required": true, + "type": "string" + }, + { + "description": "json describe the artifact", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "in": "header", + "name": "Content-MD5", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Api Artifact Updated" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update Api Artifact", + "tags": [ + "Resource Artifact Servlet" + ] + } + }, + "/v1/catalog/services/{serviceId}/artifacts/{artifactId}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "Returns delete artifact", + "operationId": "deleteInformationalArtifact", + "parameters": [ + { + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "artifactId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Service artifact deleted" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Delete Artifact", + "tags": [ + "Resource Artifact Servlet" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns downloaded artifact", + "operationId": "downloadServiceArtifactBase64", + "parameters": [ + { + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "artifactId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Service artifact downloaded" + }, + "404": { + "description": "Service/Artifact not found" + } + }, + "summary": "Download service Artifact in Base64", + "tags": [ + "Resource Artifact Servlet" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns updated artifact", + "operationId": "updateInformationArtifact", + "parameters": [ + { + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "artifactId", + "required": true, + "type": "string" + }, + { + "description": "json describe the artifact", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Service artifact created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update Artifact", + "tags": [ + "Resource Artifact Servlet" + ] + } + }, + "/v1/catalog/services/{serviceId}/distribution-state/{state}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "service with the changed distribution status", + "operationId": "updateServiceDistributionState", + "parameters": [ + { + "description": "DistributionChangeInfo - get comment out of body", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LifecycleChangeInfoWithAction" + } + }, + { + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "enum": [ + "approve", + "reject" + ], + "in": "path", + "name": "state", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Service distribution state changed" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Service is not available for distribution" + }, + "404": { + "description": "Requested service was not found" + }, + "409": { + "description": "Restricted operation" + }, + "500": { + "description": "Internal Server Error. Please try again later." + } + }, + "summary": "Update Service Distribution State", + "tags": [ + "Service Catalog" + ] + } + }, + "/v1/catalog/services/{serviceId}/distribution/{did}/markDeployed": { + "post": { + "consumes": [ + "application/json" + ], + "description": "relevant audit record will be created", + "operationId": "markDistributionAsDeployed", + "parameters": [ + { + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "did", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "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." + } + }, + "summary": "Mark distribution as deployed", + "tags": [ + "Service Catalog" + ] + } + }, + "/v1/catalog/services/{serviceId}/distribution/{env}/activate": { + "post": { + "consumes": [ + "application/json" + ], + "description": "activate distribution", + "operationId": "activateDistribution", + "parameters": [ + { + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "env", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "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." + } + }, + "summary": "Activate distribution", + "tags": [ + "Service Catalog" + ] + } + }, + "/v1/catalog/services/{serviceId}/metadata": { + "put": { + "consumes": [ + "application/json" + ], + "description": "Returns updated service", + "operationId": "updateServiceMetadata", + "parameters": [ + { + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "description": "Service object to be Updated", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Service Updated" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update Service Metadata", + "tags": [ + "Service Catalog" + ] + } + }, + "/v1/catalog/services/{serviceId}/tempUrlToBeDeleted": { + "post": { + "consumes": [ + "application/json" + ], + "operationId": "tempUrlToBeDeleted", + "parameters": [ + { + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK" + }, + "500": { + "description": "Internal Server Error. Please try again later." + } + }, + "tags": [ + "Service Catalog" + ] + } + }, + "/v1/catalog/services/{serviceName}/{version}": { + "delete": { + "operationId": "deleteServiceByNameAndVersion", + "parameters": [ + { + "in": "path", + "name": "serviceName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "required": true, + "type": "string" + } + ], + "responses": { + "default": { + "description": "successful operation" + } + }, + "tags": [ + "Service Catalog" + ] + } + }, + "/v1/catalog/services/{serviceUUID}/distribution": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns list bases on the information extracted from Auditing Records according to service uuid", + "operationId": "getServiceById", + "parameters": [ + { + "in": "path", + "name": "serviceUUID", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Service found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Service not found" + } + }, + "summary": "Retrieve Distributions", + "tags": [ + "Distribution Service Servlet" + ] + } + }, + "/v1/catalog/upload/{resourceAuthority}": { + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "Returns created resource", + "operationId": "uploadMultipart", + "parameters": [ + { + "description": "validValues: normative-resource / user-resource", + "enum": [ + "multipart", + "user-resource", + "user-resource-ui-import" + ], + "in": "path", + "name": "resourceAuthority", + "required": true, + "type": "string" + }, + { + "description": "FileInputStream", + "in": "formData", + "name": "resourceZip", + "required": false, + "type": "file" + }, + { + "description": "resourceMetadata", + "in": "formData", + "name": "resourceMetadata", + "required": false, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "default": true, + "in": "query", + "name": "createNewVersion", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Resource created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Resource already exist" + } + }, + "summary": "Create Resource from yaml", + "tags": [ + "Resources Catalog Upload" + ] + } + }, + "/v1/catalog/uploadType/capability": { + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "Returns created Capability Type", + "operationId": "uploadCapabilityType", + "parameters": [ + { + "description": "FileInputStream", + "in": "formData", + "name": "capabilityTypeZip", + "required": false, + "type": "file" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Capability Type created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Capability Type already exist" + } + }, + "summary": "Create Capability Type from yaml", + "tags": [ + "Catalog Types Upload" + ] + } + }, + "/v1/catalog/uploadType/categories": { + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "Returns created categories", + "operationId": "uploadCategories", + "parameters": [ + { + "description": "FileInputStream", + "in": "formData", + "name": "categoriesZip", + "required": false, + "type": "file" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Categories created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Category already exist" + } + }, + "summary": "Create Categories from yaml", + "tags": [ + "Catalog Types Upload" + ] + } + }, + "/v1/catalog/uploadType/datatypes": { + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "Returns created data types", + "operationId": "uploadDataTypes", + "parameters": [ + { + "description": "FileInputStream", + "in": "formData", + "name": "dataTypesZip", + "required": false, + "type": "file" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Data types created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Data types already exist" + } + }, + "summary": "Create Categories from yaml", + "tags": [ + "Catalog Types Upload" + ] + } + }, + "/v1/catalog/uploadType/grouptypes": { + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "Returns created group types", + "operationId": "uploadGroupTypes", + "parameters": [ + { + "description": "FileInputStream", + "in": "formData", + "name": "groupTypesZip", + "required": false, + "type": "file" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "group types created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "group types already exist" + } + }, + "summary": "Create GroupTypes from yaml", + "tags": [ + "Catalog Types Upload" + ] + } + }, + "/v1/catalog/uploadType/interfaceLifecycle": { + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "Returns created Interface Lifecycle Type", + "operationId": "uploadInterfaceLifecycleType", + "parameters": [ + { + "description": "FileInputStream", + "in": "formData", + "name": "interfaceLifecycleTypeZip", + "required": false, + "type": "file" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Interface Lifecycle Type created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Interface Lifecycle Type already exist" + } + }, + "summary": "Create Interface Lyfecycle Type from yaml", + "tags": [ + "Catalog Types Upload" + ] + } + }, + "/v1/catalog/uploadType/policytypes": { + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "Returns created policy types", + "operationId": "uploadPolicyTypes", + "parameters": [ + { + "description": "FileInputStream", + "in": "formData", + "name": "policyTypesZip", + "required": false, + "type": "file" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "policy types created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "policy types already exist" + } + }, + "summary": "Create PolicyTypes from yaml", + "tags": [ + "Catalog Types Upload" + ] + } + }, + "/v1/catalog/{componentCollection}/{componentId}/lifecycleState/{lifecycleOperation}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "changeResourceState", + "parameters": [ + { + "description": "LifecycleChangeInfo - relevant for checkin, failCertification, cancelCertification", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "validValues: resources / services / products", + "enum": [ + "resources", + "services", + "products" + ], + "in": "path", + "name": "componentCollection", + "required": true, + "type": "string" + }, + { + "enum": [ + "checkout", + "undoCheckout", + "checkin", + "certificationRequest", + "startCertification", + "failCertification", + "cancelCertification", + "certify" + ], + "in": "path", + "name": "lifecycleOperation", + "required": true, + "type": "string" + }, + { + "description": "id of component to be changed", + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "description": "id of user initiating the operation", + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Resource state changed" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Resource already exist" + } + }, + "summary": "Change Resource lifecycle State", + "tags": [ + "Lifecycle Actions Servlet" + ] + } + }, + "/v1/catalog/{componentType}/latestversion/notabstract": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns Requirments And Capabilities according to componentId", + "operationId": "getLatestVersionNotAbstractCheckoutComponentsByBody", + "parameters": [ + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "internalComponentType", + "required": false, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "description": "Consumer Object to be created", + "in": "body", + "name": "body", + "required": true, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Component found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Component not found" + } + }, + "summary": "Get Component Requirments And Capabilities", + "tags": [ + "Component Servlet" + ] + } + }, + "/v1/catalog/{componentType}/latestversion/notabstract/metadata": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns componentId", + "operationId": "getLatestVersionNotAbstractCheckoutComponentsIdesOnly", + "parameters": [ + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "internalComponentType", + "required": false, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "description": "uid list", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Component found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Component not found" + } + }, + "summary": "Get Component uid only", + "tags": [ + "Component Servlet" + ] + } + }, + "/v1/catalog/{componentType}/{componentId}/componentInstances": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns component instances", + "operationId": "getComponentInstancesFilteredByPropertiesAndInputs", + "parameters": [ + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "searchText", + "required": false, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "description": "uid list", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Component found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Component not found" + } + }, + "summary": "Get Component instances", + "tags": [ + "Component Servlet" + ] + } + }, + "/v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{inputId}/properties": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns properties list", + "operationId": "getInputPropertiesForComponentInstance", + "parameters": [ + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "inputId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Component found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Component not found" + } + }, + "summary": "Get properties", + "tags": [ + "Input Catalog" + ] + } + }, + "/v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/inputs": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns Inputs list", + "operationId": "getComponentInstanceInputs", + "parameters": [ + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "originComponentUid", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Component found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Component not found" + } + }, + "summary": "Get Inputs only", + "tags": [ + "Input Catalog" + ] + } + }, + "/v1/catalog/{componentType}/{componentId}/create/inputs": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Return inputs list", + "operationId": "createMultipleInputs", + "parameters": [ + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "description": "ComponentIns Inputs Object to be created", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Component found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Component not found" + } + }, + "summary": "Create inputs on service", + "tags": [ + "Input Catalog" + ] + } + }, + "/v1/catalog/{componentType}/{componentId}/delete/{inputId}/input": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "Delete service input", + "operationId": "deleteInput", + "parameters": [ + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "inputId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "description": "Service Input to be deleted", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Input deleted" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Input not found" + } + }, + "summary": "Delete input from service", + "tags": [ + "Input Catalog" + ] + } + }, + "/v1/catalog/{componentType}/{componentId}/filteredDataByParams": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns resource according to resourceId", + "operationId": "getComponentDataFilteredByParams", + "parameters": [ + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "collectionFormat": "multi", + "in": "query", + "items": { + "type": "string" + }, + "name": "include", + "required": false, + "type": "array" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Resource found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Resource not found" + } + }, + "summary": "Retrieve Resource", + "tags": [ + "Component Servlet" + ] + } + }, + "/v1/catalog/{componentType}/{componentId}/filteredproperties/{propertyNameFragment}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns properties belonging to component instances of specific component by name and optionally resource type", + "operationId": "getFilteredComponentInstanceProperties", + "parameters": [ + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "propertyNameFragment", + "required": true, + "type": "string" + }, + { + "collectionFormat": "multi", + "in": "query", + "items": { + "type": "string" + }, + "name": "resourceType", + "required": false, + "type": "array" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Component found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Component not found" + } + }, + "summary": "Retrieve properties belonging to component instances of specific component by name and optionally resource type", + "tags": [ + "Component Servlet" + ] + } + }, + "/v1/catalog/{componentType}/{componentId}/inputs/{inputId}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns inputs list", + "operationId": "getInputsAndPropertiesForComponentInput", + "parameters": [ + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "inputId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Component found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Component not found" + } + }, + "summary": "Get inputs", + "tags": [ + "Input Catalog" + ] + } + }, + "/v1/catalog/{componentType}/{componentId}/inputs/{inputId}/inputs": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns inputs list", + "operationId": "getInputsForComponentInput", + "parameters": [ + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "inputId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Component found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Component not found" + } + }, + "summary": "Get inputs", + "tags": [ + "Input Catalog" + ] + } + }, + "/v1/catalog/{componentType}/{componentId}/requirmentsCapabilities": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns Requirements And Capabilities according to componentId", + "operationId": "getRequirementAndCapabilities", + "parameters": [ + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Component found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Component not found" + } + }, + "summary": "Get Component Requirments And Capabilities", + "tags": [ + "Component Servlet" + ] + } + }, + "/v1/catalog/{componentType}/{componentUuid}/conformanceLevelValidation": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns the result according to conformance level in BE config", + "operationId": "conformanceLevelValidation", + "parameters": [ + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentUuid", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Component found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Component not found" + } + }, + "summary": "Validate Component Conformance Level", + "tags": [ + "Component Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/artifactsByType/{artifactGroupType}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns artifacts", + "operationId": "getComponentArtifacts", + "parameters": [ + { + "description": "valid values: resources / services", + "enum": [ + "resources", + "services" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "artifactGroupType", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Component artifacts" + }, + "404": { + "description": "Resource/Artifact not found" + } + }, + "summary": "Get component Artifacts", + "tags": [ + "Resource Artifact Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupId}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns artifacts metadata according to groupId", + "operationId": "getGroupArtifactById", + "parameters": [ + { + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "groupId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "group found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Group not found" + } + }, + "summary": "Get group artifacts ", + "tags": [ + "Resource Group Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/metadata": { + "put": { + "consumes": [ + "application/json" + ], + "description": "Returns updated group definition", + "operationId": "updateGroupMetadata", + "parameters": [ + { + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "groupUniqueId", + "required": true, + "type": "string" + }, + { + "description": "Service object to be Updated", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Group Updated" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update Group Metadata", + "tags": [ + "Resource Group Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/properties": { + "put": { + "consumes": [ + "application/json" + ], + "description": "Returns updated list of properties", + "operationId": "updateGroupProperties", + "parameters": [ + { + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "groupUniqueId", + "required": true, + "type": "string" + }, + { + "description": "Service object to be Updated", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Group Updated" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Updates List of properties on a group (only values)", + "tags": [ + "Resource Group Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns created ComponentInstance", + "operationId": "createComponentInstance", + "parameters": [ + { + "description": "RI object to be created", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "description": "valid values: resources / services", + "enum": [ + "resources", + "services" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "description": "USER_ID of modifier user", + "in": "header", + "name": "USER_ID", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Component created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Component instance already exist" + } + }, + "summary": "Create ComponentInstance", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/associate": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns created RelationshipInfo", + "operationId": "associateRIToRI", + "parameters": [ + { + "description": "unique id of the container component", + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "description": "allowed values are resources /services / products", + "enum": [ + "resources", + "services", + "products" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "description": "RelationshipInfo", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Relationship created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Missing information" + }, + "409": { + "description": "Relationship already exist" + } + }, + "summary": "Associate RI to RI", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/createAndAssociate": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns created RI and RelationshipInfo", + "operationId": "createAndAssociateRIToRI", + "parameters": [ + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "description": "valid values: resources / services", + "enum": [ + "resources", + "services" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "RI created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Relationship already exist" + } + }, + "summary": "Create RI and associate RI to RI", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/dissociate": { + "put": { + "consumes": [ + "application/json" + ], + "description": "Returns deleted RelationshipInfo", + "operationId": "dissociateRIFromRI", + "parameters": [ + { + "description": "allowed values are resources /services / products", + "enum": [ + "resources", + "services", + "products" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "description": "unique id of the container component", + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "description": "RelationshipInfo", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Relationship deleted" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Missing information" + } + }, + "summary": "Dissociate RI from RI", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/multipleComponentInstance": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns updated resource instance", + "operationId": "updateMultipleComponentInstance", + "parameters": [ + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "description": "valid values: resources / services / products", + "enum": [ + "resources", + "services", + "products" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "description": "Component Instance JSON Array", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Resource instance updated" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update resource instance multiple component", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns updated resource instance", + "operationId": "updateComponentInstanceMetadata", + "parameters": [ + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentInstanceId", + "required": true, + "type": "string" + }, + { + "description": "valid values: resources / services / products", + "enum": [ + "resources", + "services", + "products" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Resource instance updated" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update resource instance", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns updated artifact", + "operationId": "loadComponentInstanceArtifact", + "parameters": [ + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "in": "header", + "name": "Content-MD5", + "required": false, + "type": "string" + }, + { + "description": "valid values: resources / services", + "enum": [ + "resources", + "services" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentInstanceId", + "required": true, + "type": "string" + }, + { + "description": "json describe the artifact", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Artifact updated" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Load Resource Instance artifact payload", + "tags": [ + "Resource Artifact Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns deleted artifact", + "operationId": "deleteComponentInstanceArtifact", + "parameters": [ + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "in": "header", + "name": "Content-MD5", + "required": false, + "type": "string" + }, + { + "description": "valid values: resources / services", + "enum": [ + "resources", + "services" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentInstanceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "artifactId", + "required": true, + "type": "string" + }, + { + "description": "json describe the artifact", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Artifact updated" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Delete Resource Instance artifact", + "tags": [ + "Resource Artifact Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}/heatParams": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns updated artifact", + "operationId": "updateRIArtifact", + "parameters": [ + { + "description": "valid values: resources / services", + "enum": [ + "resources", + "services" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentInstanceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "artifactId", + "required": true, + "type": "string" + }, + { + "description": "json describe the artifact", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Artifact updated" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update Resource Instance HEAT_ENV parameters", + "tags": [ + "Resource Artifact Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/attribute": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns updated resource instance attribute", + "operationId": "updateResourceInstanceAttribute", + "parameters": [ + { + "description": "service id", + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "description": "valid values: resources / services", + "enum": [ + "resources", + "services" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "description": "resource instance id", + "in": "path", + "name": "componentInstanceId", + "required": true, + "type": "string" + }, + { + "description": "id of user initiating the operation", + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Resource instance created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update resource instance attribute", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/changeVersion": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns updated resource instance", + "operationId": "changeResourceInstanceVersion", + "parameters": [ + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentInstanceId", + "required": true, + "type": "string" + }, + { + "description": "valid values: resources / services", + "enum": [ + "resources", + "services" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Resource instance created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update resource instance", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstId}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns artifacts metadata according to groupInstId", + "operationId": "getGroupArtifactById", + "parameters": [ + { + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentInstanceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "groupInstId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "group found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Group not found" + } + }, + "summary": "Get group artifacts ", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}/property": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns updated resource instance property", + "operationId": "updateGroupInstanceProperty", + "parameters": [ + { + "description": "service id", + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "description": "valid values: resources / services", + "enum": [ + "resources", + "services" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "description": "resource instance id", + "in": "path", + "name": "componentInstanceId", + "required": true, + "type": "string" + }, + { + "description": "group instance id", + "in": "path", + "name": "groupInstanceId", + "required": true, + "type": "string" + }, + { + "description": "id of user initiating the operation", + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Resource instance created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update resource instance property", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/input": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns updated resource instance property", + "operationId": "updateResourceInstanceInput", + "parameters": [ + { + "description": "service id", + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "description": "valid values: resources / services", + "enum": [ + "resources", + "services" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "description": "resource instance id", + "in": "path", + "name": "componentInstanceId", + "required": true, + "type": "string" + }, + { + "description": "id of user initiating the operation", + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Resource instance created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update resource instance property", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns updated resource instance property", + "operationId": "updateResourceInstanceProperty", + "parameters": [ + { + "description": "service id", + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "description": "valid values: resources / services", + "enum": [ + "resources", + "services" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "description": "resource instance id", + "in": "path", + "name": "componentInstanceId", + "required": true, + "type": "string" + }, + { + "description": "id of user initiating the operation", + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Resource instance created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update resource instance property", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property/{propertyId}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "Returns deleted resource instance property", + "operationId": "deleteResourceInstanceProperty", + "parameters": [ + { + "description": "service id", + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "description": "valid values: resources / services", + "enum": [ + "resources", + "services" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "description": "resource instance id", + "in": "path", + "name": "componentInstanceId", + "required": true, + "type": "string" + }, + { + "description": "property id", + "in": "path", + "name": "propertyId", + "required": true, + "type": "string" + }, + { + "description": "id of user initiating the operation", + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Resource instance created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update resource instance", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{resourceInstanceId}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "Returns delete resourceInstance", + "operationId": "deleteResourceInstance", + "parameters": [ + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceInstanceId", + "required": true, + "type": "string" + }, + { + "description": "valid values: resources / services / products", + "enum": [ + "resources", + "services", + "products" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "ResourceInstance deleted" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Delete ResourceInstance", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifacts/{artifactId}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns downloaded artifact", + "operationId": "downloadResourceInstanceArtifactBase64", + "parameters": [ + { + "description": "valid values: resources / services", + "enum": [ + "resources", + "services" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentInstanceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "artifactId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "ResourceInstance artifact downloaded" + }, + "404": { + "description": "ResourceInstance/Artifact not found" + } + }, + "summary": "Download component Artifact in Base64", + "tags": [ + "Resource Artifact Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifactsByType/{artifactGroupType}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns artifacts", + "operationId": "getComponentInstanceArtifacts", + "parameters": [ + { + "description": "valid values: resources / services", + "enum": [ + "resources", + "services" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentInstanceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "artifactGroupType", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Component artifacts" + }, + "404": { + "description": "Resource/Artifact not found" + } + }, + "summary": "Get component Artifacts", + "tags": [ + "Resource Artifact Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{componentId}/update/inputs": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns updated input", + "operationId": "updateComponentInputs", + "parameters": [ + { + "description": "valid values: resources / services", + "enum": [ + "resources", + "services" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentId", + "required": true, + "type": "string" + }, + { + "description": "json describe the input", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Input updated" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update resource inputs", + "tags": [ + "Input Catalog" + ] + } + }, + "/v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/properties": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns component instance properties", + "operationId": "getInstancePropertiesById", + "parameters": [ + { + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "containerComponentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentInstanceUniqueId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Properties found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Component/Component Instance - not found" + } + }, + "summary": "Get component instance properties", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns created service proxy", + "operationId": "createServiceProxy", + "parameters": [ + { + "description": "RI object to be created", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "containerComponentId", + "required": true, + "type": "string" + }, + { + "description": "valid values: resources / services", + "enum": [ + "resources", + "services" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + }, + { + "description": "USER_ID of modifier user", + "in": "header", + "name": "USER_ID", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Service proxy created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + }, + "409": { + "description": "Service proxy already exist" + } + }, + "summary": "Create service proxy", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "Returns delete service proxy", + "operationId": "deleteServiceProxy", + "parameters": [ + { + "in": "path", + "name": "containerComponentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "serviceProxyId", + "required": true, + "type": "string" + }, + { + "description": "valid values: resources / services / products", + "enum": [ + "resources", + "services", + "products" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Service proxy deleted" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Delete service proxy", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}/changeVersion/{newServiceId}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns updated service proxy", + "operationId": "changeServiceProxyVersion", + "parameters": [ + { + "in": "path", + "name": "containerComponentId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "serviceProxyId", + "required": true, + "type": "string" + }, + { + "description": "valid values: resources / services", + "enum": [ + "resources", + "services" + ], + "in": "path", + "name": "containerComponentType", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Service proxy created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update service proxy with new version", + "tags": [ + "Resource Instance Servlet" + ] + } + }, + "/v1/catalog/{containerComponentType}/{serviceId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}": { + "put": { + "consumes": [ + "application/json" + ], + "description": "Returns updated group instance", + "operationId": "updateGroupInstancePropertyValues", + "parameters": [ + { + "in": "path", + "name": "serviceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentInstanceId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "groupInstanceId", + "required": true, + "type": "string" + }, + { + "description": "Group instance object to be Updated", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Group Instance Property Values Updated" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Update Group Instance Property Values", + "tags": [ + "Service Catalog" + ] + } + }, + "/v1/categories": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Retrieve the all resource, service and product categories", + "operationId": "getAllCategories", + "parameters": [ + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns categories Ok" + }, + "403": { + "description": "Missing information" + }, + "409": { + "description": "Restricted operation" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Retrieve the all resource, service and product categories", + "tags": [ + "Element Servlet" + ] + } + }, + "/v1/categories/{componentType}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Retrieve the list of all resource/service/product categories/sub-categories/groupings.", + "operationId": "getComponentCategories", + "parameters": [ + { + "description": "allowed values are resources / services/ products", + "enum": [ + "resources", + "services", + "products" + ], + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns categories Ok" + }, + "400": { + "description": "Invalid component type" + }, + "403": { + "description": "Missing information" + }, + "409": { + "description": "Restricted operation" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Retrieve the list of all resource/service/product categories/sub-categories/groupings", + "tags": [ + "Element Servlet" + ] + } + }, + "/v1/category/{componentType}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Create new component category", + "operationId": "createComponentCategory", + "parameters": [ + { + "description": "allowed values are resources /services / products", + "enum": [ + "resources", + "services", + "products" + ], + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "description": "Category to be created", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "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" + } + }, + "summary": "Create new component category", + "tags": [ + "Element Servlet" + ] + } + }, + "/v1/category/{componentType}/{categoryId}/subCategory": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Create new component sub-category for existing category", + "operationId": "createComponentSubCategory", + "parameters": [ + { + "description": "allowed values are resources / products", + "enum": [ + "resources", + "products" + ], + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "description": "Parent category unique ID", + "in": "path", + "name": "categoryId", + "required": true, + "type": "string" + }, + { + "description": "Subcategory to be created. \ne.g. {\"name\":\"Resource-subcat\"}", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "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" + } + }, + "summary": "Create new component sub-category", + "tags": [ + "Element Servlet" + ] + } + }, + "/v1/category/{componentType}/{categoryId}/subCategory/{subCategoryId}/grouping": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Create new component grouping for existing sub-category", + "operationId": "createComponentGrouping", + "parameters": [ + { + "description": "allowed values are products", + "enum": [ + "products" + ], + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "description": "Parent category unique ID", + "in": "path", + "name": "categoryId", + "required": true, + "type": "string" + }, + { + "description": "Parent sub-category unique ID", + "in": "path", + "name": "subCategoryId", + "required": true, + "type": "string" + }, + { + "description": "Subcategory to be created", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "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" + } + }, + "summary": "Create new component grouping", + "tags": [ + "Element Servlet" + ] + } + }, + "/v1/category/{componentType}/{categoryUniqueId}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "Delete component category", + "operationId": "deleteComponentCategory", + "parameters": [ + { + "in": "path", + "name": "categoryUniqueId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/Category" + } + }, + "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" + } + }, + "summary": "Delete component category", + "tags": [ + "Element Servlet" + ] + } + }, + "/v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "Delete component category", + "operationId": "deleteComponentSubCategory", + "parameters": [ + { + "in": "path", + "name": "categoryUniqueId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subCategoryUniqueId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/Category" + } + }, + "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" + } + }, + "summary": "Delete component category", + "tags": [ + "Element Servlet" + ] + } + }, + "/v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}/grouping/{groupingUniqueId}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "Delete component category", + "operationId": "deleteComponentGrouping", + "parameters": [ + { + "in": "path", + "name": "categoryUniqueId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subCategoryUniqueId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "groupingUniqueId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/Category" + } + }, + "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" + } + }, + "summary": "Delete component category", + "tags": [ + "Element Servlet" + ] + } + }, + "/v1/configuration/ui": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Retrieve all artifactTypes", + "operationId": "getConfiguration", + "parameters": [ + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns artifactTypes Ok" + }, + "404": { + "description": "No artifactTypes were found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Retrieve all artifactTypes", + "tags": [ + "Element Servlet" + ] + } + }, + "/v1/consumers": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Returns created ONAP consumer credentials", + "operationId": "createConsumer", + "parameters": [ + { + "description": "Consumer Object to be created", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "Consumer credentials created" + }, + "400": { + "description": "Invalid content / Missing content" + }, + "403": { + "description": "Restricted operation" + } + }, + "summary": "Consumer credentials", + "tags": [ + "Consumer Servlet" + ] + } + }, + "/v1/consumers/{consumerId}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "Returns deleted consumer according to ConsumerID", + "operationId": "deleteConsumer", + "parameters": [ + { + "in": "path", + "name": "consumerId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/ConsumerDefinition" + } + }, + "204": { + "description": "Consumer deleted" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Consumer not found" + } + }, + "summary": "Deletes Consumer", + "tags": [ + "Consumer Servlet" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns consumer according to ConsumerID", + "operationId": "getConsumer", + "parameters": [ + { + "in": "path", + "name": "consumerId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Consumer found" + }, + "403": { + "description": "Restricted operation" + }, + "404": { + "description": "Consumer not found" + } + }, + "summary": "Retrieve Consumer", + "tags": [ + "Consumer Servlet" + ] + } + }, + "/v1/ecompPortalMenu": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Retrieve ONAP portal menu", + "operationId": "getListOfCsars", + "parameters": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Retrieve ONAP portal menu" + } + }, + "summary": "Retrieve ONAP portal menu - MOC", + "tags": [ + "Element Servlet" + ] + } + }, + "/v1/followed": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Retrieve all followed", + "operationId": "getFollowedResourcesServices", + "parameters": [ + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns followed Ok" + }, + "404": { + "description": "User not found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Retrieve all followed", + "tags": [ + "Element Servlet" + ] + } + }, + "/v1/inactiveComponents/{componentType}": { + "delete": { + "operationId": "deleteMarkedResources", + "parameters": [ + { + "in": "path", + "name": "componentType", + "required": true, + "type": "string" + } + ], + "responses": { + "default": { + "description": "successful operation" + } + }, + "tags": [ + "Element Servlet" + ] + } + }, + "/v1/propertyScopes": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Retrieve all propertyScopes", + "operationId": "getPropertyScopes", + "parameters": [ + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns propertyScopes Ok" + }, + "404": { + "description": "No propertyScopes were found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Retrieve all propertyScopes", + "tags": [ + "Element Servlet" + ] + } + }, + "/v1/screen": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Retrieve catalog resources and services", + "operationId": "getCatalogComponents", + "parameters": [ + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "collectionFormat": "multi", + "in": "query", + "items": { + "enum": [ + "PRODUCT", + "SERVICE", + "VF", + "VFC", + "CP", + "VL", + "VFCMT", + "CVFC", + "PNF" + ], + "type": "string" + }, + "name": "excludeTypes", + "required": false, + "type": "array" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns resources and services Ok" + }, + "404": { + "description": "User not found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Retrieve catalog resources and services", + "tags": [ + "Element Servlet" + ] + } + }, + "/v1/tags": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Retrieve all tags", + "operationId": "getTags", + "parameters": [ + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns tags Ok" + }, + "404": { + "description": "No tags were found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Retrieve all tags", + "tags": [ + "Element Servlet" + ] + } + }, + "/v1/user": { + "post": { + "consumes": [ + "application/json" + ], + "description": "Provision new user", + "operationId": "createUser", + "parameters": [ + { + "description": "json describe the user", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/User" + } + }, + "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" + } + }, + "summary": "add user", + "tags": [ + "User Administration" + ] + } + }, + "/v1/user/admins": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns all administrators", + "operationId": "getAdminsUser", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns user Ok" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "retrieve all administrators", + "tags": [ + "User Administration" + ] + } + }, + "/v1/user/authorize": { + "get": { + "consumes": [ + "application/json" + ], + "description": "authorize user", + "operationId": "authorize", + "parameters": [ + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "in": "header", + "name": "HTTP_CSP_FIRSTNAME", + "required": false, + "type": "string" + }, + { + "in": "header", + "name": "HTTP_CSP_LASTNAME", + "required": false, + "type": "string" + }, + { + "in": "header", + "name": "HTTP_CSP_EMAIL", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns user Ok" + }, + "403": { + "description": "Restricted Access" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "authorize", + "tags": [ + "User Administration" + ] + } + }, + "/v1/user/users": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns list of users with the specified roles, or all of users in the case of empty 'roles' header", + "operationId": "getUsersList", + "parameters": [ + { + "description": "Any active user's USER_ID ", + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + }, + { + "description": "TESTER,DESIGNER,PRODUCT_STRATEGIST,OPS,PRODUCT_MANAGER,GOVERNOR, ADMIN OR all users by not typing anything", + "in": "query", + "name": "roles", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "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" + } + }, + "summary": "Retrieve the list of all active ASDC users or only group of users having specific roles.", + "tags": [ + "User Administration" + ] + } + }, + "/v1/user/{userId}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "Delete user", + "operationId": "deActivateUser", + "parameters": [ + { + "description": "userId of user to get", + "in": "path", + "name": "userId", + "required": true, + "type": "string" + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "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" + } + }, + "summary": "delete user", + "tags": [ + "User Administration" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns user details according to userId", + "operationId": "get", + "parameters": [ + { + "description": "userId of user to get", + "in": "path", + "name": "userId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns user Ok" + }, + "404": { + "description": "User not found" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "retrieve user details", + "tags": [ + "User Administration" + ] + } + }, + "/v1/user/{userId}/role": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns user role according to userId", + "operationId": "getRole", + "parameters": [ + { + "description": "userId of user to get", + "in": "path", + "name": "userId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns user role Ok" + }, + "404": { + "description": "User not found" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "retrieve user role", + "tags": [ + "User Administration" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "Update user role", + "operationId": "updateUserRole", + "parameters": [ + { + "description": "userId of user to get", + "in": "path", + "name": "userId", + "required": true, + "type": "string" + }, + { + "description": "json describe the update role", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "USER_ID", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "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" + } + }, + "summary": "update user role", + "tags": [ + "User Administration" + ] + } + }, + "/version": { + "get": { + "consumes": [ + "application/json" + ], + "description": "return the ASDC application version", + "operationId": "getSdcVersion", + "parameters": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "return ASDC version" + }, + "500": { + "description": "Internal Error" + } + }, + "summary": "return the ASDC application version", + "tags": [ + "BE Monitoring" + ] + } + } + }, + "swagger": "2.0", + "tags": [ + { + "name": "Additional Information Servlet" + }, + { + "name": "Resource Artifact Servlet" + }, + { + "name": "Resource Attribute Servlet" + }, + { + "name": "BE Monitoring" + }, + { + "name": "Resource Instance Servlet" + }, + { + "name": "Component Servlet" + }, + { + "name": "Consumer Servlet" + }, + { + "name": "Distribution Service Servlet" + }, + { + "name": "Element Servlet" + }, + { + "name": "Resource Group Servlet" + }, + { + "name": "Input Catalog" + }, + { + "name": "Lifecycle Actions Servlet" + }, + { + "name": "Product Catalog" + }, + { + "name": "Resource Property Servlet" + }, + { + "name": "Resources Catalog Upload" + }, + { + "name": "Resources Catalog" + }, + { + "name": "Service Catalog" + }, + { + "name": "Types Fetch Servlet" + }, + { + "name": "Catalog Types Upload" + }, + { + "name": "User Administration" + } + ] +} diff --git a/nokiav2/generatedapis/src/main/resources/sdc.json b/nokiav2/generatedapis/src/main/resources/sdc.json new file mode 100644 index 00000000..cd149c8b --- /dev/null +++ b/nokiav2/generatedapis/src/main/resources/sdc.json @@ -0,0 +1,8099 @@ +{ + "swagger" : "2.0", + "info" : { + "description" : "Rest API Documentation", + "version" : "v1.0, build #${buildNumber}", + "title" : "Rest API", + "termsOfService" : "http://www.github.com/kongchen/swagger-maven-plugin" + }, + "basePath" : "/onboarding-api", + "tags" : [ { + "name" : "Item Permissions" + }, { + "name" : "Validation" + }, { + "name" : "Vendor License Model - License Key Group Limits" + }, { + "name" : "Notifications" + }, { + "name" : "Vendor License Model - Entitlement Pool Limits" + }, { + "name" : "Vendor Software Product Component NICs" + }, { + "name" : "Vendor License Model - Entitlement Pools" + }, { + "name" : "Actions" + }, { + "name" : "Vendor License Model - License Agreements" + }, { + "name" : "Vendor Software Product Component Dependencies" + }, { + "name" : "Vendor Software Product Images" + }, { + "name" : "Vendor Software Product Processes" + }, { + "name" : "Vendor Software Product Networks" + }, { + "name" : "Vendor License Models" + }, { + "name" : "Vendor Software Products" + }, { + "name" : "Vendor Software Product Component Processes" + }, { + "name" : "Item Versions" + }, { + "name" : "Orchestration Template Candidate" + }, { + "name" : "Item Version Conflicts" + }, { + "name" : "Vendor Software Product deployment-flavors" + }, { + "name" : "Vendor License Model - Feature Groups" + }, { + "name" : "Vendor Software Product Component Uploads" + }, { + "name" : "Vendor Software Product Components" + }, { + "name" : "Application Configuration" + }, { + "name" : "Vendor Software Product Component Compute-flavors" + }, { + "name" : "Health Check" + }, { + "name" : "Vendor License Model - License Key Groups" + } ], + "schemes" : [ "http" ], + "paths" : { + "/v1.0/application-configuration" : { + "post" : { + "tags" : [ "Application Configuration" ], + "summary" : "Insert JSON schema into application config table", + "description" : "", + "operationId" : "insertToTable", + "consumes" : [ "multipart/form-data" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "namespace", + "in" : "query", + "required" : false, + "type" : "string" + }, { + "name" : "key", + "in" : "query", + "required" : false, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/InputStream" + } + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/application-configuration/{namespace}" : { + "get" : { + "tags" : [ "Application Configuration" ], + "summary" : "Get List of keys and values by namespace", + "description" : "", + "operationId" : "getListOfConfigurationByNamespaceFromTable", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "namespace", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/application-configuration/{namespace}/{key}" : { + "get" : { + "tags" : [ "Application Configuration" ], + "summary" : "Get JSON schema by namespace and key", + "description" : "", + "operationId" : "getFromTable", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "namespace", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "key", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConfigurationDataDto" + } + } + } + } + }, + "/v1.0/healthcheck" : { + "get" : { + "tags" : [ "Health Check" ], + "summary" : "Perform health check", + "description" : "", + "operationId" : "checkHealth", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/HealthInfoDtos" + } + } + } + } + } + }, + "/v1.0/items/{itemId}/permissions" : { + "get" : { + "tags" : [ "Item Permissions" ], + "summary" : "List users permissions assigned on item", + "description" : "", + "operationId" : "list", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "itemId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ItemPermissionsDto" + } + } + } + } + } + }, + "/v1.0/items/{itemId}/permissions/{permission}" : { + "put" : { + "tags" : [ "Item Permissions" ], + "summary" : "Update useres permission on item", + "description" : "", + "operationId" : "updatePermissions", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/ItemPermissionsRequest" + } + }, { + "name" : "itemId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "permission", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/items/{itemId}/versions" : { + "get" : { + "tags" : [ "Item Versions" ], + "summary" : "Lists item versions", + "description" : "", + "operationId" : "list", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "itemId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/VersionDto" + } + } + } + } + } + }, + "/v1.0/items/{itemId}/versions/{versionId}" : { + "get" : { + "tags" : [ "Item Versions" ], + "summary" : "Gets item version", + "description" : "", + "operationId" : "get", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "itemId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionDto" + } + } + } + }, + "post" : { + "tags" : [ "Item Versions" ], + "summary" : "Creates a new item version", + "description" : "", + "operationId" : "create", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/VersionRequestDto" + } + }, { + "name" : "itemId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/items/{itemId}/versions/{versionId}/actions" : { + "put" : { + "tags" : [ "Item Versions" ], + "summary" : "Acts on item version", + "description" : "", + "operationId" : "actOn", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/VersionActionRequestDto" + } + }, { + "name" : "itemId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/items/{itemId}/versions/{versionId}/activity-logs" : { + "get" : { + "tags" : [ "Item Versions" ], + "summary" : "Gets item version activity log", + "description" : "", + "operationId" : "getActivityLog", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "itemId", + "in" : "path", + "description" : "Item Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ActivityLogDto" + } + } + } + } + } + }, + "/v1.0/items/{itemId}/versions/{versionId}/conflicts" : { + "get" : { + "tags" : [ "Item Version Conflicts" ], + "summary" : "item version conflicts", + "description" : "Item version private copy conflicts against its public copy", + "operationId" : "getConflict", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "itemId", + "in" : "path", + "description" : "Item Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ItemVersionConflictDto" + } + } + } + } + }, + "/v1.0/items/{itemId}/versions/{versionId}/conflicts/{conflictId}" : { + "get" : { + "tags" : [ "Item Version Conflicts" ], + "summary" : "Gets item version conflict", + "description" : "Gets an item version private copy conflict against its public copy", + "operationId" : "getConflict", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "itemId", + "in" : "path", + "description" : "Item Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "conflictId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConflictDto" + } + } + } + }, + "put" : { + "tags" : [ "Item Version Conflicts" ], + "summary" : "Resolves item version conflict", + "description" : "Resolves an item version private copy conflict against its public copy", + "operationId" : "resolveConflict", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/ConflictResolutionDto" + } + }, { + "name" : "itemId", + "in" : "path", + "description" : "Item Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "conflictId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/items/{itemId}/versions/{versionId}/revisions" : { + "get" : { + "tags" : [ "Item Versions" ], + "summary" : "Gets item version revisions", + "description" : "", + "operationId" : "listRevisions", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "itemId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/RevisionDto" + } + } + } + } + } + }, + "/v1.0/notifications" : { + "get" : { + "tags" : [ "Notifications" ], + "summary" : "Retrive all user notifications", + "description" : "", + "operationId" : "getNotifications", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + }, { + "name" : "LAST_DELIVERED_EVENT_ID", + "in" : "query", + "required" : false, + "type" : "string", + "format" : "uuid" + }, { + "name" : "END_OF_PAGE_EVENT_ID", + "in" : "query", + "required" : false, + "type" : "string", + "format" : "uuid" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/NotificationsStatusDto" + } + } + } + } + } + }, + "/v1.0/notifications/last-seen/{notificationId}" : { + "put" : { + "tags" : [ "Notifications" ], + "summary" : "Update Last Seen Notification", + "description" : "", + "operationId" : "updateLastSeenNotification", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "notificationId", + "in" : "path", + "description" : "Notification Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UpdateNotificationResponseStatus" + } + } + } + } + }, + "/v1.0/notifications/worker" : { + "get" : { + "tags" : [ "Notifications" ], + "summary" : "Retrive user not delivered notifications", + "description" : "", + "operationId" : "getNewNotificationsByOwnerId", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + }, { + "name" : "LAST_DELIVERED_EVENT_ID", + "in" : "query", + "required" : false, + "type" : "string" + }, { + "name" : "NOTIFICATION_ROWS_LIMIT", + "in" : "query", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/NotificationsStatusDto" + } + } + } + } + } + }, + "/v1.0/notifications/{notificationId}" : { + "put" : { + "tags" : [ "Notifications" ], + "summary" : "Mark notification as read", + "description" : "", + "operationId" : "markAsRead", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "notificationId", + "in" : "path", + "description" : "Notification Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UpdateNotificationResponseStatus" + } + } + } + } + }, + "/v1.0/validation/{type}/validate" : { + "post" : { + "tags" : [ "Validation" ], + "summary" : "Validate a package", + "description" : "", + "operationId" : "validateFile", + "consumes" : [ "multipart/form-data" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "type", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "validate", + "in" : "formData", + "required" : false, + "type" : "file" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-license-models" : { + "get" : { + "tags" : [ "Vendor License Models" ], + "summary" : "List vendor license models", + "description" : "", + "operationId" : "listLicenseModels", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "versionFilter", + "in" : "query", + "description" : "Currently supported value: 'Certified' - only vendor License models with final versions will be return - with their latest final version", + "required" : false, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ItemDto" + } + } + } + } + }, + "post" : { + "tags" : [ "Vendor License Models" ], + "summary" : "Create vendor license model", + "description" : "", + "operationId" : "createLicenseModel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/VendorLicenseModelRequest" + } + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-license-models/{vlmId}" : { + "delete" : { + "tags" : [ "Vendor License Models" ], + "summary" : "Delete vendor license model", + "description" : "", + "operationId" : "deleteLicenseModel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}" : { + "get" : { + "tags" : [ "Vendor License Models" ], + "summary" : "Get vendor license model", + "description" : "", + "operationId" : "getLicenseModel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VendorLicenseModelEntity" + } + } + } + }, + "put" : { + "tags" : [ "Vendor License Models" ], + "summary" : "Update vendor license model", + "description" : "", + "operationId" : "updateLicenseModel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/VendorLicenseModelRequest" + } + }, { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/actions" : { + "put" : { + "tags" : [ "Vendor License Models" ], + "summary" : "Update vendor license model", + "description" : "", + "operationId" : "actOnLicenseModel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/VendorLicenseModelActionRequestDto" + } + }, { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/entitlement-pools" : { + "get" : { + "tags" : [ "Vendor License Model - Entitlement Pools" ], + "summary" : "List vendor entitlement pools", + "description" : "", + "operationId" : "listEntitlementPools", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/EntitlementPoolEntity" + } + } + } + } + }, + "post" : { + "tags" : [ "Vendor License Model - Entitlement Pools" ], + "summary" : "Create vendor entitlement pool", + "description" : "", + "operationId" : "createEntitlementPool", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/EntitlementPoolRequest" + } + }, { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/entitlement-pools/{entitlementPoolId}" : { + "get" : { + "tags" : [ "Vendor License Model - Entitlement Pools" ], + "summary" : "Get vendor entitlement pool", + "description" : "", + "operationId" : "getEntitlementPool", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "entitlementPoolId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/EntitlementPoolEntity" + } + } + } + }, + "put" : { + "tags" : [ "Vendor License Model - Entitlement Pools" ], + "summary" : "Update vendor entitlement pool", + "description" : "", + "operationId" : "updateEntitlementPool", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/EntitlementPoolRequest" + } + }, { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "entitlementPoolId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor License Model - Entitlement Pools" ], + "summary" : "Delete vendor entitlement pool", + "description" : "", + "operationId" : "deleteEntitlementPool", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "entitlementPoolId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/entitlement-pools/{entitlementPoolId}/limits" : { + "get" : { + "tags" : [ "Vendor License Model - Entitlement Pool Limits" ], + "summary" : "List vendor entitlement pool limits", + "description" : "", + "operationId" : "listLimits", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "entitlementPoolId", + "in" : "path", + "description" : "Vendor license model Entitlement Pool Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/LimitRequest" + } + } + } + } + }, + "post" : { + "tags" : [ "Vendor License Model - Entitlement Pool Limits" ], + "summary" : "Create vendor entitlement pool limits", + "description" : "", + "operationId" : "createLimit", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/LimitRequest" + } + }, { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "entitlementPoolId", + "in" : "path", + "description" : "Vendor license model Entitlement Pool Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/entitlement-pools/{entitlementPoolId}/limits/{limitId}" : { + "get" : { + "tags" : [ "Vendor License Model - Entitlement Pool Limits" ], + "summary" : "Get vendor entitlement pool limit", + "description" : "", + "operationId" : "getLimit", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "entitlementPoolId", + "in" : "path", + "description" : "Vendor license model Entitlement Pool Id", + "required" : true, + "type" : "string" + }, { + "name" : "limitId", + "in" : "path", + "description" : "Vendor license model Entitlement Pool Limit Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LimitEntityDto" + } + } + } + }, + "put" : { + "tags" : [ "Vendor License Model - Entitlement Pool Limits" ], + "summary" : "Update vendor entitlement pool limit", + "description" : "", + "operationId" : "updateLimit", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/LimitRequest" + } + }, { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "entitlementPoolId", + "in" : "path", + "description" : "Vendor license model Entitlement Pool Id", + "required" : true, + "type" : "string" + }, { + "name" : "limitId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor License Model - Entitlement Pool Limits" ], + "summary" : "Delete vendor entitlement pool limit", + "description" : "", + "operationId" : "deleteLimit", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "entitlementPoolId", + "in" : "path", + "description" : "Vendor license model Entitlement pool Id", + "required" : true, + "type" : "string" + }, { + "name" : "limitId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/feature-groups" : { + "get" : { + "tags" : [ "Vendor License Model - Feature Groups" ], + "summary" : "List vendor feature groups", + "description" : "", + "operationId" : "listFeatureGroups", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/FeatureGroupEntity" + } + } + } + } + }, + "post" : { + "tags" : [ "Vendor License Model - Feature Groups" ], + "summary" : "Create vendor feature group", + "description" : "", + "operationId" : "createFeatureGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/FeatureGroupRequest" + } + }, { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/feature-groups/{featureGroupId}" : { + "get" : { + "tags" : [ "Vendor License Model - Feature Groups" ], + "summary" : "Get vendor feature group", + "description" : "", + "operationId" : "getFeatureGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "featureGroupId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FeatureGroupModel" + } + } + } + }, + "put" : { + "tags" : [ "Vendor License Model - Feature Groups" ], + "summary" : "Update vendor feature group", + "description" : "", + "operationId" : "updateFeatureGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/FeatureGroupUpdateRequest" + } + }, { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "featureGroupId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor License Model - Feature Groups" ], + "summary" : "Delete vendor feature group", + "description" : "", + "operationId" : "deleteFeatureGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "featureGroupId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-agreements" : { + "get" : { + "tags" : [ "Vendor License Model - License Agreements" ], + "summary" : "List vendor license agreements", + "description" : "", + "operationId" : "listLicenseAgreements", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/LicenseAgreementEntity" + } + } + } + } + }, + "post" : { + "tags" : [ "Vendor License Model - License Agreements" ], + "summary" : "Create vendor license agreement", + "description" : "", + "operationId" : "createLicenseAgreement", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/LicenseAgreementRequest" + } + }, { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-agreements/{licenseAgreementId}" : { + "get" : { + "tags" : [ "Vendor License Model - License Agreements" ], + "summary" : "Get vendor license agreement", + "description" : "", + "operationId" : "getLicenseAgreement", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "licenseAgreementId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LicenseAgreementModel" + } + } + } + }, + "put" : { + "tags" : [ "Vendor License Model - License Agreements" ], + "summary" : "Update vendor license agreement", + "description" : "", + "operationId" : "updateLicenseAgreement", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/LicenseAgreementUpdateRequest" + } + }, { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "licenseAgreementId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor License Model - License Agreements" ], + "summary" : "Delete vendor license agreement", + "description" : "", + "operationId" : "deleteLicenseAgreement", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "licenseAgreementId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-key-groups" : { + "get" : { + "tags" : [ "Vendor License Model - License Key Groups" ], + "summary" : "List vendor license key groups", + "description" : "", + "operationId" : "listLicenseKeyGroups", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/LicenseKeyGroupEntityDto" + } + } + } + } + }, + "post" : { + "tags" : [ "Vendor License Model - License Key Groups" ], + "summary" : "Create vendor license key group", + "description" : "", + "operationId" : "createLicenseKeyGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/LicenseKeyGroupRequestDto" + } + }, { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-key-groups/{licenseKeyGroupId}" : { + "get" : { + "tags" : [ "Vendor License Model - License Key Groups" ], + "summary" : "Get vendor license key group", + "description" : "", + "operationId" : "getLicenseKeyGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "licenseKeyGroupId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LicenseKeyGroupEntityDto" + } + } + } + }, + "put" : { + "tags" : [ "Vendor License Model - License Key Groups" ], + "summary" : "Update vendor license key group", + "description" : "", + "operationId" : "updateLicenseKeyGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/LicenseKeyGroupRequestDto" + } + }, { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "licenseKeyGroupId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor License Model - License Key Groups" ], + "summary" : "Delete vendor license key group", + "description" : "", + "operationId" : "deleteLicenseKeyGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "licenseKeyGroupId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-key-groups/{licenseKeyGroupId}/limits" : { + "get" : { + "tags" : [ "Vendor License Model - License Key Group Limits" ], + "summary" : "List vendor license key group limits", + "description" : "", + "operationId" : "listLimits", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "licenseKeyGroupId", + "in" : "path", + "description" : "Vendor license model License Key Group Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/LimitEntityDto" + } + } + } + } + }, + "post" : { + "tags" : [ "Vendor License Model - License Key Group Limits" ], + "summary" : "Create vendor license key group limit", + "description" : "", + "operationId" : "createLimit", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/LimitRequest" + } + }, { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "licenseKeyGroupId", + "in" : "path", + "description" : "Vendor license model License Key Group Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-key-groups/{licenseKeyGroupId}/limits/{limitId}" : { + "get" : { + "tags" : [ "Vendor License Model - License Key Group Limits" ], + "summary" : "Get vendor entitlement pool limit", + "description" : "", + "operationId" : "getLimit", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "licenseKeyGroupId", + "in" : "path", + "description" : "Vendor license model License Key Group", + "required" : true, + "type" : "string" + }, { + "name" : "limitId", + "in" : "path", + "description" : "Vendor license model License Key Group Limit Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LimitEntityDto" + } + } + } + }, + "put" : { + "tags" : [ "Vendor License Model - License Key Group Limits" ], + "summary" : "Update vendor license key group limit", + "description" : "", + "operationId" : "updateLimit", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/LimitRequest" + } + }, { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "licenseKeyGroupId", + "in" : "path", + "description" : "Vendor license model License Key Group Id", + "required" : true, + "type" : "string" + }, { + "name" : "limitId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor License Model - License Key Group Limits" ], + "summary" : "Delete vendor license key group limit", + "description" : "", + "operationId" : "deleteLimit", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vlmId", + "in" : "path", + "description" : "Vendor license model Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor license model version Id", + "required" : true, + "type" : "string" + }, { + "name" : "licenseKeyGroupId", + "in" : "path", + "description" : "Vendor license model license key group Id", + "required" : true, + "type" : "string" + }, { + "name" : "limitId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products" : { + "get" : { + "tags" : [ "Vendor Software Products" ], + "summary" : "Get list of vendor software products and their description", + "description" : "", + "operationId" : "listVsps", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "versionFilter", + "in" : "query", + "description" : "Currently supported values: 'Certified' - only vendor software products with final version will be return - with their latest final version", + "required" : false, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "post" : { + "tags" : [ "Vendor Software Products" ], + "summary" : "Create a new vendor software product", + "description" : "", + "operationId" : "createVsp", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/VspRequestDto" + } + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ItemCreationDto" + } + } + } + } + }, + "/v1.0/vendor-software-products/packages" : { + "get" : { + "tags" : [ "Vendor Software Products" ], + "summary" : "Get list of translated CSAR files details", + "description" : "", + "operationId" : "listPackages", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "category", + "in" : "query", + "description" : "Category", + "required" : false, + "type" : "string" + }, { + "name" : "subCategory", + "in" : "query", + "description" : "Sub-category", + "required" : false, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/PackageInfoDto" + } + } + } + } + } + }, + "/v1.0/vendor-software-products/packages/{vspId}" : { + "get" : { + "tags" : [ "Vendor Software Products" ], + "summary" : "Get translated CSAR file", + "description" : "Exports translated file to a zip file", + "operationId" : "getTranslatedFile", + "consumes" : [ "application/json" ], + "produces" : [ "application/octet-stream" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "query", + "required" : false, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/File" + } + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}" : { + "delete" : { + "tags" : [ "Vendor Software Products" ], + "summary" : "Deletes vendor software product by given id", + "description" : "", + "operationId" : "deleteVsp", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}" : { + "get" : { + "tags" : [ "Vendor Software Products" ], + "summary" : "Get details of a vendor software product", + "description" : "", + "operationId" : "getVsp", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "put" : { + "tags" : [ "Vendor Software Products" ], + "summary" : "Update an existing vendor software product", + "description" : "", + "operationId" : "updateVsp", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/VspDescriptionDto" + } + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/actions" : { + "put" : { + "tags" : [ "Vendor Software Products" ], + "summary" : "Actions on a vendor software product", + "description" : "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.|", + "operationId" : "actOnVendorSoftwareProduct", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/VersionSoftwareProductActionRequestDto" + } + }, { + "name" : "vspId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/component-dependencies" : { + "get" : { + "tags" : [ "Vendor Software Product Component Dependencies" ], + "summary" : "Get component dependencies for vendor software product", + "description" : "", + "operationId" : "list", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ComponentDependencyResponseDto" + } + } + } + } + }, + "post" : { + "tags" : [ "Vendor Software Product Component Dependencies" ], + "summary" : "Create a vendor software product component dependency", + "description" : "", + "operationId" : "create", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/ComponentDependencyModel" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/component-dependencies/{dependencyId}" : { + "get" : { + "tags" : [ "Vendor Software Product Component Dependencies" ], + "summary" : "Get component dependency for vendor software product", + "description" : "", + "operationId" : "get", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "dependencyId", + "in" : "path", + "description" : "Vendor software product Component Dependency Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentDependencyResponseDto" + } + } + } + }, + "put" : { + "tags" : [ "Vendor Software Product Component Dependencies" ], + "summary" : "Update component dependency for vendor software product", + "description" : "", + "operationId" : "update", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/ComponentDependencyModel" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "dependencyId", + "in" : "path", + "description" : "Vendor software product Component Dependency Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor Software Product Component Dependencies" ], + "summary" : "Delete component dependency for vendor software product", + "description" : "", + "operationId" : "delete", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "dependencyId", + "in" : "path", + "description" : "Vendor software product Component Dependency Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components" : { + "get" : { + "tags" : [ "Vendor Software Product Components" ], + "summary" : "List vendor software product components", + "description" : "", + "operationId" : "list", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ComponentDto" + } + } + } + } + }, + "post" : { + "tags" : [ "Vendor Software Product Components" ], + "summary" : "Create a vendor software product component", + "description" : "", + "operationId" : "create", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/ComponentRequestDto" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor Software Product Components" ], + "summary" : "Delete vendor software product components", + "description" : "", + "operationId" : "deleteList", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}" : { + "get" : { + "tags" : [ "Vendor Software Product Components" ], + "summary" : "Get vendor software product component", + "description" : "", + "operationId" : "get", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentData" + } + } + } + }, + "put" : { + "tags" : [ "Vendor Software Product Components" ], + "summary" : "Update vendor software product component", + "description" : "", + "operationId" : "update", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/ComponentRequestDto" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor Software Product Components" ], + "summary" : "Delete vendor software product component", + "description" : "", + "operationId" : "delete", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/compute-flavors" : { + "get" : { + "tags" : [ "Vendor Software Product Component Compute-flavors" ], + "summary" : "Get list of vendor software product component compute-flavors", + "description" : "", + "operationId" : "list", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ComputeDto" + } + } + } + } + }, + "post" : { + "tags" : [ "Vendor Software Product Component Compute-flavors" ], + "summary" : "Create a vendor software product component compute-flavor", + "description" : "", + "operationId" : "create", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/ComputeDetailsDto" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/compute-flavors/{computeFlavorId}" : { + "get" : { + "tags" : [ "Vendor Software Product Component Compute-flavors" ], + "summary" : "Get vendor software product component compute-flavor", + "description" : "", + "operationId" : "get", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "computeFlavorId", + "in" : "path", + "description" : "Vendor software product compute-flavor Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComputeDetailsDto" + } + } + } + }, + "put" : { + "tags" : [ "Vendor Software Product Component Compute-flavors" ], + "summary" : "Update vendor software product component compute-flavor", + "description" : "", + "operationId" : "update", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/ComputeDetailsDto" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "computeFlavorId", + "in" : "path", + "description" : "Vendor software product compute-flavor Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor Software Product Component Compute-flavors" ], + "summary" : "Delete vendor software product component compute-flavor", + "description" : "", + "operationId" : "delete", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "computeFlavorId", + "in" : "path", + "description" : "Vendor software product compute-flavor Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/compute-flavors/{computeFlavorId}/questionnaire" : { + "get" : { + "tags" : [ "Vendor Software Product Component Compute-flavors" ], + "summary" : "Get vendor software product component compute-flavor questionnaire", + "description" : "", + "operationId" : "getQuestionnaire", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "computeFlavorId", + "in" : "path", + "description" : "Vendor software product compute-flavor Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/QuestionnaireResponseDto" + } + } + } + }, + "put" : { + "tags" : [ "Vendor Software Product Component Compute-flavors" ], + "summary" : "Update vendor software product component compute-flavor questionnaire", + "description" : "", + "operationId" : "updateQuestionnaire", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "computeFlavorId", + "in" : "path", + "description" : "Vendor software product compute-flavor Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/images" : { + "get" : { + "tags" : [ "Vendor Software Product Images" ], + "summary" : "List vendor software product component images", + "description" : "", + "operationId" : "list", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ImageDto" + } + } + } + } + }, + "post" : { + "tags" : [ "Vendor Software Product Images" ], + "summary" : "Create a vendor software product component image", + "description" : "", + "operationId" : "create", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/ImageRequestDto" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/images/{imageId}" : { + "get" : { + "tags" : [ "Vendor Software Product Images" ], + "summary" : "Get vendor software product component Image", + "description" : "", + "operationId" : "get", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "imageId", + "in" : "path", + "description" : "Vendor software product Image Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ImageDto" + } + } + } + }, + "put" : { + "tags" : [ "Vendor Software Product Images" ], + "summary" : "Update vendor software product Image", + "description" : "", + "operationId" : "update", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/ImageRequestDto" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "imageId", + "in" : "path", + "description" : "Vendor software product Image Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor Software Product Images" ], + "summary" : "Delete vendor software product Image", + "description" : "", + "operationId" : "delete", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "imageId", + "in" : "path", + "description" : "Vendor software product Image Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/images/{imageId}/questionnaire" : { + "get" : { + "tags" : [ "Vendor Software Product Images" ], + "summary" : "Get vendor software product component image questionnaire", + "description" : "", + "operationId" : "getQuestionnaire", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "imageId", + "in" : "path", + "description" : "Vendor software product image Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/QuestionnaireResponseDto" + } + } + } + }, + "put" : { + "tags" : [ "Vendor Software Product Images" ], + "summary" : "Update vendor software product component image questionnaire", + "description" : "", + "operationId" : "updateQuestionnaire", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "imageId", + "in" : "path", + "description" : "Vendor software product image Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/nics" : { + "get" : { + "tags" : [ "Vendor Software Product Component NICs" ], + "summary" : "List vendor software product component NICs", + "description" : "", + "operationId" : "list", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/NicDto" + } + } + } + } + }, + "post" : { + "tags" : [ "Vendor Software Product Component NICs" ], + "summary" : "Create a vendor software product NIC", + "description" : "", + "operationId" : "create", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/NicRequestDto" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/nics/{nicId}" : { + "get" : { + "tags" : [ "Vendor Software Product Component NICs" ], + "summary" : "Get vendor software product NIC", + "description" : "", + "operationId" : "get", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "nicId", + "in" : "path", + "description" : "Vendor software product NIC Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/NicDto" + } + } + } + }, + "put" : { + "tags" : [ "Vendor Software Product Component NICs" ], + "summary" : "Update vendor software product NIC", + "description" : "", + "operationId" : "update", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/NicRequestDto" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "nicId", + "in" : "path", + "description" : "Vendor software product NIC Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor Software Product Component NICs" ], + "summary" : "Delete vendor software product NIC", + "description" : "", + "operationId" : "delete", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "nicId", + "in" : "path", + "description" : "Vendor software product NIC Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/nics/{nicId}/questionnaire" : { + "get" : { + "tags" : [ "Vendor Software Product Component NICs" ], + "summary" : "Get vendor software product component NIC questionnaire", + "description" : "", + "operationId" : "getQuestionnaire", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "nicId", + "in" : "path", + "description" : "Vendor software product NIC Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/QuestionnaireResponseDto" + } + } + } + }, + "put" : { + "tags" : [ "Vendor Software Product Component NICs" ], + "summary" : "Update vendor software product component NIC questionnaire", + "description" : "", + "operationId" : "updateQuestionnaire", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "nicId", + "in" : "path", + "description" : "Vendor software product NIC Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/processes" : { + "get" : { + "tags" : [ "Vendor Software Product Component Processes" ], + "summary" : "List vendor software product component processes", + "description" : "", + "operationId" : "list", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ProcessEntityDto" + } + } + } + } + }, + "post" : { + "tags" : [ "Vendor Software Product Component Processes" ], + "summary" : "Create a vendor software product process", + "description" : "", + "operationId" : "create", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/ProcessRequestDto" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor Software Product Component Processes" ], + "summary" : "Delete vendor software product processes", + "description" : "", + "operationId" : "deleteList", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/processes/{processId}" : { + "get" : { + "tags" : [ "Vendor Software Product Component Processes" ], + "summary" : "Get vendor software product process", + "description" : "", + "operationId" : "get", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "processId", + "in" : "path", + "description" : "Vendor software product process Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessEntityDto" + } + } + } + }, + "put" : { + "tags" : [ "Vendor Software Product Component Processes" ], + "summary" : "Update vendor software product process", + "description" : "", + "operationId" : "update", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/ProcessRequestDto" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "processId", + "in" : "path", + "description" : "Vendor software product process Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor Software Product Component Processes" ], + "summary" : "Delete vendor software product process", + "description" : "", + "operationId" : "delete", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "processId", + "in" : "path", + "description" : "Vendor software product process Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/processes/{processId}/upload" : { + "get" : { + "tags" : [ "Vendor Software Product Component Processes" ], + "summary" : "Get vendor software product process uploaded file", + "description" : "", + "operationId" : "getUploadedFile", + "consumes" : [ "application/json" ], + "produces" : [ "application/octet-stream" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "processId", + "in" : "path", + "description" : "Vendor software product process Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "post" : { + "tags" : [ "Vendor Software Product Component Processes" ], + "summary" : "Update vendor software product process upload", + "description" : "", + "operationId" : "uploadFile", + "consumes" : [ "multipart/form-data" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/Attachment" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "processId", + "in" : "path", + "description" : "Vendor software product process Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor Software Product Component Processes" ], + "summary" : "Delete vendor software product process uploaded file", + "description" : "", + "operationId" : "deleteUploadedFile", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "processId", + "in" : "path", + "description" : "Vendor software product process Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/questionnaire" : { + "get" : { + "tags" : [ "Vendor Software Product Components" ], + "summary" : "Get vendor software product component questionnaire", + "description" : "", + "operationId" : "getQuestionnaire", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/QuestionnaireResponseDto" + } + } + } + }, + "put" : { + "tags" : [ "Vendor Software Product Components" ], + "summary" : "Update vendor software product component questionnaire", + "description" : "", + "operationId" : "updateQuestionnaire", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/uploads" : { + "get" : { + "tags" : [ "Vendor Software Product Component Uploads" ], + "summary" : "Get the filenames of uploaded files by type", + "description" : "", + "operationId" : "list", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Vendor software product component Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/MonitoringUploadStatusDto" + } + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/uploads/types/{type}" : { + "post" : { + "tags" : [ "Vendor Software Product Component Uploads" ], + "summary" : "Upload file for component by type", + "description" : "", + "operationId" : "upload", + "consumes" : [ "multipart/form-data" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/Attachment" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Component Id", + "required" : true, + "type" : "string" + }, { + "name" : "type", + "in" : "path", + "description" : "Upload Type", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor Software Product Component Uploads" ], + "summary" : "Delete file uploaded for component", + "description" : "", + "operationId" : "delete", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "componentId", + "in" : "path", + "description" : "Component Id", + "required" : true, + "type" : "string" + }, { + "name" : "type", + "in" : "path", + "description" : "Upload Type", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/compute-flavors" : { + "get" : { + "tags" : [ "Vendor Software Products" ], + "summary" : "Get list of vendor software product compute-flavors", + "description" : "", + "operationId" : "listComputes", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/VspComputeDto" + } + } + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/deployment-flavors" : { + "get" : { + "tags" : [ "Vendor Software Product deployment-flavors" ], + "summary" : "List vendor software product Deployment Flavor", + "description" : "", + "operationId" : "list", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/DeploymentFlavorListResponseDto" + } + } + } + } + }, + "post" : { + "tags" : [ "Vendor Software Product deployment-flavors" ], + "summary" : "Create a vendor software product Deployment Flavor", + "description" : "", + "operationId" : "create", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/DeploymentFlavorRequestDto" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/deployment-flavors/{deploymentFlavorId}" : { + "get" : { + "tags" : [ "Vendor Software Product deployment-flavors" ], + "summary" : "Get vendor software product Deployment Flavor", + "description" : "", + "operationId" : "get", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "deploymentFlavorId", + "in" : "path", + "description" : "Vendor software product Deployment Flavor Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DeploymentFlavorDto" + } + } + } + }, + "put" : { + "tags" : [ "Vendor Software Product deployment-flavors" ], + "summary" : "Update vendor software product Deployment Flavor", + "description" : "", + "operationId" : "update", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/DeploymentFlavorRequestDto" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "deploymentFlavorId", + "in" : "path", + "description" : "Vendor software product Deployment Flavor Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor Software Product deployment-flavors" ], + "summary" : "Delete vendor software product Deployment Flavor", + "description" : "", + "operationId" : "delete", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "deploymentFlavorId", + "in" : "path", + "description" : "Vendor software product Deployment Flavor Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/heal" : { + "put" : { + "tags" : [ "Vendor Software Products" ], + "summary" : "Checkout and heal vendor software product questionnaire", + "description" : "", + "operationId" : "heal", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/QuestionnaireResponseDto" + } + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/networks" : { + "get" : { + "tags" : [ "Vendor Software Product Networks" ], + "summary" : "List vendor software product networks", + "description" : "", + "operationId" : "list", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/NetworkDto" + } + } + } + } + }, + "post" : { + "tags" : [ "Vendor Software Product Networks" ], + "summary" : "Create a vendor software product network", + "description" : "", + "operationId" : "create", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/NetworkRequestDto" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/networks/{networkId}" : { + "get" : { + "tags" : [ "Vendor Software Product Networks" ], + "summary" : "Get vendor software product network", + "description" : "", + "operationId" : "get", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "networkId", + "in" : "path", + "description" : "Vendor software product network Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/NetworkDto" + } + } + } + }, + "put" : { + "tags" : [ "Vendor Software Product Networks" ], + "summary" : "Update vendor software product network", + "description" : "", + "operationId" : "update", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/NetworkRequestDto" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "networkId", + "in" : "path", + "description" : "Vendor software product network Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor Software Product Networks" ], + "summary" : "Delete vendor software product network", + "description" : "", + "operationId" : "delete", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "networkId", + "in" : "path", + "description" : "Vendor software product network Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template" : { + "get" : { + "tags" : [ "Vendor Software Products" ], + "summary" : "Get Orchestration Template (HEAT) file", + "description" : "Downloads the latest HEAT package", + "operationId" : "getOrchestrationTemplate", + "consumes" : [ "application/json" ], + "produces" : [ "application/octet-stream" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/File" + } + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template-candidate" : { + "get" : { + "tags" : [ "Orchestration Template Candidate" ], + "summary" : "Get uploaded candidate HEAT file", + "description" : "Downloads in process candidate HEAT file", + "operationId" : "get", + "consumes" : [ "application/json" ], + "produces" : [ "application/octet-stream" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/File" + } + } + } + }, + "post" : { + "tags" : [ "Vendor Software Products" ], + "summary" : "Uploads a HEAT package to translate", + "description" : "", + "operationId" : "uploadOrchestrationTemplateCandidate", + "consumes" : [ "multipart/form-data" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "upload", + "in" : "formData", + "required" : false, + "type" : "file" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UploadFileResponseDto" + } + } + } + }, + "delete" : { + "tags" : [ "Orchestration Template Candidate" ], + "summary" : "Delete orchestration template candidate file and its files data structure", + "description" : "", + "operationId" : "abort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template-candidate/manifest" : { + "get" : { + "tags" : [ "Orchestration Template Candidate" ], + "summary" : "Get uploaded HEAT file files data structure", + "description" : "Downloads the latest HEAT package", + "operationId" : "getFilesDataStructure", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FileDataStructureDto" + } + } + } + }, + "put" : { + "tags" : [ "Orchestration Template Candidate" ], + "summary" : "Update an existing vendor software product", + "description" : "", + "operationId" : "updateFilesDataStructure", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/FileDataStructureDto" + } + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template-candidate/process" : { + "put" : { + "tags" : [ "Orchestration Template Candidate" ], + "summary" : "process Orchestration Template Candidate", + "description" : "", + "operationId" : "process", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UploadFileResponseDto" + } + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/processes" : { + "get" : { + "tags" : [ "Vendor Software Product Processes" ], + "summary" : "List vendor software product processes", + "description" : "", + "operationId" : "list", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ProcessEntityDto" + } + } + } + } + }, + "post" : { + "tags" : [ "Vendor Software Product Processes" ], + "summary" : "Create a vendor software product process", + "description" : "", + "operationId" : "create", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/ProcessRequestDto" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor Software Product Processes" ], + "summary" : "Delete vendor software product processes", + "description" : "", + "operationId" : "deleteList", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/processes/{processId}" : { + "get" : { + "tags" : [ "Vendor Software Product Processes" ], + "summary" : "Get vendor software product process", + "description" : "", + "operationId" : "get", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "processId", + "in" : "path", + "description" : "Vendor software product process Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessEntityDto" + } + } + } + }, + "put" : { + "tags" : [ "Vendor Software Product Processes" ], + "summary" : "Update vendor software product process", + "description" : "", + "operationId" : "update", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/ProcessRequestDto" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "processId", + "in" : "path", + "description" : "Vendor software product process Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor Software Product Processes" ], + "summary" : "Delete vendor software product process", + "description" : "", + "operationId" : "delete", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "processId", + "in" : "path", + "description" : "Vendor software product process Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/processes/{processId}/upload" : { + "get" : { + "tags" : [ "Vendor Software Product Processes" ], + "summary" : "Get vendor software product process uploaded file", + "description" : "", + "operationId" : "getUploadedFile", + "consumes" : [ "application/json" ], + "produces" : [ "application/octet-stream" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "processId", + "in" : "path", + "description" : "Vendor software product process Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "post" : { + "tags" : [ "Vendor Software Product Processes" ], + "summary" : "Update vendor software product process upload", + "description" : "", + "operationId" : "uploadFile", + "consumes" : [ "multipart/form-data" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/Attachment" + } + }, { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "processId", + "in" : "path", + "description" : "Vendor software product process Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Vendor Software Product Processes" ], + "summary" : "Delete vendor software product process uploaded file", + "description" : "", + "operationId" : "deleteUploadedFile", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "description" : "Vendor software product Id", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "description" : "Vendor software product version Id", + "required" : true, + "type" : "string" + }, { + "name" : "processId", + "in" : "path", + "description" : "Vendor software product process Id", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/questionnaire" : { + "get" : { + "tags" : [ "Vendor Software Products" ], + "summary" : "Get vendor software product questionnaire", + "description" : "", + "operationId" : "getQuestionnaire", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/QuestionnaireResponseDto" + } + } + } + }, + "put" : { + "tags" : [ "Vendor Software Products" ], + "summary" : "Update vendor software product questionnaire", + "description" : "", + "operationId" : "updateQuestionnaire", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "vspId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/vspInformationArtifact" : { + "get" : { + "tags" : [ "Vendor Software Products" ], + "summary" : "Get vendor software product information artifact for specified version", + "description" : "", + "operationId" : "getVspInformationArtifact", + "consumes" : [ "application/json" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "name" : "vspId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "versionId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "USER_ID", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/File" + } + } + } + } + }, + "/workflow/v1.0/actions" : { + "get" : { + "tags" : [ "Actions" ], + "summary" : "List Filtered Actions ", + "description" : "Get list of actions based on a filter criteria | If no filter is sent all actions will be returned", + "operationId" : "getFilteredActions", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "vendor", + "in" : "query", + "required" : false, + "type" : "string" + }, { + "name" : "category", + "in" : "query", + "required" : false, + "type" : "string" + }, { + "name" : "name", + "in" : "query", + "required" : false, + "type" : "string" + }, { + "name" : "modelId", + "in" : "query", + "required" : false, + "type" : "string" + }, { + "name" : "componentId", + "in" : "query", + "required" : false, + "type" : "string" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "post" : { + "tags" : [ "Actions" ], + "summary" : "Create a new Action", + "description" : "", + "operationId" : "createAction", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/workflow/v1.0/actions/components" : { + "get" : { + "tags" : [ "Actions" ], + "summary" : "List OPENECOMP Components supported by Action Library", + "description" : "", + "operationId" : "getOpenEcompComponents", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/workflow/v1.0/actions/{actionInvariantUuId}" : { + "get" : { + "tags" : [ "Actions" ], + "summary" : "List Actions For Given Action Invariant UuId", + "description" : "", + "operationId" : "getActionsByActionInvariantUuId", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "actionInvariantUuId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "query", + "required" : false, + "type" : "string" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "post" : { + "tags" : [ "Actions" ], + "summary" : "Actions on a action", + "description" : "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.|", + "operationId" : "actOnAction", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "actionInvariantUuId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "put" : { + "tags" : [ "Actions" ], + "summary" : "Update an existing action", + "description" : "", + "operationId" : "updateAction", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "actionInvariantUuId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Actions" ], + "summary" : "Delete Action", + "description" : "", + "operationId" : "deleteAction", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "actionInvariantUuId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/workflow/v1.0/actions/{actionInvariantUuId}/artifacts" : { + "post" : { + "tags" : [ "Actions" ], + "summary" : "Upload new Artifact", + "description" : "", + "operationId" : "uploadArtifact", + "consumes" : [ "multipart/form-data" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "actionInvariantUuId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + }, { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + }, { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + }, { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + }, { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "Content-MD5", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + }, { + "name" : "uploadArtifact", + "in" : "formData", + "required" : false, + "type" : "file" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/workflow/v1.0/actions/{actionInvariantUuId}/artifacts/{artifactUuId}" : { + "put" : { + "tags" : [ "Actions" ], + "summary" : "Update an existing artifact", + "description" : "", + "operationId" : "updateArtifact", + "consumes" : [ "multipart/form-data" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "actionInvariantUuId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "artifactUuId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + }, { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + }, { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + }, { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + }, { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "Content-MD5", + "in" : "header", + "required" : false, + "type" : "string", + "default" : "" + }, { + "name" : "updateArtifact", + "in" : "formData", + "required" : false, + "type" : "file" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + }, + "delete" : { + "tags" : [ "Actions" ], + "summary" : "Delete Artifact", + "description" : "", + "operationId" : "deleteArtifact", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "actionInvariantUuId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "artifactUuId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/workflow/v1.0/actions/{actionUuId}/artifacts/{artifactUuId}" : { + "get" : { + "tags" : [ "Actions" ], + "summary" : "Downloads artifact for action", + "description" : "", + "operationId" : "downloadArtifact", + "consumes" : [ "application/json" ], + "produces" : [ "application/octet-stream" ], + "parameters" : [ { + "name" : "actionUuId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "artifactUuId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + } + }, + "definitions" : { + "ActivityLogDto" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time" + }, + "type" : { + "type" : "string" + }, + "comment" : { + "type" : "string" + }, + "user" : { + "type" : "string" + }, + "status" : { + "$ref" : "#/definitions/ActivityStatus" + } + } + }, + "ActivityStatus" : { + "type" : "object", + "properties" : { + "success" : { + "type" : "boolean", + "default" : false + }, + "message" : { + "type" : "string" + } + } + }, + "Attachment" : { + "type" : "object", + "properties" : { + "headers" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, + "object" : { + "type" : "object" + }, + "contentType" : { + "$ref" : "#/definitions/MediaType" + }, + "contentDisposition" : { + "$ref" : "#/definitions/ContentDisposition" + }, + "dataHandler" : { + "$ref" : "#/definitions/DataHandler" + }, + "contentId" : { + "type" : "string" + } + } + }, + "ChoiceOrOtherDtoLicenseTerm" : { + "type" : "object", + "required" : [ "choice", "other" ], + "properties" : { + "choice" : { + "type" : "string", + "enum" : [ "Fixed_Term", "Perpetual", "Unlimited", "Other" ] + }, + "other" : { + "type" : "string" + } + } + }, + "CommandInfo" : { + "type" : "object", + "properties" : { + "commandName" : { + "type" : "string" + }, + "commandClass" : { + "type" : "string" + } + } + }, + "CommitRequestDto" : { + "type" : "object", + "properties" : { + "message" : { + "type" : "string" + } + } + }, + "ComponentComputeAssociation" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string" + }, + "computeFlavorId" : { + "type" : "string" + } + } + }, + "ComponentData" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "vfcCode" : { + "type" : "string" + }, + "nfcCode" : { + "type" : "string" + }, + "nfcFunction" : { + "type" : "string" + } + } + }, + "ComponentDependencyModel" : { + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string" + }, + "targetId" : { + "type" : "string" + }, + "relationType" : { + "type" : "string" + } + } + }, + "ComponentDependencyResponseDto" : { + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string" + }, + "targetId" : { + "type" : "string" + }, + "relationType" : { + "type" : "string" + }, + "id" : { + "type" : "string" + } + } + }, + "ComponentDto" : { + "type" : "object", + "required" : [ "displayName" ], + "properties" : { + "name" : { + "type" : "string" + }, + "displayName" : { + "type" : "string", + "minLength" : 1, + "maxLength" : 30 + }, + "vfcCode" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "nfcCode" : { + "type" : "string" + }, + "nfcFunction" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "id" : { + "type" : "string" + } + } + }, + "ComponentRequestDto" : { + "type" : "object", + "required" : [ "displayName" ], + "properties" : { + "name" : { + "type" : "string" + }, + "displayName" : { + "type" : "string", + "minLength" : 1, + "maxLength" : 30 + }, + "vfcCode" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "nfcCode" : { + "type" : "string" + }, + "nfcFunction" : { + "type" : "string" + }, + "description" : { + "type" : "string" + } + } + }, + "ComputeDetailsDto" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 30 + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 300 + } + } + }, + "ComputeDto" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "associatedToDeploymentFlavor" : { + "type" : "boolean", + "default" : false + } + } + }, + "ConfigurationDataDto" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string" + }, + "timeStamp" : { + "type" : "integer", + "format" : "int64" + } + } + }, + "ConflictDto" : { + "type" : "object", + "properties" : { + "id" : { + "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", "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" ] + }, + "name" : { + "type" : "string" + }, + "yours" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "theirs" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + } + } + }, + "ConflictInfoDto" : { + "type" : "object", + "properties" : { + "id" : { + "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", "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" ] + }, + "name" : { + "type" : "string" + } + } + }, + "ConflictResolutionDto" : { + "type" : "object", + "properties" : { + "resolution" : { + "type" : "string", + "enum" : [ "THEIRS", "YOURS", "OTHER" ] + }, + "otherResolution" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + } + } + }, + "ContentDisposition" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string" + }, + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "filename" : { + "type" : "string" + } + } + }, + "DataFlavor" : { + "type" : "object", + "properties" : { + "mimeType" : { + "type" : "string" + }, + "humanPresentableName" : { + "type" : "string" + }, + "subType" : { + "type" : "string" + }, + "primaryType" : { + "type" : "string" + }, + "mimeTypeSerializedObject" : { + "type" : "boolean", + "default" : false + }, + "defaultRepresentationClassAsString" : { + "type" : "string" + }, + "representationClassInputStream" : { + "type" : "boolean", + "default" : false + }, + "representationClassReader" : { + "type" : "boolean", + "default" : false + }, + "representationClassCharBuffer" : { + "type" : "boolean", + "default" : false + }, + "representationClassByteBuffer" : { + "type" : "boolean", + "default" : false + }, + "representationClassSerializable" : { + "type" : "boolean", + "default" : false + }, + "representationClassRemote" : { + "type" : "boolean", + "default" : false + }, + "flavorSerializedObjectType" : { + "type" : "boolean", + "default" : false + }, + "flavorRemoteObjectType" : { + "type" : "boolean", + "default" : false + }, + "flavorJavaFileListType" : { + "type" : "boolean", + "default" : false + }, + "flavorTextType" : { + "type" : "boolean", + "default" : false + } + } + }, + "DataHandler" : { + "type" : "object", + "properties" : { + "dataSource" : { + "$ref" : "#/definitions/DataSource" + }, + "name" : { + "type" : "string" + }, + "inputStream" : { + "$ref" : "#/definitions/InputStream" + }, + "content" : { + "type" : "object" + }, + "contentType" : { + "type" : "string" + }, + "outputStream" : { + "$ref" : "#/definitions/OutputStream" + }, + "transferDataFlavors" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/DataFlavor" + } + }, + "preferredCommands" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/CommandInfo" + } + }, + "allCommands" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/CommandInfo" + } + } + } + }, + "DataSource" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "inputStream" : { + "$ref" : "#/definitions/InputStream" + }, + "contentType" : { + "type" : "string" + }, + "outputStream" : { + "$ref" : "#/definitions/OutputStream" + } + } + }, + "DeploymentFlavorDto" : { + "type" : "object", + "properties" : { + "model" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 30 + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 300 + }, + "featureGroupId" : { + "type" : "string" + }, + "componentComputeAssociations" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ComponentComputeAssociation" + } + }, + "id" : { + "type" : "string" + } + } + }, + "DeploymentFlavorListResponseDto" : { + "type" : "object", + "properties" : { + "model" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "id" : { + "type" : "string" + } + } + }, + "DeploymentFlavorRequestDto" : { + "type" : "object", + "properties" : { + "model" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 30 + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 300 + }, + "featureGroupId" : { + "type" : "string" + }, + "componentComputeAssociations" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ComponentComputeAssociation" + } + } + } + }, + "EntitlementPoolEntity" : { + "type" : "object", + "required" : [ "name" ], + "properties" : { + "name" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 120 + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "thresholdValue" : { + "type" : "integer", + "format" : "int32" + }, + "thresholdUnits" : { + "type" : "string", + "enum" : [ "Absolute", "Percentage" ] + }, + "increments" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 120 + }, + "operationalScope" : { + "$ref" : "#/definitions/MultiChoiceOrOtherDtoOperationalScope" + }, + "startDate" : { + "type" : "string" + }, + "expiryDate" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "referencingFeatureGroups" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "EntitlementPoolRequest" : { + "type" : "object", + "required" : [ "name" ], + "properties" : { + "name" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 120 + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "thresholdValue" : { + "type" : "integer", + "format" : "int32" + }, + "thresholdUnits" : { + "type" : "string", + "enum" : [ "Absolute", "Percentage" ] + }, + "increments" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 120 + }, + "operationalScope" : { + "$ref" : "#/definitions/MultiChoiceOrOtherDtoOperationalScope" + }, + "startDate" : { + "type" : "string" + }, + "expiryDate" : { + "type" : "string" + } + } + }, + "ErrorMessage" : { + "type" : "object", + "properties" : { + "level" : { + "type" : "string", + "enum" : [ "ERROR", "WARNING", "INFO" ] + }, + "message" : { + "type" : "string" + } + } + }, + "FeatureGroupEntity" : { + "type" : "object", + "required" : [ "name", "partNumber" ], + "properties" : { + "name" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 120 + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "partNumber" : { + "type" : "string" + }, + "manufacturerReferenceNumber" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 100 + }, + "id" : { + "type" : "string" + }, + "licenseKeyGroupsIds" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "entitlementPoolsIds" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "referencingLicenseAgreements" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "FeatureGroupModel" : { + "type" : "object", + "required" : [ "name", "partNumber" ], + "properties" : { + "name" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 120 + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "partNumber" : { + "type" : "string" + }, + "manufacturerReferenceNumber" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 100 + }, + "id" : { + "type" : "string" + }, + "referencingLicenseAgreements" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "licenseKeyGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/LicenseKeyGroupEntityDto" + } + }, + "entitlementPools" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/EntitlementPoolEntity" + } + } + } + }, + "FeatureGroupRequest" : { + "type" : "object", + "required" : [ "name", "partNumber" ], + "properties" : { + "name" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 120 + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "partNumber" : { + "type" : "string" + }, + "manufacturerReferenceNumber" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 100 + }, + "addedLicenseKeyGroupsIds" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "addedEntitlementPoolsIds" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "FeatureGroupUpdateRequest" : { + "type" : "object", + "required" : [ "name", "partNumber" ], + "properties" : { + "name" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 120 + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "partNumber" : { + "type" : "string" + }, + "manufacturerReferenceNumber" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 100 + }, + "addedLicenseKeyGroupsIds" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "addedEntitlementPoolsIds" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "removedLicenseKeyGroupsIds" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "removedEntitlementPoolsIds" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "File" : { + "type" : "object", + "properties" : { + "path" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "parent" : { + "type" : "string" + }, + "absolute" : { + "type" : "boolean", + "default" : false + }, + "canonicalPath" : { + "type" : "string" + }, + "parentFile" : { + "$ref" : "#/definitions/File" + }, + "absolutePath" : { + "type" : "string" + }, + "absoluteFile" : { + "$ref" : "#/definitions/File" + }, + "canonicalFile" : { + "$ref" : "#/definitions/File" + }, + "directory" : { + "type" : "boolean", + "default" : false + }, + "file" : { + "type" : "boolean", + "default" : false + }, + "hidden" : { + "type" : "boolean", + "default" : false + }, + "totalSpace" : { + "type" : "integer", + "format" : "int64" + }, + "freeSpace" : { + "type" : "integer", + "format" : "int64" + }, + "usableSpace" : { + "type" : "integer", + "format" : "int64" + } + } + }, + "FileDataStructureDto" : { + "type" : "object", + "properties" : { + "modules" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Module" + } + }, + "unassigned" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "artifacts" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "nested" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "HealthInfoDto" : { + "type" : "object", + "properties" : { + "healthCheckComponent" : { + "type" : "string", + "enum" : [ "BE", "CAS", "ZU" ] + }, + "healthStatus" : { + "type" : "string", + "enum" : [ "UP", "DOWN" ] + }, + "version" : { + "type" : "string" + }, + "description" : { + "type" : "string" + } + } + }, + "HealthInfoDtos" : { + "type" : "object", + "properties" : { + "healthInfos" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/HealthInfoDto" + } + } + } + }, + "ImageDto" : { + "type" : "object", + "properties" : { + "fileName" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "id" : { + "type" : "string" + } + } + }, + "ImageRequestDto" : { + "type" : "object", + "properties" : { + "fileName" : { + "type" : "string" + }, + "description" : { + "type" : "string" + } + } + }, + "InputStream" : { + "type" : "object" + }, + "ItemCreationDto" : { + "type" : "object", + "properties" : { + "itemId" : { + "type" : "string" + }, + "version" : { + "$ref" : "#/definitions/VersionDto" + } + } + }, + "ItemDto" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "owner" : { + "type" : "string" + } + } + }, + "ItemPermissionsDto" : { + "type" : "object", + "properties" : { + "userId" : { + "type" : "string" + }, + "permission" : { + "type" : "string" + } + } + }, + "ItemPermissionsRequest" : { + "type" : "object", + "properties" : { + "addedUsersIds" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "removedUsersIds" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "ItemVersionConflictDto" : { + "type" : "object", + "properties" : { + "conflict" : { + "$ref" : "#/definitions/ConflictDto" + }, + "conflictInfoList" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ConflictInfoDto" + } + } + } + }, + "LicenseAgreementEntity" : { + "type" : "object", + "required" : [ "licenseTerm", "name" ], + "properties" : { + "name" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 120 + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "licenseTerm" : { + "$ref" : "#/definitions/ChoiceOrOtherDtoLicenseTerm" + }, + "requirementsAndConstrains" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "id" : { + "type" : "string" + }, + "featureGroupsIds" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "LicenseAgreementModel" : { + "type" : "object", + "required" : [ "licenseTerm", "name" ], + "properties" : { + "name" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 120 + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "licenseTerm" : { + "$ref" : "#/definitions/ChoiceOrOtherDtoLicenseTerm" + }, + "requirementsAndConstrains" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "id" : { + "type" : "string" + }, + "featureGroups" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FeatureGroupEntity" + } + } + } + }, + "LicenseAgreementRequest" : { + "type" : "object", + "required" : [ "licenseTerm", "name" ], + "properties" : { + "name" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 120 + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "licenseTerm" : { + "$ref" : "#/definitions/ChoiceOrOtherDtoLicenseTerm" + }, + "requirementsAndConstrains" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "addedFeatureGroupsIds" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "LicenseAgreementUpdateRequest" : { + "type" : "object", + "required" : [ "licenseTerm", "name" ], + "properties" : { + "name" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 120 + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "licenseTerm" : { + "$ref" : "#/definitions/ChoiceOrOtherDtoLicenseTerm" + }, + "requirementsAndConstrains" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "addedFeatureGroupsIds" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "removedFeatureGroupsIds" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "LicenseKeyGroupEntityDto" : { + "type" : "object", + "required" : [ "name", "type" ], + "properties" : { + "name" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 120 + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "type" : { + "type" : "string", + "enum" : [ "Universal", "Unique", "One_Time" ] + }, + "operationalScope" : { + "$ref" : "#/definitions/MultiChoiceOrOtherDtoOperationalScope" + }, + "startDate" : { + "type" : "string" + }, + "expiryDate" : { + "type" : "string" + }, + "thresholdValue" : { + "type" : "integer", + "format" : "int32" + }, + "thresholdUnits" : { + "type" : "string", + "enum" : [ "Absolute", "Percentage" ] + }, + "increments" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 120 + }, + "id" : { + "type" : "string" + }, + "referencingFeatureGroups" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "LicenseKeyGroupRequestDto" : { + "type" : "object", + "required" : [ "name", "type" ], + "properties" : { + "name" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 120 + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "type" : { + "type" : "string", + "enum" : [ "Universal", "Unique", "One_Time" ] + }, + "operationalScope" : { + "$ref" : "#/definitions/MultiChoiceOrOtherDtoOperationalScope" + }, + "startDate" : { + "type" : "string" + }, + "expiryDate" : { + "type" : "string" + }, + "thresholdValue" : { + "type" : "integer", + "format" : "int32" + }, + "thresholdUnits" : { + "type" : "string", + "enum" : [ "Absolute", "Percentage" ] + }, + "increments" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 120 + } + } + }, + "LicensingData" : { + "type" : "object", + "properties" : { + "licenseAgreement" : { + "type" : "string" + }, + "featureGroups" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "LimitEntityDto" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "metric" : { + "type" : "string" + }, + "value" : { + "type" : "string" + }, + "unit" : { + "type" : "string" + }, + "aggregationFunction" : { + "type" : "string" + }, + "time" : { + "type" : "string" + } + } + }, + "LimitRequest" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 120 + }, + "type" : { + "type" : "string" + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "metric" : { + "type" : "string" + }, + "value" : { + "type" : "string" + }, + "unit" : { + "type" : "string" + }, + "aggregationFunction" : { + "type" : "string" + }, + "time" : { + "type" : "string" + } + } + }, + "MediaType" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string" + }, + "subtype" : { + "type" : "string" + }, + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "wildcardType" : { + "type" : "boolean", + "default" : false + }, + "wildcardSubtype" : { + "type" : "boolean", + "default" : false + } + } + }, + "Module" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "isBase" : { + "type" : "boolean", + "default" : false + }, + "yaml" : { + "type" : "string" + }, + "env" : { + "type" : "string" + }, + "vol" : { + "type" : "string" + }, + "volEnv" : { + "type" : "string" + } + } + }, + "MonitoringUploadStatusDto" : { + "type" : "object", + "properties" : { + "snmpTrap" : { + "type" : "string" + }, + "snmpPoll" : { + "type" : "string" + }, + "vesEvent" : { + "type" : "string" + } + } + }, + "MultiChoiceOrOtherDtoOperationalScope" : { + "type" : "object", + "required" : [ "choices", "other" ], + "properties" : { + "choices" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string", + "enum" : [ "Network_Wide", "Availability_Zone", "Data_Center", "Tenant", "VM", "CPU", "Core", "Other" ] + } + }, + "other" : { + "type" : "string" + } + } + }, + "NetworkDto" : { + "type" : "object", + "required" : [ "dhcp", "name" ], + "properties" : { + "name" : { + "type" : "string" + }, + "dhcp" : { + "type" : "boolean", + "default" : false + }, + "id" : { + "type" : "string" + } + } + }, + "NetworkRequestDto" : { + "type" : "object", + "required" : [ "dhcp", "name" ], + "properties" : { + "name" : { + "type" : "string" + }, + "dhcp" : { + "type" : "boolean", + "default" : false + } + } + }, + "NicDto" : { + "type" : "object", + "required" : [ "networkType" ], + "properties" : { + "name" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "networkId" : { + "type" : "string" + }, + "networkType" : { + "type" : "string" + }, + "networkDescription" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "networkName" : { + "type" : "string" + } + } + }, + "NicRequestDto" : { + "type" : "object", + "required" : [ "networkType" ], + "properties" : { + "name" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "networkId" : { + "type" : "string" + }, + "networkType" : { + "type" : "string" + }, + "networkDescription" : { + "type" : "string" + } + } + }, + "NotificationEntityDto" : { + "type" : "object", + "properties" : { + "read" : { + "type" : "boolean", + "default" : false + }, + "eventId" : { + "type" : "string", + "format" : "uuid" + }, + "dateTime" : { + "type" : "string" + }, + "eventType" : { + "type" : "string" + }, + "eventAttributes" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + } + } + }, + "NotificationsStatusDto" : { + "type" : "object", + "properties" : { + "notifications" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/NotificationEntityDto" + } + }, + "newEntries" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "uuid" + } + }, + "lastScanned" : { + "type" : "string", + "format" : "uuid" + }, + "endOfPage" : { + "type" : "string", + "format" : "uuid" + }, + "numOfNotSeenNotifications" : { + "type" : "integer", + "format" : "int64" + } + } + }, + "OutputStream" : { + "type" : "object" + }, + "PackageInfoDto" : { + "type" : "object", + "properties" : { + "displayName" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "vspName" : { + "type" : "string" + }, + "version" : { + "type" : "string" + }, + "packageId" : { + "type" : "string" + }, + "category" : { + "type" : "string" + }, + "subCategory" : { + "type" : "string" + }, + "vendorName" : { + "type" : "string" + }, + "vendorRelease" : { + "type" : "string" + }, + "packageChecksum" : { + "type" : "string" + }, + "packageType" : { + "type" : "string" + } + } + }, + "ProcessEntityDto" : { + "type" : "object", + "required" : [ "name" ], + "properties" : { + "name" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "type" : { + "type" : "string", + "enum" : [ "Lifecycle_Operations", "Other" ] + }, + "id" : { + "type" : "string" + }, + "artifactName" : { + "type" : "string" + } + } + }, + "ProcessRequestDto" : { + "type" : "object", + "required" : [ "name" ], + "properties" : { + "name" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "type" : { + "type" : "string", + "enum" : [ "Lifecycle_Operations", "Other" ] + } + } + }, + "QuestionnaireResponseDto" : { + "type" : "object", + "properties" : { + "schema" : { + "type" : "string" + }, + "data" : { + "type" : "string" + }, + "errorMessage" : { + "$ref" : "#/definitions/ErrorMessage" + } + } + }, + "RevisionDto" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" + }, + "message" : { + "type" : "string" + }, + "time" : { + "type" : "string", + "format" : "date-time" + }, + "user" : { + "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" : "#/definitions/ErrorMessage" + } + } + }, + "status" : { + "type" : "string", + "enum" : [ "Success", "Failure" ] + } + } + }, + "UploadFileResponseDto" : { + "type" : "object", + "properties" : { + "errors" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ErrorMessage" + } + } + }, + "status" : { + "type" : "string", + "enum" : [ "Success", "Failure" ] + }, + "onboardingOrigin" : { + "type" : "string" + }, + "networkPackageName" : { + "type" : "string" + } + } + }, + "VendorLicenseModelActionRequestDto" : { + "type" : "object", + "properties" : { + "action" : { + "type" : "string", + "enum" : [ "Submit" ] + }, + "submitRequest" : { + "$ref" : "#/definitions/SubmitRequestDto" + } + } + }, + "VendorLicenseModelEntity" : { + "type" : "object", + "required" : [ "description", "iconRef", "vendorName" ], + "properties" : { + "vendorName" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 25 + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "iconRef" : { + "type" : "string" + }, + "id" : { + "type" : "string" + } + } + }, + "VendorLicenseModelRequest" : { + "type" : "object", + "required" : [ "description", "iconRef", "vendorName" ], + "properties" : { + "vendorName" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 25 + }, + "description" : { + "type" : "string", + "minLength" : 0, + "maxLength" : 1000 + }, + "iconRef" : { + "type" : "string" + } + } + }, + "VersionActionRequestDto" : { + "type" : "object", + "properties" : { + "action" : { + "type" : "string", + "enum" : [ "Sync", "Commit", "Revert", "Reset" ] + }, + "commitRequest" : { + "$ref" : "#/definitions/CommitRequestDto" + }, + "revisionRequest" : { + "$ref" : "#/definitions/RevisionRequestDto" + } + } + }, + "VersionDto" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "baseId" : { + "type" : "string" + }, + "status" : { + "type" : "string", + "enum" : [ "Draft", "Locked", "Certified" ] + }, + "state" : { + "$ref" : "#/definitions/VersionState" + }, + "creationTime" : { + "type" : "string", + "format" : "date-time" + }, + "modificationTime" : { + "type" : "string", + "format" : "date-time" + }, + "additionalInfo" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + } + } + }, + "VersionRequestDto" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string" + }, + "creationMethod" : { + "type" : "string", + "enum" : [ "major", "minor" ] + } + } + }, + "VersionSoftwareProductActionRequestDto" : { + "type" : "object", + "properties" : { + "action" : { + "type" : "string", + "enum" : [ "Submit", "Create_Package" ] + }, + "submitRequest" : { + "$ref" : "#/definitions/SubmitRequestDto" + } + } + }, + "VersionState" : { + "type" : "object", + "properties" : { + "synchronizationState" : { + "type" : "string", + "enum" : [ "UpToDate", "OutOfSync", "Merging" ] + }, + "dirty" : { + "type" : "boolean", + "default" : false + } + } + }, + "VspComputeDto" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "componentId" : { + "type" : "string" + }, + "computeFlavorId" : { + "type" : "string" + } + } + }, + "VspDescriptionDto" : { + "type" : "object", + "required" : [ "category", "description", "name", "subCategory", "vendorId", "vendorName" ], + "properties" : { + "name" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "icon" : { + "type" : "string" + }, + "category" : { + "type" : "string" + }, + "subCategory" : { + "type" : "string" + }, + "vendorName" : { + "type" : "string" + }, + "vendorId" : { + "type" : "string" + }, + "licensingVersion" : { + "type" : "string" + }, + "licensingData" : { + "$ref" : "#/definitions/LicensingData" + } + } + }, + "VspRequestDto" : { + "type" : "object", + "required" : [ "category", "description", "name", "onboardingMethod", "subCategory", "vendorId", "vendorName" ], + "properties" : { + "name" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "icon" : { + "type" : "string" + }, + "category" : { + "type" : "string" + }, + "subCategory" : { + "type" : "string" + }, + "vendorName" : { + "type" : "string" + }, + "vendorId" : { + "type" : "string" + }, + "licensingVersion" : { + "type" : "string" + }, + "licensingData" : { + "$ref" : "#/definitions/LicensingData" + }, + "onboardingMethod" : { + "type" : "string" + } + } + } + } +}
\ No newline at end of file diff --git a/nokiav2/generatedapis/src/main/resources/vfc.catalog.swagger.json b/nokiav2/generatedapis/src/main/resources/vfc.catalog.swagger.json new file mode 100644 index 00000000..f5079ec6 --- /dev/null +++ b/nokiav2/generatedapis/src/main/resources/vfc.catalog.swagger.json @@ -0,0 +1,751 @@ +{
+ "swagger": "2.0",
+ "info": {
+ "version": "1.0.0",
+ "title": "ONAP VFC Catalog Rest API",
+ "description": "VFC Catalog Management API.",
+ "contact": {
+ "name": "ONAP VFC team",
+ "email": "onap-discuss@lists.onap.org",
+ "url": "https://gerrit.onap.org/r/#/admin/projects/vfc/nfvo/catalog"
+ }
+ },
+ "basePath": "/api/catalog/v1",
+ "schemes": [
+ "http",
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/nspackages": {
+ "get": {
+ "tags": [
+ "nspackage"
+ ],
+ "summary": "query ns packages info",
+ "description": "query ns packages info",
+ "operationId": "query_ns_packages",
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "successful operation",
+ "schema": {
+ "$ref": "#/definitions/NsPkgListInfo"
+ }
+ },
+ "404": {
+ "description": "URL not found"
+ },
+ "500": {
+ "description": "internal error"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "nspackage"
+ ],
+ "summary": "ns package distribute",
+ "description": "ns package distribute",
+ "operationId": "ns_pkg_distribute",
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "description": "distribute request param",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/NsPkgDistributeRequest"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "",
+ "schema": {
+ "$ref": "#/definitions/NsPkgDistributeResponse"
+ }
+ },
+ "404": {
+ "description": "URL not found"
+ },
+ "500": {
+ "description": "internal error"
+ }
+ }
+ }
+ },
+ "/nspackages/{csarId}": {
+ "get": {
+ "tags": [
+ "nspackage"
+ ],
+ "summary": "query ns package info",
+ "description": "query ns package info via ns package csarId",
+ "operationId": "query_ns_package",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "csarId",
+ "in": "path",
+ "description": "csar id of ns package",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "successful operation",
+ "schema": {
+ "$ref": "#/definitions/NsPkgDetailInfo"
+ }
+ },
+ "404": {
+ "description": "URL not found"
+ },
+ "500": {
+ "description": "internal error"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "nspackage"
+ ],
+ "summary": "delete ns pkg",
+ "description": "delete ns pkg",
+ "operationId": "delete_ns_pkg",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "csarId",
+ "in": "path",
+ "description": "csar id of ns package",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "",
+ "schema": {
+ "$ref": "#/definitions/NsPkgDelResponse"
+ }
+ },
+ "404": {
+ "description": "URL not found"
+ },
+ "500": {
+ "description": "internal error"
+ }
+ }
+ }
+ },
+ "/parsernsd": {
+ "post": {
+ "tags": [
+ "model"
+ ],
+ "summary": "ns package model",
+ "description": "ns package model",
+ "operationId": "ms_model_parser",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "description": "distribute request param",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/modelParserRequest"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "",
+ "schema": {
+ "$ref": "#/definitions/modelParserResponse"
+ }
+ },
+ "404": {
+ "description": "URL not found"
+ },
+ "500": {
+ "description": "internal error"
+ }
+ }
+ }
+ },
+ "/vnfpackages": {
+ "get": {
+ "tags": [
+ "vnfpackage"
+ ],
+ "summary": "query vnf packages info",
+ "description": "query vnf packages info",
+ "operationId": "query_vnf_packages",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "successful operation",
+ "schema": {
+ "$ref": "#/definitions/VnfPkgListInfo"
+ }
+ },
+ "404": {
+ "description": "URL not found"
+ },
+ "500": {
+ "description": "internal error"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "vnfpackage"
+ ],
+ "summary": "vnf package distribute",
+ "description": "vnf package distribute",
+ "operationId": "vnf_pkg_distribute",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "description": "distribute request param",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VnfPkgDistributeRequest"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "",
+ "schema": {
+ "$ref": "#/definitions/VnfPkgDistributeResponse"
+ }
+ },
+ "404": {
+ "description": "URL not found"
+ },
+ "500": {
+ "description": "internal error"
+ }
+ }
+ }
+ },
+ "/vnfpackages/{csarId}": {
+ "get": {
+ "tags": [
+ "vnfpackage"
+ ],
+ "summary": "query vnf package info",
+ "description": "query one vnf package info via vnf package csarId",
+ "operationId": "query_vnf_package",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "csarId",
+ "in": "path",
+ "description": "csar id of vnf package",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "successful operation",
+ "schema": {
+ "$ref": "#/definitions/VnfPkgDetailInfo"
+ }
+ },
+ "404": {
+ "description": "URL not found"
+ },
+ "500": {
+ "description": "internal error"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "vnfpackage"
+ ],
+ "summary": "delete vnf package",
+ "description": "delete vnf package",
+ "operationId": "delete_vnf_package",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "csarId",
+ "in": "path",
+ "description": "csar id of vnf package",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "",
+ "schema": {
+ "$ref": "#/definitions/VnfPkgDelResponse"
+ }
+ },
+ "404": {
+ "description": "URL not found"
+ },
+ "500": {
+ "description": "internal error"
+ }
+ }
+ }
+ },
+ "/parservnfd": {
+ "post": {
+ "tags": [
+ "model"
+ ],
+ "summary": "vnf package model",
+ "description": "vnf package model",
+ "operationId": "vnf_model_parser",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "description": "distribute request param",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/modelParserRequest"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "",
+ "schema": {
+ "$ref": "#/definitions/modelParserResponse"
+ }
+ },
+ "404": {
+ "description": "URL not found"
+ },
+ "500": {
+ "description": "internal error"
+ }
+ }
+ }
+ },
+ "/jobs/{jobId}": {
+ "get": {
+ "tags": [
+ "job"
+ ],
+ "summary": "jobstatus",
+ "description": "",
+ "operationId": "get_jobstatus",
+ "parameters": [
+ {
+ "required": true,
+ "type": "string",
+ "description": "job Id",
+ "name": "jobId",
+ "in": "path"
+ },
+ {
+ "required": true,
+ "type": "string",
+ "description": "job response message id",
+ "name": "responseId",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "",
+ "schema": {
+ "$ref": "#/definitions/JobDetailInfo"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "NsPkgDistributeRequest": {
+ "type": "object",
+ "properties": {
+ "csarId": {
+ "type": "string",
+ "description": "network service package id, UUID"
+ }
+ }
+ },
+ "NsPkgDistributeResponse": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "Operation status. value is success or failed"
+ },
+ "statusDescription": {
+ "type": "string",
+ "description": "description about the operation result"
+ },
+ "errorCode": {
+ "type": "string",
+ "description": "If the status is failed, the errorcode will be returned"
+ }
+ }
+ },
+ "NsPkgDelResponse": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "Operation status. value is success or failed"
+ },
+ "statusDescription": {
+ "type": "string",
+ "description": "description about the operation result"
+ },
+ "errorCode": {
+ "type": "string",
+ "description": "If the status is failed, the errorcode will be returned"
+ }
+ }
+ },
+ "NsPkgListInfo": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NsPkgInfo"
+ }
+ },
+ "NsPkgDetailInfo": {
+ "type": "object",
+ "properties": {
+ "csarId": {
+ "type": "string"
+ },
+ "packageInfo": {
+ "$ref": "#/definitions/NsPkgInfo"
+ },
+ "instanceInfo": {
+ "$ref": "#/definitions/NsInstListInfo"
+ }
+ }
+ },
+ "NsPkgInfo": {
+ "type": "object",
+ "properties": {
+ "nsPackageId": {
+ "type": "string",
+ "description": "The identifer of the NS (csarId)"
+ },
+ "nsdId": {
+ "type": "string",
+ "description": "network service descriptor identifer (same as csarId)"
+ },
+ "csarName": {
+ "type": "string",
+ "description": "The name of the CSAR"
+ },
+ "nsdProvider": {
+ "type": "string",
+ "description": "network service designer name"
+ },
+ "nsdVersion": {
+ "type": "string",
+ "description": "network service descriptor version"
+ },
+ "downloadUrl": {
+ "type": "string",
+ "description": "The URL from which the NSD package can be downloaded from"
+ },
+ "nsdModel": {
+ "type": "string",
+ "description": "The parsed model of the NSD (JSON encoded into string)"
+ }
+ }
+ },
+ "NsInstListInfo": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NsInstInfo"
+ }
+ },
+ "NsInstInfo": {
+ "type": "object",
+ "properties": {
+ "nsInstanceId": {
+ "type": "string",
+ "description": "network service instance ID"
+ },
+ "nsInstanceName": {
+ "type": "string",
+ "description": "network service instance name"
+ }
+ }
+ },
+ "VnfPkgDistributeRequest": {
+ "type": "object",
+ "properties": {
+ "csarId": {
+ "type": "string",
+ "description": "vnf package id, UUID"
+ }
+ }
+ },
+ "VnfPkgDistributeResponse": {
+ "type": "object",
+ "properties": {
+ "jobId": {
+ "type": "string",
+ "description": "VNF package distribute job ID"
+ }
+ }
+ },
+ "VnfPkgDelResponse": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "Operation status. value is success or failed"
+ },
+ "statusDescription": {
+ "type": "string",
+ "description": "description about the operation result"
+ },
+ "errorCode": {
+ "type": "string",
+ "description": "If the status is failed, the errorcode will be returned"
+ }
+ }
+ },
+ "VnfPkgListInfo": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VnfPkgInfo"
+ }
+ },
+ "VnfPkgDetailInfo": {
+ "type": "object",
+ "properties": {
+ "csarId": {
+ "type": "string",
+ "description": "vnf package id, UUID"
+ },
+ "packageInfo": {
+ "$ref": "#/definitions/VnfPkgInfo"
+ },
+ "imageInfo": {
+ "$ref": "#/definitions/VnfPkgImgListInfo"
+ },
+ "vnfInstanceInfo": {
+ "$ref": "#/definitions/VnfInstListInfo"
+ }
+ }
+ },
+ "VnfPkgInfo": {
+ "type": "object",
+ "description": "vnf package infomation",
+ "properties": {
+ "vnfPackageId": {
+ "type": "string",
+ "description": "The identifier of the VNF package (csarId)"
+ },
+ "csarName": {
+ "type": "string",
+ "description": "The name of the CSAR"
+ },
+ "vnfdId": {
+ "type": "string",
+ "description": "VNF descriptor ID (same as CSAR ID)"
+ },
+ "vnfdProvider": {
+ "type": "string",
+ "description": "VNF descriptor vendor ID"
+ },
+ "vnfdVersion": {
+ "type": "string",
+ "description": "VNF descriptor version"
+ },
+ "vnfVersion": {
+ "type": "string",
+ "description": "VNF Software version"
+ },
+ "vnfdModel":{
+ "type": "string",
+ "description": "The model of the VNFD (JSON encoded into string)"
+ },
+ "downloadUrl":{
+ "type": "string",
+ "description": "The URL from which the package can be downloaded from"
+ }
+ }
+ },
+ "VnfInstListInfo": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VnfInstInfo"
+ }
+ },
+ "VnfInstInfo": {
+ "type": "object",
+ "properties": {
+ "vnfInstanceId": {
+ "type": "string",
+ "description": "VNF instance ID"
+ },
+ "vnfInstanceName": {
+ "type": "string",
+ "description": "VNF instance name"
+ }
+ }
+ },
+ "VnfPkgImgListInfo": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VnfPkgImgInfo"
+ }
+ },
+ "VnfPkgImgInfo": {
+ "type": "object",
+ "properties": {
+ "fileName": {
+ "type": "string",
+ "description": "image file name"
+ },
+ "imageUrl": {
+ "type": "string",
+ "description": "image file path in the csar or image url in external repository"
+ }
+ }
+ },
+ "modelParserRequest":{
+ "type": "object",
+ "properties": {
+ "csarId": {
+ "type": "string",
+ "description": "csar Package Id"
+ },
+ "inputs": {
+ "type": "object",
+ "description": "csar package json inputs"
+ }
+ }
+ },
+ "modelParserResponse":{
+ "type": "object",
+ "properties": {
+ "model": {
+ "type": "object",
+ "description": "csar model json data"
+ }
+ }
+ },
+ "jobResponseInfo": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string"
+ },
+ "progress":{
+ "type": "string"
+ },
+ "statusDescription": {
+ "type": "string"
+ },
+ "errorCode": {
+ "type": "string"
+ },
+ "responseId": {
+ "type": "string"
+ }
+ }
+ },
+ "JobDetailInfo":{
+ "type": "object",
+ "properties": {
+ "jobId": {
+ "type": "string"
+ },
+ "responseDescriptor":
+ {
+ "type":"object",
+ "properties": {
+ "status": {
+ "type": "string"
+ },
+ "progress":{
+ "type": "string"
+ },
+ "statusDescription": {
+ "type": "string"
+ },
+ "errorCode": {
+ "type": "string"
+ },
+ "responseId": {
+ "type": "string"
+ },
+ "responseHistoryList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/jobResponseInfo"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/nokiav2/generatedapis/src/main/resources/vfc.vnfdriver.swagger.json b/nokiav2/generatedapis/src/main/resources/vfc.vnfdriver.swagger.json new file mode 100644 index 00000000..0670ea98 --- /dev/null +++ b/nokiav2/generatedapis/src/main/resources/vfc.vnfdriver.swagger.json @@ -0,0 +1,1385 @@ +{ + "swagger": "2.0", + "info": { + "version": "1.0.0", + "title": "ONAP VNFM Driver Development Related API", + "description": "ONAP VNFM Driver Development Related Rest API.", + "contact": { + "name": "ONAP VFC team", + "email": "onap-discuss@lists.onap.org", + "url": "https://gerrit.onap.org/r/#/admin/projects/vfc/nfvo/lcm" + } + }, + "basePath": "/api", + "schemes": [ + "http", + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/{vnfmtype}/v1/{vnfmid}/vnfs": { + "post": { + "tags": [ + "VnfmDriver" + ], + "summary": "vnf create&instantiate", + "description": "VNF create&instantiate Rest API should be provided by the VNFM Driver", + "operationId": "vnf_instantiate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "required": true, + "type": "string", + "description": "The value of vnfmtype should be the SVNFM driver service name", + "name": "vnfmtype", + "in": "path" + }, + { + "required": true, + "type": "string", + "description": "The value of vnfmid should be the VNFM Instantiate ID", + "name": "vnfmid", + "in": "path" + }, + { + "in": "body", + "name": "body", + "description": "instantiate request param", + "required": true, + "schema": { + "$ref": "#/definitions/VnfInstantiateRequest" + } + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/VnfInstantiateResponse" + } + } + } + } + }, + "/{vnfmtype}/v1/{vnfmid}/vnfs/{vnfInstanceId}/scale": { + "post": { + "tags": [ + "VnfmDriver" + ], + "summary": "vnf Scale", + "description": "VNF Scale Rest API should be provided by the VNFM Driver", + "operationId": "vnf_scale", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "required": true, + "type": "string", + "description": "The value of vnfmtype should be the SVNFM driver service name", + "name": "vnfmtype", + "in": "path" + }, + { + "required": true, + "type": "string", + "description": "The value of vnfmid should be the VNFM Instantiate ID", + "name": "vnfmid", + "in": "path" + }, + { + "required": true, + "type": "string", + "description": "The value of vnfInstanceId should be the VNF Instantiate ID", + "name": "vnfInstanceId", + "in": "path" + }, + { + "in": "body", + "name": "body", + "description": "instantiate request param", + "required": true, + "schema": { + "$ref": "#/definitions/VnfScaleRequest" + } + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/JobInfo" + } + }, + "404": { + "description": "the VNF instance id is wrong" + }, + "500": { + "description": "the url is invalid" + } + } + } + }, + "/{vnfmtype}/v1/{vnfmid}/vnfs/{vnfInstanceId}/heal": { + "post": { + "tags": [ + "VnfmDriver" + ], + "summary": "vnf heal", + "description": "VNF Heal Rest API should be provided by the VNFM Driver", + "operationId": "vnf_heal", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "required": true, + "type": "string", + "description": "The value of vnfmtype should be the SVNFM driver service name", + "name": "vnfmtype", + "in": "path" + }, + { + "required": true, + "type": "string", + "description": "The value of vnfmid should be the VNFM Instantiate ID", + "name": "vnfmid", + "in": "path" + }, + { + "required": true, + "type": "string", + "description": "The value of vnfInstanceId should be the VNF Instantiate ID", + "name": "vnfInstanceId", + "in": "path" + }, + { + "in": "body", + "name": "body", + "description": "instantiate request param", + "required": true, + "schema": { + "$ref": "#/definitions/VnfHealRequest" + } + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/JobInfo" + } + }, + "404": { + "description": "the VNF instance id is wrong" + }, + "500": { + "description": "the url is invalid" + } + } + } + }, + "/{vnfmtype}/v1/{vnfmid}/vnfs/{vnfInstanceId}/terminate": { + "post": { + "tags": [ + "VnfmDriver" + ], + "summary": "terminate&delete vnf", + "description": "VNF terminate&delete Rest API should be provided by the VNFM Driver", + "operationId": "terminate_vnf", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "required": true, + "type": "string", + "description": "The value of vnfmtype should be the SVNFM driver service name", + "name": "vnfmtype", + "in": "path" + }, + { + "required": true, + "type": "string", + "description": "The value of vnfmid should be the VNFM Instantiate ID", + "name": "vnfmid", + "in": "path" + }, + { + "required": true, + "type": "string", + "description": "The value of vnfInstanceId should be the VNF Instantiate ID", + "name": "vnfInstanceId", + "in": "path" + }, + { + "in": "body", + "name": "body", + "description": "instantiate request param", + "required": true, + "schema": { + "$ref": "#/definitions/VnfTerminateRequest" + } + } + ], + "responses": { + "204": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/JobInfo" + } + }, + "404": { + "description": "the VNF instance id is wrong" + }, + "500": { + "description": "the url is invalid" + } + } + } + }, + "/{vnfmtype}/v1/{vnfmid}/vnfs/{vnfInstanceId}": { + "get": { + "tags": [ + "VnfmDriver" + ], + "summary": "query the specified vnf info", + "description": "", + "operationId": "query_vnf", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "required": true, + "type": "string", + "description": "The value of vnfmtype should be the SVNFM driver service name", + "name": "vnfmtype", + "in": "path" + }, + { + "required": true, + "type": "string", + "description": "The value of vnfmid should be the VNFM Instantiate ID", + "name": "vnfmid", + "in": "path" + }, + { + "required": true, + "type": "string", + "description": "The value of vnfInstanceId should be the VNF Instantiate ID", + "name": "vnfInstanceId", + "in": "path" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/VnfInfo" + } + }, + "404": { + "description": "the vnf instance id is wrong" + }, + "500": { + "description": "the url is invalid" + } + } + } + }, + "/nslcm/v1/ns/grantvnf": { + "post": { + "tags": [ + "Nslcm" + ], + "summary": "grantvnf", + "description": "Grant VNF, provived by the Nslcm component", + "operationId": "grantvnf", + "parameters": [ + { + "in": "body", + "name": "grantvnf", + "description": "Grant VNF Request", + "required": true, + "schema": { + "$ref": "#/definitions/GrantVNFRequest" + } + } + ], + "responses": { + "202": { + "description": "", + "schema": { + "$ref": "#/definitions/GrantVNFResponse" + } + }, + "404": { + "description": "URL not found" + }, + "500": { + "description": "the url is invalid" + } + } + } + }, + "/nslcm/v1/ns/{vnfmid}/vnfs/{vnfInstanceId}/Notify": { + "post": { + "tags": [ + "Nslcm" + ], + "summary": "VNF LCM Notification", + "description": "VNF LCM Notification API should be provided by Nslcm component", + "operationId": "VNF_LCM_Notification", + "parameters": [ + { + "required": true, + "type": "string", + "description": "VNFM Instance Id", + "name": "vnfmid", + "in": "path" + }, + { + "required": true, + "type": "string", + "description": "VNF Instance Id", + "name": "vnfInstanceId", + "in": "path" + }, + { + "in": "body", + "name": "vnf Notification", + "description": "VNF LCM Notification", + "required": true, + "schema": { + "$ref": "#/definitions/VNFLCMNotification" + } + } + ], + "responses": { + "202": { + "description": "" + }, + "404": { + "description": "URL not found" + }, + "500": { + "description": "the url is invalid" + } + } + } + }, + "/{vnfmid}/jobs/{jobid}": { + "get": { + "tags": [ + "VnfmDriver" + ], + "summary": "jobstatus", + "description": "Job Infomation API should be provided by VNFM Driver", + "operationId": "get_jobstatus", + "parameters": [ + { + "required": true, + "type": "string", + "description": "job Id", + "name": "jobid", + "in": "path" + }, + { + "required": true, + "type": "string", + "description": "The value of vnfmid should be the VNFM Instantiate ID", + "name": "vnfmid", + "in": "path" + }, + { + "required": true, + "type": "string", + "description": "job response message id", + "name": "responseId", + "in": "query" + } + ], + "responses": { + "202": { + "description": "", + "schema": { + "$ref": "#/definitions/JobDetailInfo" + } + } + } + } + }, + "/catalog/v1/vnfpackages/{csarId}": { + "get": { + "tags": [ + "Catalog" + ], + "summary": "query vnf package info", + "description": "query one vnf package info via vnf package csarId", + "operationId": "query_vnf_package", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "csarId", + "in": "path", + "description": "csar id of vnf package", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/VnfPkgDetailInfo" + } + }, + "500": { + "description": "internal error" + } + } + } + }, + "/nslcm/v1/vnfms/{vnfmid}":{ + "get": { + "tags": [ + "Nslcm" + ], + "summary": "Query VNFM register info", + "description": "query VNFM register info", + "operationId": "query_vnfm_info", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "vnfmid", + "in": "path", + "description": "vnfm id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/VnfmInfo" + } + }, + "404": { + "description": "URL not found" + }, + "500": { + "description": "internal error" + } + } + } + }, + "/nslcm/v1/vims/{vimid}":{ + "get": { + "tags": [ + "Nslcm" + ], + "summary": "Query VIM register info", + "description": "query VIM register info", + "operationId": "query_VIM_info", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "vimid", + "in": "path", + "description": "vim id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/VimInfo" + } + }, + "404": { + "description": "URL not found" + }, + "500": { + "description": "internal error" + } + } + } + } + }, + "definitions": { + "jobResponseInfo": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "progress": { + "type": "string" + }, + "statusDescription": { + "type": "string" + }, + "errorCode": { + "type": "string" + }, + "responseId": { + "type": "string" + } + } + }, + "JobStatus" : { + "description": "The status of the job", + "type": "string", + "enum": [ + "started", + "processing", + "finished", + "error", + "timeout" + ] + }, + "JobDetailInfo": { + "type": "object", + "properties": { + "jobId": { + "type": "string" + }, + "responseDescriptor": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The status of the job" + }, + "progress": { + "type": "string", + "description": "The progress of the job. Value between 0 and 100." + }, + "statusDescription": { + "type": "string", + "description": "The reason of the current status of the job." + }, + "errorCode": { + "type": "string" + }, + "responseId": { + "type": "string" + }, + "responseHistoryList": { + "type": "array", + "items": { + "$ref": "#/definitions/jobResponseInfo" + } + } + } + } + } + }, + "ChangeType" : { + "description": "The type of the change", + "type": "string", + "enum": [ + "VDU" + ] + }, + "ResourceChange" : { + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/ChangeType", + "description": "The type of the resource." + }, + "resourceDefinitionId": { + "description": "The identifier of the resource within the grant request.", + "type": "string" + }, + "vdu": { + "description": "The identifier of the VDU.", + "type": "string" + } + } + }, + "OperationType" : { + "description": "The type of operation", + "type": "string", + "enum": [ + "Terminal", + "Instantiate", + "Scalein", + "Scaleout", + "Scaledown", + "Scaleup", + "Heal" + ] + }, + "GrantVNFRequest": { + "type": "object", + "properties": { + "vnfInstanceId": { + "type": "string" + }, + "vnfDescriptorId": { + "type": "string" + }, + "lifecycleOperation": { + "description" : "The type of the operation.", + "$ref": "#/definitions/OperationType" + }, + "jobId": { + "type": "string" + }, + "addResource": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceChange" + } + }, + "removeResource": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceChange" + } + }, + "additionalParam": { + "type": "object", + "description": "The data type is KeyValuePair. Additional parameters passed by the NFVO, specific to the VNF and the LCM operation." + } + } + }, + "GrantVNFResponse": { + "type": "object", + "properties": { + "vim": { + "type": "object", + "properties": { + "vimInfoId": { + "type": "string" + }, + "vimId": { + "type": "string" + }, + "interfaceInfo": { + "type": "object", + "properties": { + "vimType": { + "type": "string", + "description": "The vim Type value wil be openstack" + }, + "apiVersion": { + "type": "string", + "description": "The api Version Type value will be " + }, + "protocolType": { + "type": "string", + "description": "The protocol Type value will be http or https" + } + } + }, + "accessInfo": { + "type": "object", + "properties": { + "tenant": { + "type": "string", + "description": "Tenant Name of tenant" + }, + "username": { + "type": "string", + "description": "Username for login" + }, + "password": { + "type": "string", + "description": "Password of login user" + } + } + }, + "interfaceEndpoint": { + "type": "string", + "description": "Information about the interface endpoint. It is a URL" + } + } + } + } + }, + "VnfNotificationType": { + "description": "The type of the notification", + "type": "string", + "enum": [ + "added", + "removed", + "modified" + ] + }, + "AffectedVnfc": { + "type": "object", + "properties": { + "vnfcInstanceId": { + "type": "string", + "description": "Identifier of the VNFC instance" + }, + "vduId": { + "type": "string", + "description": "Identifier of the VDU in the VNFD" + }, + "changeType": { + "$ref": "#/definitions/VnfNotificationType", + "description": "The type of the change" + }, + "vimid": { + "type": "string", + "description": "Identifier of vim" + }, + "vmid": { + "type": "string", + "description": "Identifier of virtual machine" + }, + "vmname": { + "type": "string", + "description": "Name of virtual machine" + } + } + }, + "AffectedVirtualLinkType": { + "description": "The type of the affected virtual link", + "type": "string", + "enum": [ + "network", + "port" + ] + }, + "AffectedVirtualLink":{ + "type": "object", + "properties": { + "vlInstanceId": { + "type": "string", + "description": "Identifier of the VL instance" + }, + "vldid": { + "type": "string", + "description": "Identifier of the VLD in the VNFD" + }, + "changeType": { + "$ref": "#/definitions/VnfNotificationType", + "description": "The type of the change" + }, + "networkResource": { + "type": "object", + "description": "network Resource", + "properties": { + "resourceType": { + "$ref": "#/definitions/AffectedVirtualLinkType", + "description": "Must be network" + }, + "resourceId": { + "type": "string", + "description": "Identifier of the resource in the scope of the VIM" + } + } + } + } + }, + "VnfCpNotificationType": { + "description": "The type of the notification for connection points", + "type": "string", + "enum": [ + "added", + "removed", + "changed" + ] + }, + "AffectedCp": { + "type": "object", + "properties": { + "virtualLinkInstanceId": { + "type": "string", + "description": "Identifier of the VL instance" + }, + "cpinstanceid": { + "type": "string", + "description": "Identifier of the connection point" + }, + "cpdid": { + "type": "string", + "description": "Identifier of the connection point in the VNFD" + }, + "ownerType": { + "type": "string", + "description": "The type of the owner." + }, + "ownerId": { + "type": "string", + "description": "Identifier of the owner. Mandatory if ownerType is specified." + }, + "changeType": { + "$ref": "#/definitions/VnfCpNotificationType", + "description": "The type of the change" + }, + "portResource": { + "type": "object", + "description": "port Resource", + "properties": { + "vimid": { + "type": "string", + "description": "Identifier of the VIM" + }, + "resourceid": { + "type": "string", + "description": "Identifier of the resource in the scope of the VIM" + }, + "resourceName": { + "type": "string", + "description": "Resource name in the vim" + }, + "tenant": { + "type": "string", + "description": "The identifier of the tenant" + }, + "ipAddress": { + "type": "string", + "description": "The IP address of the port" + }, + "macAddress": { + "type": "string", + "description": "The MAC address of the port" + }, + "instId": { + "type": "string", + "description": "The instance id of the server to which the port is attached to" + } + } + } + } + }, + "AffectedVirtualStorage" : { + "type": "object" + }, + "VnfLcmNotificationStatus" : { + "description": "The status of the operation", + "type": "string", + "enum": [ + "result", + "start" + ] + }, + "VNFLCMNotification": { + "type": "object", + "properties": { + "status": { + "description" : "The status of the operation that triggered the LCN.", + "$ref": "#/definitions/VnfLcmNotificationStatus" + }, + "vnfInstanceId": { + "type": "string" + }, + "operation": { + "description" : "The type of the operation that tiggered the LCN.", + "$ref": "#/definitions/OperationType" + }, + "jobId": { + "description" : "The identifier fo the job that triggered the LCN.", + "type": "string" + }, + "affectedVnfc": { + "type": "array", + "description": "The affected VNFCs", + "items": { + "$ref": "#/definitions/AffectedVnfc" + } + }, + "affectedCp": { + "type": "array", + "description": "The affected Connected Points", + "items": { + "$ref": "#/definitions/AffectedCp" + } + }, + "affectedVl": { + "type": "array", + "description": "The affected virtual links", + "items": { + "$ref": "#/definitions/AffectedVirtualLink" + } + }, + "affectedVirtualStorage": { + "type": "array", + "description": "The affected virtual storages. (Not supported)", + "items": { + "$ref": "#/definitions/AffectedVirtualStorage" + } + } + } + }, + "VnfInstantiateRequest": { + "type": "object", + "properties": { + "vnfInstanceName": { + "type": "string" + }, + "vnfPackageId": { + "type": "string" + }, + "vnfDescriptorId": { + "type": "string" + }, + "vnfInstanceDescription": { + "type": "string" + }, + "extVirtualLink": { + "type": "array", + "items": { + "$ref": "#/definitions/extVirtualLinkInfo" + } + }, + "additionalParam": { + "type": "object" + } + } + }, + "extVirtualLinkInfo":{ + "type": "object", + "properties": { + "resourceSubnetId": { + "type": "string", + "description": "The provider id of the subnet" + }, + "vlInstanceId": { + "type": "string", + "description" : "The identifier of the virtual link" + }, + "resourceId": { + "type": "string", + "description": "The provider id of the network" + }, + "cpdId": { + "type": "string", + "description": "The identifier of the connection point descriptor" + }, + "vim": { + "type": "object", + "properties": { + "vimid": { + "type": "string", + "description": "The identifier of the VIM" + } + } + } + } + }, + "VnfInstantiateResponse": { + "type": "object", + "properties": { + "vnfInstanceId": { + "type": "string" + }, + "jobId": { + "type": "string" + } + } + }, + "ScaleDirection" : { + "description": "The direction of the scaling", + "type": "string", + "enum": [ + "SCALE_IN", + "SCALE_OUT" + ] + }, + "VnfScaleRequest":{ + "type": "object", + "properties": { + "type": { + "description" : "The direction of the scaling.", + "$ref": "#/definitions/ScaleDirection" + }, + "aspectId":{ + "type": "string", + "description": "Identifies the aspect of the VNF that is requested to be scaled" + }, + "numberOfSteps": { + "type": "string", + "description": "Number of scaling steps to be executed as part of this ScaleVnf operation. It shall be a positive number" + }, + "additionalParam":{ + "type": "object", + "description": "Additional parameters passed by the NFVO as input to the scaling process, specific to the VNF being scaled" + } + } + }, + "VnfHealRequest":{ + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "affectedvm": { + "type": "object", + "properties": { + "vimid":{ + "type": "string" + }, + "vduid": { + "type": "string" + }, + "vmname":{ + "type": "string" + } + } + } + } + }, + "VnfTerminationType": { + "description": "The type of the termination.", + "type": "string", + "enum": [ + "graceful", + "forceful" + ] + }, + "VnfTerminateRequest":{ + "type": "object", + "properties": { + "terminationType": { + "description" : "The type of the termination", + "$ref": "#/definitions/VnfTerminationType" + }, + "gracefulTerminationTimeout": { + "description": "The time interval(second) to wait for the VNF to be taken out of service during graceful termination.", + "type": "string" + } + } + }, + "JobInfo": { + "type": "object", + "properties": { + "jobId": { + "type": "string" + } + } + }, + "VnfInfo": { + "type": "object", + "properties": { + "vnfInstanceId": { + "type": "string" + }, + "vnfInstanceName": { + "type": "string" + }, + "vnfInstanceDescription": { + "type": "string" + }, + "vnfdId": { + "type": "string" + }, + "vnfPackageId": { + "type": "string" + }, + "version": { + "type": "string" + }, + "vnfProvider": { + "type": "string" + }, + "vnfType": { + "type": "string" + }, + "vnfStatus": { + "type": "string" + } + } + }, + "vimInfo": { + "type": "object", + "properties": { + "vimInfoId": { + "type": "string" + }, + "vimId": { + "type": "string" + }, + "interfaceInfo": { + "type": "object", + "properties": { + "vimType": { + "type": "string", + "description": "The vim Type value wil be openstack" + }, + "apiVersion": { + "type": "string", + "description": "The api Version Type value will be " + }, + "protocolType": { + "type": "string", + "description": "The protocol Type value will be http or https" + } + } + }, + "accessInfo": { + "type": "object", + "properties": { + "tenant": { + "type": "string", + "description": "Tenant Name of tenant" + }, + "username": { + "type": "string", + "description": "Username for login" + }, + "password": { + "type": "string", + "description": "Password of login user" + } + } + }, + "interfaceEndpoint": { + "type": "string", + "description": "Information about the interface endpoint. It is a URL" + } + } + }, + "VnfPkgDetailInfo": { + "type": "object", + "properties": { + "csarId": { + "type": "string", + "description": "vnf package id, UUID" + }, + "packageInfo": { + "$ref": "#/definitions/VnfPkgInfo" + }, + "imageInfo": { + "$ref": "#/definitions/VnfPkgImgListInfo" + }, + "vnfInstanceInfo": { + "$ref": "#/definitions/VnfInstListInfo" + } + } + }, + "VnfPkgInfo": { + "type": "object", + "description": "vnf package infomation", + "properties": { + "vnfPackageId": { + "type": "string", + "description": "vnf package id (csarId)" + }, + "csarName": { + "type": "string", + "description": "The name of the csar" + }, + "vnfdId": { + "type": "string", + "description": "VNF descriptor ID" + }, + "vnfdProvider": { + "type": "string", + "description": "VNF descriptor vendor ID" + }, + "vnfdModel": { + "type": "string", + "description": "The model of the VNF (JSON) encoded to string" + }, + "vnfdVersion": { + "type": "string", + "description": "VNF descriptor version" + }, + "vnfVersion": { + "type": "string", + "description": "VNF Software version" + }, + "downloadUrl":{ + "type": "string", + "description": "The URL from which the VNF package can be downloaded" + } + } + }, + "VnfInstListInfo": { + "type": "array", + "items": { + "$ref": "#/definitions/VnfInstInfo" + } + }, + "VnfInstInfo": { + "type": "object", + "properties": { + "vnfInstanceId": { + "type": "string", + "description": "VNF instance ID" + }, + "vnfInstanceName": { + "type": "string", + "description": "VNF instance name" + } + } + }, + "VnfPkgImgListInfo": { + "type": "array", + "items": { + "$ref": "#/definitions/VnfPkgImgInfo" + } + }, + "VnfPkgImgInfo": { + "type": "object", + "properties": { + "fileName": { + "type": "string", + "description": "image file name" + }, + "imageUrl": { + "type": "string", + "description": "image file path in the csar or image url in external repository" + } + } + }, + "VnfmInfo": { + "type": "object", + "properties": { + "vnfmId": { + "type": "string", + "description": "vnfm Id" + }, + "name": { + "type": "string", + "description": "vnfm name" + }, + "type": { + "type": "string", + "description": "vnfm type" + }, + "url": { + "type": "string", + "description": "vnfm url" + }, + "userName": { + "type": "string", + "description": "vnfm login username" + }, + "password": { + "type": "string", + "description": "vnfm login password" + }, + "vimId": { + "type": "string", + "description": "vim Id" + }, + "vendor": { + "type": "string", + "description": "vendor name" + }, + "version": { + "type": "string", + "description": "vnfm version" + }, + "description": { + "type": "string", + "description": "vnfm description" + }, + "certificateUrl": { + "type": "string", + "description": "vnfm certificate Url" + }, + "createTime": { + "type": "string", + "description": "vnfm info createTime" + } + } + }, + "VimInfo": { + "type": "object", + "properties": { + "vimId": { + "type": "string", + "description": "vim Id" + }, + "name": { + "type": "string", + "description": "vim name" + }, + "type": { + "type": "string", + "description": "vim type" + }, + "url": { + "type": "string", + "description": "vim url" + }, + "userName": { + "type": "string", + "description": "vim login username" + }, + "password": { + "type": "string", + "description": "vim login password" + }, + "vendor": { + "type": "string", + "description": "vendor name" + }, + "version": { + "type": "string", + "description": "vim version" + }, + "description": { + "type": "string", + "description": "vim description" + }, + "createTime": { + "type": "string", + "description": "vim info createTime" + }, + "sslCacert": { + "type": "string", + "description": "The collection of trusted certificates towards the VIM connection." + }, + "sslInsecure": { + "type": "string", + "description": "Whether to verify VIM's certificate" + }, + "status": { + "type": "string", + "description": "The status of external system" + } + } + } + } +} |