@itentialopensource/adapter-onap_sdc

{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/v1/catalog/services/{serviceName}/{serviceVersion}/artifacts/{artifactName}": { "get": { "tags": [ "DistributionCatalogServlet" ], "operationId": "downloadServiceArtifact", "description": "The parameters and request body are for method: downloadServiceArtifact. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "serviceName", "in": "path", "required": true, "schema": { "title": "serviceName", "type": "string" } }, { "name": "serviceVersion", "in": "path", "required": true, "schema": { "title": "serviceVersion", "type": "string" } }, { "name": "artifactName", "in": "path", "required": true, "schema": { "title": "artifactName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/catalog/services/{serviceName}/{serviceVersion}/resourceInstances/{resourceInstanceName}/artifacts/{artifactName}": { "get": { "tags": [ "DistributionCatalogServlet" ], "operationId": "downloadResourceInstanceArtifactByName", "description": "The parameters and request body are for method: downloadResourceInstanceArtifactByName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "serviceName", "in": "path", "required": true, "schema": { "title": "serviceName", "type": "string" } }, { "name": "serviceVersion", "in": "path", "required": true, "schema": { "title": "serviceVersion", "type": "string" } }, { "name": "resourceInstanceName", "in": "path", "required": true, "schema": { "title": "resourceInstanceName", "type": "string" } }, { "name": "artifactName", "in": "path", "required": true, "schema": { "title": "artifactName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/catalog/services/{serviceName}/{serviceVersion}/resources/{resourceName}/{resourceVersion}/artifacts/{artifactName}": { "get": { "tags": [ "DistributionCatalogServlet" ], "operationId": "downloadResourceArtifact", "description": "The parameters and request body are for method: downloadResourceArtifact. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "serviceName", "in": "path", "required": true, "schema": { "title": "serviceName", "type": "string" } }, { "name": "serviceVersion", "in": "path", "required": true, "schema": { "title": "serviceVersion", "type": "string" } }, { "name": "resourceName", "in": "path", "required": true, "schema": { "title": "resourceName", "type": "string" } }, { "name": "resourceVersion", "in": "path", "required": true, "schema": { "title": "resourceVersion", "type": "string" } }, { "name": "artifactName", "in": "path", "required": true, "schema": { "title": "artifactName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/registerForDistribution": { "post": { "tags": [ "DistributionServlet" ], "operationId": "registerForDistribution", "description": "The parameters and request body are for method: registerForDistribution. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "distrNotificationTopicName": { "type": "string" }, "distrStatusTopicName": { "type": "string" } } }, "example": { "distrNotificationTopicName": "string", "distrStatusTopicName": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "requestJson" } } } } }, "/v1/artifactTypes": { "get": { "tags": [ "DistributionServlet" ], "operationId": "getValidArtifactTypes", "description": "The parameters and request body are for method: getValidArtifactTypes. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/unRegisterForDistribution": { "post": { "tags": [ "DistributionServlet" ], "operationId": "unRegisterForDistribution", "description": "The parameters and request body are for method: unRegisterForDistribution. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "distrNotificationTopicName": { "type": "string" }, "distrStatusTopicName": { "type": "string" }, "notificationUnregisterResult": { "type": "string" }, "statusUnregisterResult": { "type": "string" } } }, "example": { "distrNotificationTopicName": "string", "distrStatusTopicName": "string", "notificationUnregisterResult": "OK", "statusUnregisterResult": "OK" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "requestJson" } } } } }, "/v1/distributionUebCluster": { "get": { "tags": [ "DistributionServlet" ], "operationId": "getUebServerList", "description": "The parameters and request body are for method: getUebServerList. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "uebServerList": { "type": "array", "items": { "type": "string" } } } }, "example": { "uebServerList": [ "string", "string", "string", "string" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/catalog/{assetType}/{uuid}/artifacts": { "post": { "tags": [ "ArtifactExternalServlet" ], "operationId": "uploadArtifact", "description": "The parameters and request body are for method: uploadArtifact. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "payloadData": { "type": "array", "items": { "type": "string" } }, "listHeatParameters": { "type": "array", "items": { "type": "object", "properties": { "uniqueId": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "currentValue": { "type": "string" }, "defaultValue": { "type": "string" }, "empty": { "type": "boolean" }, "ownerId": { "type": "string" } } } }, "creationDate": { "type": "number" }, "timeout": { "type": "number" }, "esId": { "type": "string" }, "description": { "type": "string" }, "artifactLabel": { "type": "string" }, "artifactUUID": { "type": "string" }, "artifactVersion": { "type": "string" }, "heatParameters": { "type": "array", "items": { "type": "object", "properties": { "uniqueId": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "currentValue": { "type": "string" }, "defaultValue": { "type": "string" }, "empty": { "type": "boolean" }, "ownerId": { "type": "string" } } } }, "artifactGroupType": { "type": "string" }, "heatParamsUpdateDate": { "type": "number" }, "artifactChecksum": { "type": "string" }, "generatedFromId": { "type": "string" }, "mandatory": { "type": "boolean" }, "serviceApi": { "type": "boolean" }, "payloadUpdateDate": { "type": "number" }, "artifactName": { "type": "string" }, "artifactType": { "type": "string" }, "artifactRef": { "type": "string" }, "apiUrl": { "type": "string" }, "artifactRepository": { "type": "string" }, "userIdCreator": { "type": "string" }, "artifactCreator": { "type": "string" }, "userIdLastUpdater": { "type": "string" }, "updaterFullName": { "type": "string" }, "isFromCsar": { "type": "boolean" }, "requiredArtifacts": { "type": "array", "items": { "type": "string" } }, "creatorFullName": { "type": "string" }, "artifactDisplayName": { "type": "string" }, "uniqueId": { "type": "string" }, "generated": { "type": "boolean" }, "duplicated": { "type": "boolean" }, "lastUpdateDate": { "type": "number" }, "empty": { "type": "boolean" }, "ownerId": { "type": "string" } } }, "example": { "payloadData": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "listHeatParameters": [ { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": false, "ownerId": "string" } ], "creationDate": 6, "timeout": 10, "esId": "string", "description": "string", "artifactLabel": "string", "artifactUUID": "string", "artifactVersion": "string", "heatParameters": [ { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" } ], "artifactGroupType": "LIFE_CYCLE", "heatParamsUpdateDate": 8, "artifactChecksum": "string", "generatedFromId": "string", "mandatory": true, "serviceApi": true, "payloadUpdateDate": 4, "artifactName": "string", "artifactType": "string", "artifactRef": "string", "apiUrl": "string", "artifactRepository": "string", "userIdCreator": "string", "artifactCreator": "string", "userIdLastUpdater": "string", "updaterFullName": "string", "isFromCsar": true, "requiredArtifacts": [ "string", "string", "string", "string", "string", "string" ], "creatorFullName": "string", "artifactDisplayName": "string", "uniqueId": "string", "generated": false, "duplicated": true, "lastUpdateDate": 4, "empty": true, "ownerId": "string" } } } } }, "parameters": [ { "name": "assetType", "in": "path", "required": true, "schema": { "title": "assetType", "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}": { "get": { "tags": [ "ArtifactExternalServlet" ], "operationId": "downloadComponentArtifact", "description": "The parameters and request body are for method: downloadComponentArtifact. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "assetType", "in": "path", "required": true, "schema": { "title": "assetType", "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } }, { "name": "artifactUUID", "in": "path", "required": true, "schema": { "title": "artifactUUID", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "ArtifactExternalServlet" ], "operationId": "updateArtifact", "description": "The parameters and request body are for method: updateArtifact. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "payloadData": { "type": "array", "items": { "type": "string" } }, "listHeatParameters": { "type": "array", "items": { "type": "object", "properties": { "uniqueId": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "currentValue": { "type": "string" }, "defaultValue": { "type": "string" }, "empty": { "type": "boolean" }, "ownerId": { "type": "string" } } } }, "creationDate": { "type": "number" }, "timeout": { "type": "number" }, "esId": { "type": "string" }, "description": { "type": "string" }, "artifactLabel": { "type": "string" }, "artifactUUID": { "type": "string" }, "artifactVersion": { "type": "string" }, "heatParameters": { "type": "array", "items": { "type": "object", "properties": { "uniqueId": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "currentValue": { "type": "string" }, "defaultValue": { "type": "string" }, "empty": { "type": "boolean" }, "ownerId": { "type": "string" } } } }, "artifactGroupType": { "type": "string" }, "heatParamsUpdateDate": { "type": "number" }, "artifactChecksum": { "type": "string" }, "generatedFromId": { "type": "string" }, "mandatory": { "type": "boolean" }, "serviceApi": { "type": "boolean" }, "payloadUpdateDate": { "type": "number" }, "artifactName": { "type": "string" }, "artifactType": { "type": "string" }, "artifactRef": { "type": "string" }, "apiUrl": { "type": "string" }, "artifactRepository": { "type": "string" }, "userIdCreator": { "type": "string" }, "artifactCreator": { "type": "string" }, "userIdLastUpdater": { "type": "string" }, "updaterFullName": { "type": "string" }, "isFromCsar": { "type": "boolean" }, "requiredArtifacts": { "type": "array", "items": { "type": "string" } }, "creatorFullName": { "type": "string" }, "artifactDisplayName": { "type": "string" }, "uniqueId": { "type": "string" }, "generated": { "type": "boolean" }, "duplicated": { "type": "boolean" }, "lastUpdateDate": { "type": "number" }, "empty": { "type": "boolean" }, "ownerId": { "type": "string" } } }, "example": { "payloadData": [ "string", "string", "string" ], "listHeatParameters": [ { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": false, "ownerId": "string" } ], "creationDate": 7, "timeout": 6, "esId": "string", "description": "string", "artifactLabel": "string", "artifactUUID": "string", "artifactVersion": "string", "heatParameters": [ { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": false, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" } ], "artifactGroupType": "OTHER", "heatParamsUpdateDate": 5, "artifactChecksum": "string", "generatedFromId": "string", "mandatory": true, "serviceApi": false, "payloadUpdateDate": 8, "artifactName": "string", "artifactType": "string", "artifactRef": "string", "apiUrl": "string", "artifactRepository": "string", "userIdCreator": "string", "artifactCreator": "string", "userIdLastUpdater": "string", "updaterFullName": "string", "isFromCsar": true, "requiredArtifacts": [ "string", "string", "string", "string", "string" ], "creatorFullName": "string", "artifactDisplayName": "string", "uniqueId": "string", "generated": true, "duplicated": false, "lastUpdateDate": 3, "empty": false, "ownerId": "string" } } } } }, "parameters": [ { "name": "assetType", "in": "path", "required": true, "schema": { "title": "assetType", "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } }, { "name": "artifactUUID", "in": "path", "required": true, "schema": { "title": "artifactUUID", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "ArtifactExternalServlet" ], "operationId": "deleteArtifact", "description": "The parameters and request body are for method: deleteArtifact. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "payloadData": { "type": "array", "items": { "type": "string" } }, "listHeatParameters": { "type": "array", "items": { "type": "object", "properties": { "uniqueId": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "currentValue": { "type": "string" }, "defaultValue": { "type": "string" }, "empty": { "type": "boolean" }, "ownerId": { "type": "string" } } } }, "creationDate": { "type": "number" }, "timeout": { "type": "number" }, "esId": { "type": "string" }, "description": { "type": "string" }, "artifactLabel": { "type": "string" }, "artifactUUID": { "type": "string" }, "artifactVersion": { "type": "string" }, "heatParameters": { "type": "array", "items": { "type": "object", "properties": { "uniqueId": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "currentValue": { "type": "string" }, "defaultValue": { "type": "string" }, "empty": { "type": "boolean" }, "ownerId": { "type": "string" } } } }, "artifactGroupType": { "type": "string" }, "heatParamsUpdateDate": { "type": "number" }, "artifactChecksum": { "type": "string" }, "generatedFromId": { "type": "string" }, "mandatory": { "type": "boolean" }, "serviceApi": { "type": "boolean" }, "payloadUpdateDate": { "type": "number" }, "artifactName": { "type": "string" }, "artifactType": { "type": "string" }, "artifactRef": { "type": "string" }, "apiUrl": { "type": "string" }, "artifactRepository": { "type": "string" }, "userIdCreator": { "type": "string" }, "artifactCreator": { "type": "string" }, "userIdLastUpdater": { "type": "string" }, "updaterFullName": { "type": "string" }, "isFromCsar": { "type": "boolean" }, "requiredArtifacts": { "type": "array", "items": { "type": "string" } }, "creatorFullName": { "type": "string" }, "artifactDisplayName": { "type": "string" }, "uniqueId": { "type": "string" }, "generated": { "type": "boolean" }, "duplicated": { "type": "boolean" }, "lastUpdateDate": { "type": "number" }, "empty": { "type": "boolean" }, "ownerId": { "type": "string" } } }, "example": { "payloadData": [ "string", "string" ], "listHeatParameters": [ { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": false, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": false, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": false, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": false, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": false, "ownerId": "string" } ], "creationDate": 6, "timeout": 4, "esId": "string", "description": "string", "artifactLabel": "string", "artifactUUID": "string", "artifactVersion": "string", "heatParameters": [ { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": false, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" }, { "uniqueId": "string", "name": "string", "type": "string", "description": "string", "currentValue": "string", "defaultValue": "string", "empty": true, "ownerId": "string" } ], "artifactGroupType": "OTHER", "heatParamsUpdateDate": 4, "artifactChecksum": "string", "generatedFromId": "string", "mandatory": false, "serviceApi": true, "payloadUpdateDate": 8, "artifactName": "string", "artifactType": "string", "artifactRef": "string", "apiUrl": "string", "artifactRepository": "string", "userIdCreator": "string", "artifactCreator": "string", "userIdLastUpdater": "string", "updaterFullName": "string", "isFromCsar": false, "requiredArtifacts": [ "string", "string", "string", "string", "string", "string" ], "creatorFullName": "string", "artifactDisplayName": "string", "uniqueId": "string", "generated": true, "duplicated":