UNPKG

@itentialopensource/adapter-etsi_sol003

Version:

This adapter integrates with system described as: ETSI sol003

1,558 lines (1,557 loc) 15.5 MB
{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/vrqan/v1/api_versions": { "get": { "tags": [ "ApiVersions" ], "operationId": "getApiVersions", "description": "The parameters and request body are for method: getApiVersions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "uriPrefix": { "type": "string" }, "apiVersions": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "string" }, "isDeprecated": { "type": "boolean" }, "retirementDate": { "type": "string" } } } } } }, "example": { "uriPrefix": "string", "apiVersions": [ { "version": "string", "isDeprecated": false, "retirementDate": "string" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vrqan/v1/subscriptions": { "post": { "tags": [ "Subscriptions" ], "operationId": "postSubscriptions", "description": "The parameters and request body are for method: postSubscriptions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "filter": { "type": "object", "properties": { "vimIds": { "type": "array", "items": { "type": "string" } }, "resourceProviderIds": { "type": "array", "items": { "type": "string" } }, "resourceTypes": { "type": "array", "items": { "type": "string" } }, "resourceGroupIds": { "type": "array", "items": { "type": "string" } } } }, "callbackUri": { "type": "string" }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string" } } } } } } }, "example": { "id": "string", "filter": { "vimIds": [ "string", "string", "string", "string", "string" ], "resourceProviderIds": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "resourceTypes": [ "NETWORK", "COMPUTE", "STORAGE" ], "resourceGroupIds": [ "string", "string", "string", "string", "string", "string", "string" ] }, "callbackUri": "string", "_links": { "self": { "href": "string" } } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "tags": [ "Subscriptions" ], "operationId": "getSubscriptions", "description": "The parameters and request body are for method: getSubscriptions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "filter": { "type": "object", "properties": { "vimIds": { "type": "array", "items": { "type": "string" } }, "resourceProviderIds": { "type": "array", "items": { "type": "string" } }, "resourceTypes": { "type": "array", "items": { "type": "string" } }, "resourceGroupIds": { "type": "array", "items": { "type": "string" } } } }, "callbackUri": { "type": "string" }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string" } } } } } } } }, "example": [ { "id": "string", "filter": { "vimIds": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "resourceProviderIds": [ "string", "string", "string", "string", "string" ], "resourceTypes": [ "STORAGE", "COMPUTE", "COMPUTE", "STORAGE", "STORAGE", "COMPUTE", "COMPUTE", "COMPUTE", "COMPUTE" ], "resourceGroupIds": [ "string", "string", "string", "string" ] }, "callbackUri": "string", "_links": { "self": { "href": "string" } } }, { "id": "string", "filter": { "vimIds": [ "string", "string", "string", "string", "string", "string", "string" ], "resourceProviderIds": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "resourceTypes": [ "COMPUTE" ], "resourceGroupIds": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ] }, "callbackUri": "string", "_links": { "self": { "href": "string" } } }, { "id": "string", "filter": { "vimIds": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "resourceProviderIds": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "resourceTypes": [ "COMPUTE", "NETWORK", "COMPUTE", "STORAGE", "NETWORK", "NETWORK", "COMPUTE", "NETWORK" ], "resourceGroupIds": [ "string", "string", "string", "string", "string", "string", "string" ] }, "callbackUri": "string", "_links": { "self": { "href": "string" } } } ] } } } }, "parameters": [ { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "nextpageOpaqueMarker", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vrqan/v1/subscriptions/{subscriptionId}": { "get": { "tags": [ "Subscriptions" ], "operationId": "getSubscriptionsSubscriptionId", "description": "The parameters and request body are for method: getSubscriptionsSubscriptionId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "filter": { "type": "object", "properties": { "vimIds": { "type": "array", "items": { "type": "string" } }, "resourceProviderIds": { "type": "array", "items": { "type": "string" } }, "resourceTypes": { "type": "array", "items": { "type": "string" } }, "resourceGroupIds": { "type": "array", "items": { "type": "string" } } } }, "callbackUri": { "type": "string" }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string" } } } } } } }, "example": { "id": "string", "filter": { "vimIds": [ "string", "string", "string", "string" ], "resourceProviderIds": [ "string", "string" ], "resourceTypes": [ "COMPUTE", "STORAGE", "STORAGE", "NETWORK", "NETWORK", "NETWORK", "COMPUTE" ], "resourceGroupIds": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ] }, "callbackUri": "string", "_links": { "self": { "href": "string" } } } } } } }, "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "title": "subscriptionId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Subscriptions" ], "operationId": "deleteSubscriptionsSubscriptionId", "description": "The parameters and request body are for method: deleteSubscriptionsSubscriptionId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "title": "subscriptionId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vnffm/v1/alarms": { "get": { "tags": [ "Alarms" ], "operationId": "getAlarms", "description": "The parameters and request body are for method: getAlarms. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "managedObjectId": { "type": "string" }, "rootCauseFaultyResource": { "type": "object", "properties": { "faultyResource": { "type": "object", "properties": { "vimConnectionId": { "type": "string" }, "resourceProviderId": { "type": "string" }, "resourceId": { "type": "string" }, "vimLevelResourceType": { "type": "string" } } }, "faultyResourceType": { "type": "string" } } }, "alarmRaisedTime": { "type": "string" }, "alarmChangedTime": { "type": "string" }, "alarmClearedTime": { "type": "string" }, "alarmAcknowledgedTime": { "type": "string" }, "ackState": { "type": "string" }, "perceivedSeverity": { "type": "string" }, "eventTime": { "type": "string" }, "eventType": { "type": "string" }, "faultType": { "type": "string" }, "probableCause": { "type": "string" }, "isRootCause": { "type": "boolean" }, "correlatedAlarmIds": { "type": "array", "items": { "type": "string" } }, "faultDetails": { "type": "array", "items": { "type": "string" } }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string" } } }, "objectInstance": { "type": "object", "properties": { "href": { "type": "string" } } } } } } }, "example": { "id": "string", "managedObjectId": "string", "rootCauseFaultyResource": { "faultyResource": { "vimConnectionId": "string", "resourceProviderId": "string", "resourceId": "string", "vimLevelResourceType": "string" }, "faultyResourceType": "NETWORK" }, "alarmRaisedTime": "string", "alarmChangedTime": "string", "alarmClearedTime": "string", "alarmAcknowledgedTime": "string", "ackState": "ACKNOWLEDGED", "perceivedSeverity": "WARNING", "eventTime": "string", "eventType": "COMMUNICATIONS_ALARM", "faultType": "string", "probableCause": "string", "isRootCause": true, "correlatedAlarmIds": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "faultDetails": [ "string" ], "_links": { "self": { "href": "string" }, "objectInstance": { "href": "string" } } } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "nextpageOpaqueMarker", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vnffm/v1/alarms/{alarmId}": { "get": { "tags": [ "Alarms" ], "operationId": "getAlarmsAlarmId", "description": "The parameters and request body are for method: getAlarmsAlarmId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "managedObjectId": { "type": "string" }, "rootCauseFaultyResource": { "type": "object", "properties": { "faultyResource": { "type": "object", "properties": { "vimConnectionId": { "type": "string" }, "resourceProviderId": { "type": "string" }, "resourceId": { "type": "string" }, "vimLevelResourceType": { "type": "string" } } }, "faultyResourceType": { "type": "string" } } }, "alarmRaisedTime": { "type": "string" }, "alarmChangedTime": { "type": "string" }, "alarmClearedTime": { "type": "string" }, "alarmAcknowledgedTime": { "type": "string" }, "ackState": { "type": "string" }, "perceivedSeverity": { "type": "string" }, "eventTime": { "type": "string" }, "eventType": { "type": "string" }, "faultType": { "type": "string" }, "probableCause": { "type": "string" }, "isRootCause": { "type": "boolean" }, "correlatedAlarmIds": { "type": "array", "items": { "type": "string" } }, "faultDetails": { "type": "array", "items": { "type": "string" } }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string" } } }, "objectInstance": { "type": "object", "properties": { "href": { "type": "string" } } } } } } }, "example": { "id": "string", "managedObjectId": "string", "rootCauseFaultyResource": { "faultyResource": { "vimConnectionId": "string", "resourceProviderId": "string", "resourceId": "string", "vimLevelResourceType": "string" }, "faultyResourceType": "COMPUTE" }, "alarmRaisedTime": "string", "alarmChangedTime": "string", "alarmClearedTime": "string", "alarmAcknowledgedTime": "string", "ackState": "UNACKNOWLEDGED", "perceivedSeverity": "WARNING", "eventTime": "string", "eventType": "ENVIRONMENTAL_ALARM", "faultType": "string", "probableCause": "string", "isRootCause": true, "correlatedAlarmIds": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "faultDetails": [ "string", "string", "string", "string", "string", "string" ], "_links": { "self": { "href": "string" }, "objectInstance": { "href": "string" } } } } } } }, "parameters": [ { "name": "alarmId", "in": "path", "required": true, "schema": { "title": "alarmId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Alarms" ], "operationId": "patchAlarmsAlarmId", "description": "The parameters and request body are for method: patchAlarmsAlarmId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ackState": { "type": "string" } } }, "example": { "ackState": "UNACKNOWLEDGED" } } } } }, "parameters": [ { "name": "alarmId", "in": "path", "required": true, "schema": { "title": "alarmId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/vnfind/v1/indicators": { "get": { "tags": [ "Indicators" ], "operationId": "getIndicators", "description": "The parameters and request body are for method: getIndicators. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "object" }, "vnfInstanceId": { "type": "string" }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string" } } }, "vnfInstance": { "type": "object", "properties": { "href": { "type": "string" } } } } } } } }, "example": [ { "id": "string", "name": "string", "value": {}, "vnfInstanceId": "string", "_links": { "self": { "href": "string" }, "vnfInstance": { "href": "string" } } }, { "id": "string", "name": "string", "value": {}, "vnfInstanceId": "string", "_links": { "self": { "href": "string" }, "vnfInstance": { "href": "string" } } }, { "id": "string", "name": "string", "value": {}, "vnfInstanceId": "string", "_links": { "self": { "href": "string" }, "vnfInstance": { "href": "string" } } }, { "id": "string", "name": "string", "value": {}, "vnfInstanceId": "string", "_links": { "self": { "href": "string" }, "vnfInstance": { "href": "string" } } } ] } } } }, "parameters": [ { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "nextpageOpaqueMarker", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vnfind/v1/indicators/{vnfInstanceId}": { "get": { "tags": [ "Indicators" ], "operationId": "getIndicatorsVnfInstanceId", "description": "The parameters and request body are for method: getIndicatorsVnfInstanceId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "object" }, "vnfInstanceId": { "type": "string" }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string" } } }, "vnfInstance": { "type": "object", "properties": { "href": { "type": "string" } } } } } } } }, "example": [ { "id": "string", "name": "string", "value": {}, "vnfInstanceId": "string", "_links": { "self": { "href": "string" }, "vnfInstance": { "href": "string" } } } ] } } } }, "parameters": [ { "name": "vnfInstanceId", "in": "path", "required": true, "schema": { "title": "vnfInstanceId", "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "nextpageOpaqueMarker", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vnfind/v1/indicators/{indicatorId}/{vnfInstanceId}": { "get": { "tags": [ "Indicators" ], "operationId": "getIndicatorsVnfInstanceIdIndicatorId", "description": "The parameters and request body are for method: getIndicatorsVnfInstanceIdIndicatorId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "object" }, "vnfInstanceId": { "type": "string" }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string" } } }, "vnfInstance": { "type": "object", "properties": { "href": { "type": "string" } } } } } } }, "example": { "id": "string", "name": "string", "value": {}, "vnfInstanceId": "string", "_links": { "self": { "href": "string" }, "vnfInstance": { "href": "string" } } } } } } }, "parameters": [ { "name": "indicatorId", "in": "path", "required": true, "schema": { "title": "indicatorId", "type": "string" } }, { "name": "vnfInstanceId", "in": "path", "required": true, "schema": { "title": "vnfInstanceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vnfind/v1/indicators/subscriptions/{subscriptionId}": { "get": { "tags": [ "Indicators" ], "operationId": "getIndicatorsSubscriptionsSubscriptionId", "description": "The parameters and request body are for method: getIndicatorsSubscriptionsSubscriptionId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "filter": { "type": "object", "properties": { "vnfInstanceSubscriptionFilter": { "type": "object", "properties": { "vnfdIds": { "type": "array", "items": { "type": "string" } }, "vnfProductsFromProviders": { "type": "array", "items": { "type": "object", "properties": { "vnfProvider": { "type": "string" }, "vnfProducts": { "type": "array", "items": { "type": "object", "properties": { "vnfProductName": { "type": "string" }, "versions": { "type": "array", "items": { "type": "object", "properties": { "vnfSoftwareVersion": { "type": "string" }, "vnfdVersions": { "type": "array", "items": { "type": "string" } } } } } } } } } } }, "vnfInstanceIds": { "type": "array", "items": { "type": "string" } }, "vnfInstanceNames": { "type": "array", "items": { "type": "string" } } } }, "notificationTypes": { "type": "string" }, "indicatorIds": { "type": "array", "items": { "type": "string" } } } }, "callbackUri": { "type": "string" }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string" } } } } } } }, "example": { "id": "string", "filter": { "vnfInstanceSubscriptionFilter": { "vnfdIds": [ "string", "string", "string", "string" ], "vnfProductsFromProviders": [ { "vnfProvider": "string", "vnfProducts": [ { "vnfProductName": "string", "versions": [ { "vnfSoftwareVersion": "string", "vnfdVersions": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ] } ] }, { "vnfProductName": "string", "versions": [ { "vnfSoftwareVersion": "string", "vnfdVersions": [