diff options
Diffstat (limited to 'docs/openapi/openapi-sdce-1.yaml')
| -rw-r--r-- | docs/openapi/openapi-sdce-1.yaml | 7963 |
1 files changed, 7963 insertions, 0 deletions
diff --git a/docs/openapi/openapi-sdce-1.yaml b/docs/openapi/openapi-sdce-1.yaml new file mode 100644 index 0000000000..3dd236e9e6 --- /dev/null +++ b/docs/openapi/openapi-sdce-1.yaml @@ -0,0 +1,7963 @@ +openapi: 3.0.1 +info: + contact: + email: onap-discuss@lists.onap.org + name: ONAP + url: https://onap.readthedocs.io + description: SDC API for onboarding (SDCE-1) + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0 + title: "SPC API: SDCE-1" + version: "1.0" +servers: +- description: SDCE-1 APIs + url: /sdc +paths: + /application.wadl: + get: + operationId: getWadl + responses: + default: + content: + application/vnd.sun.wadl+xml: {} + application/xml: {} + description: default response + /application.wadl/{path}: + get: + operationId: getExternalGrammar + parameters: + - in: path + name: path + required: true + schema: + type: string + responses: + default: + content: + application/xml: {} + description: default response + /v1.0/actuator/prometheus: + get: + description: Gets the prometheus micrometer application metrics + operationId: prometheusMetrics + parameters: + - description: The Accept header to determine the output content type + in: header + name: Accept + schema: + type: string + responses: + default: + content: + '*/*': + schema: + type: string + description: default response + summary: Prometheus Micrometer Metrics + tags: + - SDCE-1 APIs + /v1.0/application-configuration: + post: + description: Insert JSON schema into application config table + operationId: insertToTable + parameters: + - in: query + name: namespace + schema: + type: string + - in: query + name: key + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Application Configuration + /v1.0/application-configuration/{namespace}: + get: + description: Get List of keys and descriptions by namespace + operationId: getListOfConfigurationByNamespaceFromTable + parameters: + - in: path + name: namespace + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ApplicationConfigDto' + tags: + - SDCE-1 APIs + - Application Configuration + /v1.0/application-configuration/{namespace}/{key}: + get: + description: Get JSON schema by namespace and key + operationId: getFromTable + parameters: + - in: path + name: namespace + required: true + schema: + type: string + - in: path + name: key + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigurationDataDto' + tags: + - SDCE-1 APIs + - Application Configuration + /v1.0/externaltesting/config: + get: + operationId: getConfig + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + put: + operationId: setConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClientConfiguration' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/externaltesting/endpoints: + get: + operationId: getEndpoints + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + put: + operationId: setEndpoints + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RemoteTestingEndpointDefinition' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/externaltesting/endpoints/{endpointId}/executions/{executionId}: + post: + operationId: getExecution + parameters: + - in: path + name: endpointId + required: true + schema: + type: string + - in: path + name: executionId + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/externaltesting/endpoints/{endpointId}/scenarios: + get: + operationId: getScenarios + parameters: + - in: path + name: endpointId + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/externaltesting/endpoints/{endpointId}/scenarios/{scenario}/testcases: + get: + operationId: getTestcases + parameters: + - in: path + name: endpointId + required: true + schema: + type: string + - in: path + name: scenario + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/externaltesting/endpoints/{endpointId}/scenarios/{scenario}/testsuites: + get: + operationId: getTestsuites + parameters: + - in: path + name: endpointId + required: true + schema: + type: string + - in: path + name: scenario + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/externaltesting/endpoints/{endpointId}/scenarios/{scenario}/testsuites/{testsuite}/testcases/{testcase}: + get: + operationId: getTestcase + parameters: + - in: path + name: endpointId + required: true + schema: + type: string + - in: path + name: scenario + required: true + schema: + type: string + - in: path + name: testsuite + required: true + schema: + type: string + - in: path + name: testcase + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/externaltesting/executions: + get: + operationId: getValidationResult + parameters: + - in: query + name: requestId + schema: + type: string + - in: query + name: endPoint + schema: + type: array + items: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + post: + operationId: execute + parameters: + - in: query + name: vspId + schema: + type: string + - in: query + name: vspVersionId + schema: + type: string + - in: query + name: requestId + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/Attachment' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/externaltesting/testcasetree: + get: + operationId: getTestCasesAsTree + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - External-Testing + /v1.0/healthcheck: + get: + description: Perform health check + operationId: checkHealth + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/HealthInfoDtos' + tags: + - SDCE-1 APIs + - Health Check + /v1.0/items: + get: + description: Get list of items according to desired filters + operationId: list + parameters: + - description: Filter by item status + in: query + name: itemStatus + schema: + type: string + enum: + - ACTIVE + - ARCHIVED + - description: Filter by version status + in: query + name: versionStatus + schema: + type: string + enum: + - Certified + - Draft + - description: Filter by item type + in: query + name: itemType + schema: + type: string + enum: + - vsp + - vlm + - description: Filter by user permission + in: query + name: permission + schema: + type: string + enum: + - Owner + - Contributor + - description: Filter by onboarding method + in: query + name: onboardingMethod + schema: + type: string + enum: + - NetworkPackage + - manual + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Item' + tags: + - SDCE-1 APIs + - Items + /v1.0/items/{itemId}: + get: + description: Get details of a item + operationId: getItem + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Items + /v1.0/items/{itemId}/actions: + put: + description: Acts on item version + operationId: actOn + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ItemActionRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Items + /v1.0/items/{itemId}/permissions: + get: + description: List users permissions assigned on item + operationId: list_2 + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ItemPermissionsDto' + tags: + - SDCE-1 APIs + - Item Permissions + /v1.0/items/{itemId}/permissions/{permission}: + put: + description: Update useres permission on item + operationId: updatePermissions + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: path + name: permission + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ItemPermissionsRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Item Permissions + /v1.0/items/{itemId}/versions: + get: + description: Lists item versions + operationId: list_1 + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VersionDto' + tags: + - SDCE-1 APIs + - Item Versions + /v1.0/items/{itemId}/versions/{versionId}: + get: + description: Gets item version + operationId: get + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/VersionDto' + tags: + - SDCE-1 APIs + - Item Versions + post: + description: Creates a new item version + operationId: create + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VersionRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Item Versions + /v1.0/items/{itemId}/versions/{versionId}/actions: + put: + description: Acts on item version + operationId: actOn_1 + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VersionActionRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Item Versions + /v1.0/items/{itemId}/versions/{versionId}/activity-logs: + get: + description: Gets item version activity log + operationId: getActivityLog + parameters: + - description: Item Id + in: path + name: itemId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivityLogDto' + tags: + - SDCE-1 APIs + - Item Versions + /v1.0/items/{itemId}/versions/{versionId}/conflicts: + get: + description: item version conflicts + operationId: getConflict + parameters: + - description: Item Id + in: path + name: itemId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ItemVersionConflictDto' + summary: Item version private copy conflicts against its public copy + tags: + - SDCE-1 APIs + - Item Version Conflicts + /v1.0/items/{itemId}/versions/{versionId}/conflicts/{conflictId}: + get: + description: Gets item version conflict + operationId: getConflict_1 + parameters: + - description: Item Id + in: path + name: itemId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Version Id + in: path + name: conflictId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ConflictDto' + summary: Gets an item version private copy conflict against its public copy + tags: + - SDCE-1 APIs + - Item Version Conflicts + put: + description: Resolves item version conflict + operationId: resolveConflict + parameters: + - description: Item Id + in: path + name: itemId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Version Id + in: path + name: conflictId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConflictResolutionDto' + responses: + default: + content: + application/json: {} + description: default response + summary: Resolves an item version private copy conflict against its public copy + tags: + - SDCE-1 APIs + - Item Version Conflicts + /v1.0/items/{itemId}/versions/{versionId}/revisions: + get: + description: Gets item version revisions + operationId: listRevisions + parameters: + - in: path + name: itemId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivityLogDto' + tags: + - SDCE-1 APIs + - Item Versions + /v1.0/notifications: + get: + description: Retrieve all user notifications + operationId: getNotifications + parameters: + - in: header + name: USER_ID + required: true + schema: + type: string + - in: query + name: LAST_DELIVERED_EVENT_ID + schema: + type: string + format: uuid + - in: query + name: END_OF_PAGE_EVENT_ID + schema: + type: string + format: uuid + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationsStatusDto' + tags: + - SDCE-1 APIs + - Notifications + /v1.0/notifications/last-seen/{notificationId}: + put: + description: Update Last Seen Notification + operationId: updateLastSeenNotification + parameters: + - description: Notification Id + in: path + name: notificationId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateNotificationResponseStatus' + tags: + - SDCE-1 APIs + - Notifications + /v1.0/notifications/worker: + get: + description: Retrive user not delivered notifications + operationId: getNewNotificationsByOwnerId + parameters: + - in: header + name: USER_ID + required: true + schema: + type: string + - in: query + name: LAST_DELIVERED_EVENT_ID + schema: + type: string + - in: query + name: NOTIFICATION_ROWS_LIMIT + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationsStatusDto' + tags: + - SDCE-1 APIs + - Notifications + /v1.0/notifications/{notificationId}: + put: + description: Mark notification as read + operationId: markAsRead + parameters: + - description: Notification Id + in: path + name: notificationId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateNotificationResponseStatus' + tags: + - SDCE-1 APIs + - Notifications + /v1.0/togglz: + get: + description: Get TOGGLZ Features + operationId: getFeatures + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FeatureSetDto' + tags: + - SDCE-1 APIs + - Togglz + /v1.0/togglz/state/{state}: + put: + description: Update feature toggle state for all features + operationId: setAllFeatures + parameters: + - in: path + name: state + required: true + schema: + type: boolean + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Togglz + /v1.0/togglz/{featureName}/state: + get: + description: Get feature toggle state + operationId: getFeatureState + parameters: + - in: path + name: featureName + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/FeatureDto' + tags: + - SDCE-1 APIs + - Togglz + /v1.0/togglz/{featureName}/state/{state}: + put: + description: Update feature toggle state + operationId: setFeatureState + parameters: + - in: path + name: featureName + required: true + schema: + type: string + - in: path + name: state + required: true + schema: + type: boolean + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Togglz + /v1.0/unique-types: + get: + description: Lists unique value types + operationId: listUniqueTypes + parameters: + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Unique Types + /v1.0/unique-types/{type}/values/{value}: + get: + description: Gets unique value + operationId: getUniqueValue + parameters: + - description: "The unique value type, for example: 'VlmName'" + in: path + name: type + required: true + schema: + type: string + - description: The unique value + in: path + name: value + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + "200": + description: Indication whether the unique value is occupied + "404": + description: Unsupported unique type + tags: + - SDCE-1 APIs + - Unique Types + /v1.0/validation/{type}/validate: + post: + description: Validate a package + operationId: validateFile_1 + parameters: + - in: path + name: type + required: true + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Validation + /v1.0/vendor-license-models: + get: + description: List vendor license models + operationId: listLicenseModels + parameters: + - description: "Filter to return only Vendor License Models with at least one\ + \ version at this status. Currently supported values: 'Certified' , 'Draft'" + in: query + name: versionFilter + schema: + type: string + - description: "Filter to only return Vendor License Models at this status.Currently\ + \ supported values: 'ACTIVE' , 'ARCHIVED'.Default value = 'ACTIVE'." + in: query + name: Status + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ItemDto' + tags: + - SDCE-1 APIs + - Vendor License Models + post: + description: Create vendor license model + operationId: createLicenseModel + parameters: + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VendorLicenseModelRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Models + /v1.0/vendor-license-models/{vlmId}: + delete: + description: Delete vendor license model + operationId: deleteLicenseModel + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Models + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}: + get: + description: Get vendor license model + operationId: getLicenseModel + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/VendorLicenseModelEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Models + put: + description: Update vendor license model + operationId: updateLicenseModel + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VendorLicenseModelRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Models + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/actions: + put: + description: Update vendor license model + operationId: actOnLicenseModel + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VendorLicenseModelActionRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Models + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/entitlement-pools: + get: + description: List vendor entitlement pools + operationId: listEntitlementPools + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/EntitlementPoolEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pools + post: + description: Create vendor entitlement pool + operationId: createEntitlementPool + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EntitlementPoolRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pools + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/entitlement-pools/{entitlementPoolId}: + delete: + description: Delete vendor entitlement pool + operationId: deleteEntitlementPool + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: entitlementPoolId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pools + get: + description: Get vendor entitlement pool + operationId: getEntitlementPool + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: entitlementPoolId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/EntitlementPoolEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pools + put: + description: Update vendor entitlement pool + operationId: updateEntitlementPool + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: entitlementPoolId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EntitlementPoolRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pools + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/entitlement-pools/{entitlementPoolId}/limits: + get: + description: List vendor entitlement pool limits + operationId: listLimits + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model Entitlement Pool Id + in: path + name: entitlementPoolId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LimitRequestDto' + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pool Limits + post: + description: Create vendor entitlement pool limits + operationId: createLimit + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model Entitlement Pool Id + in: path + name: entitlementPoolId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LimitRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pool Limits + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/entitlement-pools/{entitlementPoolId}/limits/{limitId}: + delete: + description: Delete vendor entitlement pool limit + operationId: deleteLimit + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model Entitlement pool Id + in: path + name: entitlementPoolId + required: true + schema: + type: string + - in: path + name: limitId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pool Limits + get: + description: Get vendor entitlement pool limit + operationId: getLimit + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model Entitlement Pool Id + in: path + name: entitlementPoolId + required: true + schema: + type: string + - description: Vendor license model Entitlement Pool Limit Id + in: path + name: limitId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/LimitEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pool Limits + put: + description: Update vendor entitlement pool limit + operationId: updateLimit + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model Entitlement Pool Id + in: path + name: entitlementPoolId + required: true + schema: + type: string + - in: path + name: limitId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LimitRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Entitlement Pool Limits + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/feature-groups: + get: + description: List vendor feature groups + operationId: listFeatureGroups + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FeatureGroupEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - Feature Groups + post: + description: Create vendor feature group + operationId: createFeatureGroup + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FeatureGroupRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Feature Groups + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/feature-groups/{featureGroupId}: + delete: + description: Delete vendor feature group + operationId: deleteFeatureGroup + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: featureGroupId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Feature Groups + get: + description: Get vendor feature group + operationId: getFeatureGroup + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: featureGroupId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/FeatureGroupModelDto' + tags: + - SDCE-1 APIs + - Vendor License Model - Feature Groups + put: + description: Update vendor feature group + operationId: updateFeatureGroup + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: featureGroupId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FeatureGroupUpdateRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - Feature Groups + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-agreements: + get: + description: List vendor license agreements + operationId: listLicenseAgreements + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LicenseAgreementEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - License Agreements + post: + description: Create vendor license agreement + operationId: createLicenseAgreement + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LicenseAgreementRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Agreements + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-agreements/{licenseAgreementId}: + delete: + description: Delete vendor license agreement + operationId: deleteLicenseAgreement + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: licenseAgreementId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Agreements + get: + description: Get vendor license agreement + operationId: getLicenseAgreement + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: licenseAgreementId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/LicenseAgreementModelDto' + tags: + - SDCE-1 APIs + - Vendor License Model - License Agreements + put: + description: Update vendor license agreement + operationId: updateLicenseAgreement + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: licenseAgreementId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LicenseAgreementUpdateRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Agreements + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-key-groups: + get: + description: List vendor license key groups + operationId: listLicenseKeyGroups + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LicenseKeyGroupEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Groups + post: + description: Create vendor license key group + operationId: createLicenseKeyGroup + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LicenseKeyGroupRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Groups + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-key-groups/{licenseKeyGroupId}: + delete: + description: Delete vendor license key group + operationId: deleteLicenseKeyGroup + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: licenseKeyGroupId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Groups + get: + description: Get vendor license key group + operationId: getLicenseKeyGroup + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: licenseKeyGroupId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/LicenseKeyGroupEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Groups + put: + description: Update vendor license key group + operationId: updateLicenseKeyGroup + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: licenseKeyGroupId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LicenseKeyGroupRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Groups + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-key-groups/{licenseKeyGroupId}/limits: + get: + description: List vendor license key group limits + operationId: listLimits_1 + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model License Key Group Id + in: path + name: licenseKeyGroupId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LimitEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Group Limits + post: + description: Create vendor license key group limit + operationId: createLimit_1 + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model License Key Group Id + in: path + name: licenseKeyGroupId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LimitRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Group Limits + /v1.0/vendor-license-models/{vlmId}/versions/{versionId}/license-key-groups/{licenseKeyGroupId}/limits/{limitId}: + delete: + description: Delete vendor license key group limit + operationId: deleteLimit_1 + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model license key group Id + in: path + name: licenseKeyGroupId + required: true + schema: + type: string + - in: path + name: limitId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Group Limits + get: + description: Get vendor entitlement pool limit + operationId: getLimit_1 + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model License Key Group + in: path + name: licenseKeyGroupId + required: true + schema: + type: string + - description: Vendor license model License Key Group Limit Id + in: path + name: limitId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/LimitEntityDto' + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Group Limits + put: + description: Update vendor license key group limit + operationId: updateLimit_1 + parameters: + - description: Vendor license model Id + in: path + name: vlmId + required: true + schema: + type: string + - description: Vendor license model version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor license model License Key Group Id + in: path + name: licenseKeyGroupId + required: true + schema: + type: string + - in: path + name: limitId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LimitRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor License Model - License Key Group Limits + /v1.0/vendor-software-products: + get: + description: Get list of vendor software products and their description + operationId: listVsps + parameters: + - description: "Filter to return only Vendor Software Products with at least\ + \ one version at this status. Currently supported values: 'Certified' ,\ + \ 'Draft'" + in: query + name: versionFilter + schema: + type: string + - description: "Filter to only return Vendor Software Products at this status.Currently\ + \ supported values: 'ACTIVE' , 'ARCHIVED'.Default value = 'ACTIVE'." + in: query + name: Status + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VspDetailsDto' + tags: + - SDCE-1 APIs + - Vendor Software Products + post: + description: Create a new vendor software product + operationId: createVsp + parameters: + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VspRequestDto' + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ItemCreationDto' + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/packages: + get: + description: Get list of translated CSAR files details + operationId: listPackages + parameters: + - description: "Vendor Software Product status filter. Currently supported values:\ + \ 'ACTIVE', 'ARCHIVED'" + in: query + name: Status + schema: + type: string + - description: Category + in: query + name: category + schema: + type: string + - description: Sub-category + in: query + name: subCategory + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PackageInfoDto' + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/packages/{vspId}: + get: + description: Get translated CSAR file + operationId: getTranslatedFile + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: query + name: versionId + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + default: + content: + application/octet-stream: + schema: + type: string + format: binary + summary: Exports translated file to a zip file + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/validation-vsp: + get: + operationId: getValidationVsp + parameters: + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}: + delete: + operationId: deleteVsp + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Products + get: + operationId: getLatestVsp + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}/versions/{versionId}: + get: + operationId: getVsp + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Products + put: + operationId: updateVsp + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VspDescriptionDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/actions: + put: + description: Actions on a vendor software product + operationId: actOnVendorSoftwareProduct + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VersionSoftwareProductActionRequestDto' + responses: + default: + content: + application/json: {} + description: default response + summary: "Performs one of the following actions on a vendor software product:\ + \ |Checkout: Locks it for edits by other users. Only the locking user sees\ + \ the edited version.|Undo_Checkout: Unlocks it and deletes the edits that\ + \ were done.|Checkin: Unlocks it and activates the edited version to all users.|\ + \ Submit: Finalize its active version.|Create_Package: Creates a CSAR zip\ + \ file.|" + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/component-dependencies: + get: + description: Get component dependencies for vendor software product + operationId: list_3 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ComponentDependencyResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component Dependencies + post: + description: Create a vendor software product component dependency + operationId: create_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ComponentDependencyModel' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Dependencies + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/component-dependencies/{dependencyId}: + delete: + description: Delete component dependency for vendor software product + operationId: delete + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product Component Dependency Id + in: path + name: dependencyId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Dependencies + get: + description: Get component dependency for vendor software product + operationId: get_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product Component Dependency Id + in: path + name: dependencyId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ComponentDependencyResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component Dependencies + put: + description: Update component dependency for vendor software product + operationId: update + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product Component Dependency Id + in: path + name: dependencyId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ComponentDependencyModel' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Dependencies + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components: + delete: + description: Delete vendor software product components + operationId: deleteList_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: string + tags: + - SDCE-1 APIs + - Vendor Software Product Components + get: + description: List vendor software product components + operationId: list_6 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ComponentDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Components + post: + description: Create a vendor software product component + operationId: create_3 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ComponentRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Components + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}: + delete: + description: Delete vendor software product component + operationId: delete_3 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Components + get: + description: Get vendor software product component + operationId: get_3 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ComponentData' + tags: + - SDCE-1 APIs + - Vendor Software Product Components + put: + description: Update vendor software product component + operationId: update_2 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ComponentRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Components + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/compute-flavors: + get: + description: Get list of vendor software product component compute-flavors + operationId: list_7 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ComputeDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component Compute-flavors + post: + description: Create a vendor software product component compute-flavor + operationId: create_4 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ComputeDetailsDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Compute-flavors + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/compute-flavors/{computeFlavorId}: + delete: + description: Delete vendor software product component compute-flavor + operationId: delete_4 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product compute-flavor Id + in: path + name: computeFlavorId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Compute-flavors + get: + description: Get vendor software product component compute-flavor + operationId: get_4 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product compute-flavor Id + in: path + name: computeFlavorId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ComputeDetailsDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component Compute-flavors + put: + description: Update vendor software product component compute-flavor + operationId: update_3 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product compute-flavor Id + in: path + name: computeFlavorId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ComputeDetailsDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Compute-flavors + ? /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/compute-flavors/{computeFlavorId}/questionnaire + : get: + description: Get vendor software product component compute-flavor questionnaire + operationId: getQuestionnaire_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product compute-flavor Id + in: path + name: computeFlavorId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/QuestionnaireResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component Compute-flavors + put: + description: Update vendor software product component compute-flavor questionnaire + operationId: updateQuestionnaire_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product compute-flavor Id + in: path + name: computeFlavorId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + required: true + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Compute-flavors + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/images: + get: + description: List vendor software product component images + operationId: list_9 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ImageDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Images + post: + description: Create a vendor software product component image + operationId: create_6 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImageRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Images + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/images/schema: + get: + operationId: getImageSchema + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Images + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/images/{imageId}: + delete: + description: Delete vendor software product Image + operationId: delete_6 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product Image Id + in: path + name: imageId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Images + get: + description: Get vendor software product component Image + operationId: get_6 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product Image Id + in: path + name: imageId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ImageDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Images + put: + description: Update vendor software product Image + operationId: update_5 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product Image Id + in: path + name: imageId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImageRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Images + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/images/{imageId}/questionnaire: + get: + description: Get vendor software product component image questionnaire + operationId: getQuestionnaire_2 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product image Id + in: path + name: imageId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/QuestionnaireResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Images + put: + description: Update vendor software product component image questionnaire + operationId: updateQuestionnaire_2 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product image Id + in: path + name: imageId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + required: true + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Images + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/nics: + get: + description: List vendor software product component NICs + operationId: list_11 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NicDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component NICs + post: + description: Create a vendor software product NIC + operationId: create_8 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NicRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component NICs + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/nics/{nicId}: + delete: + description: Delete vendor software product NIC + operationId: delete_8 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product NIC Id + in: path + name: nicId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component NICs + get: + description: Get vendor software product NIC + operationId: get_8 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product NIC Id + in: path + name: nicId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/NicDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component NICs + put: + description: Update vendor software product NIC + operationId: update_7 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product NIC Id + in: path + name: nicId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NicRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component NICs + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/nics/{nicId}/questionnaire: + get: + description: Get vendor software product component NIC questionnaire + operationId: getQuestionnaire_3 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product NIC Id + in: path + name: nicId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/QuestionnaireResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component NICs + put: + description: Update vendor software product component NIC questionnaire + operationId: updateQuestionnaire_3 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product NIC Id + in: path + name: nicId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + required: true + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component NICs + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/processes: + delete: + description: Delete vendor software product processes + operationId: deleteList + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: string + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + get: + description: List vendor software product component processes + operationId: list_5 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProcessEntityDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + post: + description: Create a vendor software product process + operationId: create_2 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProcessRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/processes/{processId}: + delete: + description: Delete vendor software product process + operationId: delete_2 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + get: + description: Get vendor software product process + operationId: get_2 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ProcessEntityDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + put: + description: Update vendor software product process + operationId: update_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProcessRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/processes/{processId}/upload: + delete: + description: Delete vendor software product process uploaded file + operationId: deleteUploadedFile + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + get: + description: Get vendor software product process uploaded file + operationId: getUploadedFile + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/octet-stream: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + post: + description: Update vendor software product process upload + operationId: uploadFile + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/Attachment' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Processes + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/questionnaire: + get: + description: Get vendor software product component questionnaire + operationId: getQuestionnaire + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/QuestionnaireResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Components + put: + description: Update vendor software product component questionnaire + operationId: updateQuestionnaire + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + required: true + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Components + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/uploads: + get: + description: Get the filenames of uploaded files by type + operationId: list_4 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product component Id + in: path + name: componentId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MonitoringUploadStatusDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Component Uploads + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/uploads/types/{type}: + delete: + description: Delete file uploaded for component + operationId: delete_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Upload Type + in: path + name: type + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Uploads + post: + description: Upload file for component by type + operationId: upload + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Component Id + in: path + name: componentId + required: true + schema: + type: string + - description: Upload Type + in: path + name: type + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/Attachment' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Component Uploads + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/compute-flavors: + get: + description: Get list of vendor software product compute-flavors + operationId: listComputes + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VspComputeDto' + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/deployment-flavors: + get: + description: List vendor software product Deployment Flavor + operationId: list_8 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeploymentFlavorListResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Product deployment-flavors + post: + description: Create a vendor software product Deployment Flavor + operationId: create_5 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentFlavorRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product deployment-flavors + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/deployment-flavors/schema: + get: + operationId: getSchema + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product deployment-flavors + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/deployment-flavors/{deploymentFlavorId}: + delete: + description: Delete vendor software product Deployment Flavor + operationId: delete_5 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product Deployment Flavor Id + in: path + name: deploymentFlavorId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product deployment-flavors + get: + description: Get vendor software product Deployment Flavor + operationId: get_5 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product Deployment Flavor Id + in: path + name: deploymentFlavorId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentFlavorDto' + tags: + - SDCE-1 APIs + - Vendor Software Product deployment-flavors + put: + description: Update vendor software product Deployment Flavor + operationId: update_4 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product Deployment Flavor Id + in: path + name: deploymentFlavorId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeploymentFlavorRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product deployment-flavors + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/heal: + put: + description: Checkout and heal vendor software product questionnaire + operationId: heal + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/QuestionnaireResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/networks: + get: + description: List vendor software product networks + operationId: list_10 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NetworkDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Networks + post: + description: Create a vendor software product network + operationId: create_7 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Networks + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/networks/{networkId}: + delete: + description: Delete vendor software product network + operationId: delete_7 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product network Id + in: path + name: networkId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Networks + get: + description: Get vendor software product network + operationId: get_7 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product network Id + in: path + name: networkId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Networks + put: + description: Update vendor software product network + operationId: update_6 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product network Id + in: path + name: networkId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Networks + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template: + get: + description: Get Orchestration Template (HEAT) file + operationId: getOrchestrationTemplate + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + schema: + type: string + responses: + default: + content: + application/octet-stream: + schema: + type: string + format: binary + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template-candidate: + delete: + description: Delete orchestration template candidate file and its files data + structure + operationId: abort + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Orchestration Template Candidate + get: + description: Get uploaded Network Package file + operationId: get_9 + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/octet-stream: + schema: + type: string + format: binary + summary: Downloads in uploaded Network Package file + tags: + - SDCE-1 APIs + - Orchestration Template Candidate + post: + description: Uploads a HEAT package to translate + operationId: uploadOrchestrationTemplateCandidate + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/UploadFileResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template-candidate/manifest: + get: + description: Get uploaded HEAT file files data structure + operationId: getFilesDataStructure + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/FileDataStructureDto' + summary: Downloads the latest HEAT package + tags: + - SDCE-1 APIs + - Orchestration Template Candidate + put: + description: Update an existing vendor software product + operationId: updateFilesDataStructure + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FileDataStructureDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Orchestration Template Candidate + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template-candidate/process: + put: + description: process Orchestration Template Candidate + operationId: process + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/UploadFileResponseDto' + tags: + - SDCE-1 APIs + - Orchestration Template Candidate + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template-candidate/upload: + get: + operationId: getLatestStatus + parameters: + - description: Vendor Software Product id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor Software Product version id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Package Upload Manager + post: + operationId: createUploadLock + parameters: + - description: Vendor Software Product id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor Software Product version id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Package Upload Manager + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/processes: + delete: + description: Delete vendor software product processes + operationId: deleteList_2 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: string + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + get: + description: List vendor software product processes + operationId: list_12 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProcessEntityDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + post: + description: Create a vendor software product process + operationId: create_9 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProcessRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/processes/{processId}: + delete: + description: Delete vendor software product process + operationId: delete_9 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + get: + description: Get vendor software product process + operationId: get_10 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ProcessEntityDto' + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + put: + description: Update vendor software product process + operationId: update_8 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProcessRequestDto' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/processes/{processId}/upload: + delete: + description: Delete vendor software product process uploaded file + operationId: deleteUploadedFile_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + get: + description: Get vendor software product process uploaded file + operationId: getUploadedFile_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/octet-stream: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + post: + description: Update vendor software product process upload + operationId: uploadFile_1 + parameters: + - description: Vendor software product Id + in: path + name: vspId + required: true + schema: + type: string + - description: Vendor software product version Id + in: path + name: versionId + required: true + schema: + type: string + - description: Vendor software product process Id + in: path + name: processId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/Attachment' + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Product Processes + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/questionnaire: + get: + description: Get vendor software product questionnaire + operationId: getQuestionnaire_4 + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/QuestionnaireResponseDto' + tags: + - SDCE-1 APIs + - Vendor Software Products + put: + description: Update vendor software product questionnaire + operationId: updateQuestionnaire_4 + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + required: true + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Vendor Software Products + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/vnfrepository/vnfpackage/{csarId}/download: + get: + description: Download VNF package from VNF Repository + operationId: downloadVnfPackage + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: csarId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/octet-stream: + schema: + type: string + format: binary + summary: Download VNF package from VNF repository and send to client + tags: + - SDCE-1 APIs + - VNF Repository packages + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/vnfrepository/vnfpackage/{csarId}/import: + post: + description: Import VNF package from VNF Repository + operationId: importVnfPackage + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: path + name: csarId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/UploadFileResponseDto' + summary: "Call VNF Repository to download VNF package, validate it and send\ + \ the response" + tags: + - SDCE-1 APIs + - VNF Repository packages + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/vnfrepository/vnfpackages: + get: + description: Get VNF packages from VNF Repository + operationId: getVnfPackages + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - description: Version Id + in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + application/octet-stream: + schema: + type: string + format: binary + summary: Call VNF Repository to get VNF package details + tags: + - SDCE-1 APIs + - VNF Repository packages + /v1.0/vendor-software-products/{vspId}/versions/{versionId}/vspInformationArtifact: + get: + description: Get vendor software product information artifact for specified + version + operationId: getVspInformationArtifact + parameters: + - in: path + name: vspId + required: true + schema: + type: string + - in: path + name: versionId + required: true + schema: + type: string + - in: header + name: USER_ID + required: true + schema: + type: string + responses: + default: + content: + text/plain: + schema: + type: string + format: binary + tags: + - SDCE-1 APIs + - Vendor Software Products + /workflow/v1.0/actions: + get: + description: 'List Filtered Actions ' + operationId: getFilteredActions + parameters: + - in: query + name: vendor + schema: + type: string + - in: query + name: category + schema: + type: string + - in: query + name: name + schema: + type: string + - in: query + name: modelId + schema: + type: string + - in: query + name: componentId + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ListResponseWrapper' + summary: Get list of actions based on a filter criteria | If no filter is sent + all actions will be returned + tags: + - SDCE-1 APIs + - Actions + post: + description: Create a new Action + operationId: createAction + requestBody: + content: + application/json: + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Actions + /workflow/v1.0/actions/components: + get: + description: List OPENECOMP Components supported by Action Library + operationId: getOpenEcompComponents + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ListResponseWrapper' + tags: + - SDCE-1 APIs + - Actions + /workflow/v1.0/actions/{actionInvariantUuId}: + delete: + description: Delete Action + operationId: deleteAction + parameters: + - in: path + name: actionInvariantUuId + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Actions + get: + description: List Actions For Given Action Invariant UuId + operationId: getActionsByActionInvariantUuId + parameters: + - in: path + name: actionInvariantUuId + required: true + schema: + type: string + - in: query + name: version + schema: + type: string + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/ListResponseWrapper' + tags: + - SDCE-1 APIs + - Actions + post: + description: Actions on a action + operationId: actOnAction + parameters: + - in: path + name: actionInvariantUuId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + summary: "Performs one of the following actions on a action: |Checkout: Locks\ + \ it for edits by other users. Only the locking user sees the edited version.|Undo_Checkout:\ + \ Unlocks it and deletes the edits that were done.|Checkin: Unlocks it and\ + \ activates the edited version to all users.| Submit: Finalize its active\ + \ version.|" + tags: + - SDCE-1 APIs + - Actions + put: + description: Update an existing action + operationId: updateAction + parameters: + - in: path + name: actionInvariantUuId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Actions + /workflow/v1.0/actions/{actionInvariantUuId}/artifacts: + post: + description: Upload new Artifact + operationId: uploadArtifact_1 + parameters: + - in: path + name: actionInvariantUuId + required: true + schema: + type: string + - in: header + name: Content-MD5 + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Actions + /workflow/v1.0/actions/{actionInvariantUuId}/artifacts/{artifactUuId}: + delete: + description: Delete Artifact + operationId: deleteArtifact + parameters: + - in: path + name: actionInvariantUuId + required: true + schema: + type: string + - in: path + name: artifactUuId + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Actions + put: + description: Update an existing artifact + operationId: updateArtifact_1 + parameters: + - in: path + name: actionInvariantUuId + required: true + schema: + type: string + - in: path + name: artifactUuId + required: true + schema: + type: string + - in: header + name: Content-MD5 + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + tags: + - SDCE-1 APIs + - Actions + /workflow/v1.0/actions/{actionUuId}/artifacts/{artifactUuId}: + get: + description: Downloads artifact for action + operationId: downloadArtifact + parameters: + - in: path + name: actionUuId + required: true + schema: + type: string + - in: path + name: artifactUuId + required: true + schema: + type: string + responses: + default: + content: + application/octet-stream: {} + description: default response + tags: + - SDCE-1 APIs + - Actions +components: + schemas: + ActionResponseDto: + type: object + properties: + actionInvariantUuId: + type: string + actionUuId: + type: string + categoryList: + type: array + items: + type: string + description: + type: string + displayName: + type: string + name: + type: string + status: + type: string + supportedComponents: + type: array + items: + type: object + additionalProperties: + type: string + supportedModels: + type: array + items: + type: object + additionalProperties: + type: string + timestamp: + type: string + updatedBy: + type: string + vendorList: + type: array + items: + type: string + version: + type: string + ActivityLogDto: + type: object + properties: + comment: + type: string + id: + type: string + status: + $ref: '#/components/schemas/ActivityStatus' + timestamp: + type: string + format: date-time + type: + type: string + user: + type: string + ActivityStatus: + type: object + properties: + message: + type: string + success: + type: boolean + ApplicationConfigDto: + type: object + properties: + key: + type: string + value: + type: string + Artifact: + type: object + properties: + errors: + type: array + items: + $ref: '#/components/schemas/ErrorMessage' + fileName: + type: string + type: + type: string + enum: + - HEAT + - HEAT_ENV + - HEAT_NET + - HEAT_VOL + - CHEF + - PUPPET + - SHELL + - YANG + - YANG_XML + - BPEL + - DG_XML + - MURANO_PKG + - VENDOR_LICENSE + - VF_LICENSE + - CLOUD_TECHNOLOGY_SPECIFIC_ARTIFACT + - CONTROLLER_BLUEPRINT_ARCHIVE + - HELM + - OTHER + - PNF_SW_INFORMATION + - PM_DICTIONARY + Attachment: + type: object + properties: + contentDisposition: + $ref: '#/components/schemas/ContentDisposition' + contentId: + type: string + contentType: + type: object + properties: + parameters: + type: object + additionalProperties: + type: string + subtype: + type: string + type: + type: string + wildcardSubtype: + type: boolean + wildcardType: + type: boolean + dataHandler: + type: object + properties: + allCommands: + type: array + items: + type: object + properties: + commandClass: + type: string + commandName: + type: string + commandMap: + type: object + properties: + mimeTypes: + type: array + items: + type: string + writeOnly: true + content: + type: object + contentType: + type: string + dataSource: + type: object + properties: + contentType: + type: string + inputStream: + type: object + name: + type: string + outputStream: + type: object + inputStream: + type: object + name: + type: string + outputStream: + type: object + preferredCommands: + type: array + items: + type: object + properties: + commandClass: + type: string + commandName: + type: string + transferDataFlavors: + type: array + items: + type: object + properties: + defaultRepresentationClassAsString: + type: string + flavorJavaFileListType: + type: boolean + flavorRemoteObjectType: + type: boolean + flavorSerializedObjectType: + type: boolean + flavorTextType: + type: boolean + humanPresentableName: + type: string + mimeType: + type: string + mimeTypeSerializedObject: + type: boolean + primaryType: + type: string + representationClassByteBuffer: + type: boolean + representationClassCharBuffer: + type: boolean + representationClassInputStream: + type: boolean + representationClassReader: + type: boolean + representationClassRemote: + type: boolean + representationClassSerializable: + type: boolean + subType: + type: string + headers: + type: object + additionalProperties: + type: array + items: + type: string + object: + type: object + ChoiceOrOtherDtoLicenseTerm: + type: object + properties: + choice: + type: string + enum: + - Fixed_Term + - Perpetual + - Unlimited + - Other + other: + type: string + required: + - choice + - other + ClientConfiguration: + type: object + properties: + enabled: + type: boolean + CommitRequestDto: + type: object + properties: + message: + type: string + ComponentComputeAssociation: + type: object + properties: + componentId: + type: string + computeFlavorId: + type: string + ComponentData: + type: object + properties: + description: + type: string + displayName: + type: string + name: + type: string + ComponentDependencyModel: + type: object + properties: + relationType: + type: string + sourceId: + type: string + targetId: + type: string + ComponentDependencyResponseDto: + type: object + properties: + id: + type: string + relationType: + type: string + sourceId: + type: string + targetId: + type: string + ComponentDto: + type: object + properties: + description: + type: string + displayName: + type: string + maxLength: 30 + minLength: 1 + id: + type: string + name: + type: string + required: + - displayName + ComponentRequestDto: + type: object + properties: + description: + type: string + displayName: + type: string + maxLength: 30 + minLength: 1 + name: + type: string + required: + - displayName + ComputeDetailsDto: + type: object + properties: + description: + type: string + maxLength: 300 + minLength: 0 + name: + type: string + maxLength: 30 + minLength: 0 + required: + - name + ComputeDto: + type: object + properties: + associatedToDeploymentFlavor: + type: boolean + description: + type: string + id: + type: string + name: + type: string + ConfigurationDataDto: + type: object + properties: + timeStamp: + type: integer + format: int64 + value: + type: string + ConflictDto: + type: object + properties: + id: + type: string + name: + type: string + theirs: + type: object + additionalProperties: + type: object + type: + type: string + enum: + - itemVersion + - VendorLicenseModel + - LicenseAgreements + - LicenseAgreement + - FeatureGroups + - FeatureGroup + - LicenseKeyGroups + - LicenseKeyGroup + - EntitlementPools + - EntitlementPool + - Limits + - Limit + - VendorSoftwareProduct + - VSPQuestionnaire + - VspModel + - NetworkPackage + - OrchestrationTemplateCandidate + - OrchestrationTemplateCandidateContent + - OrchestrationTemplateCandidateValidationData + - ORIGINAL_ONBOARDED_PACKAGE + - OrchestrationTemplateStructure + - OrchestrationTemplate + - OrchestrationTemplateValidationData + - OrchestrationTemplateContent + - Networks + - Network + - Components + - Component + - ComponentQuestionnaire + - ComponentDependencies + - ComponentDependency + - Nics + - Nic + - NicQuestionnaire + - Mibs + - SNMP_POLL + - SNMP_TRAP + - VES_EVENTS + - Processes + - Process + - DeploymentFlavors + - DeploymentFlavor + - Computes + - Compute + - ComputeQuestionnaire + - Images + - Image + - ImageQuestionnaire + - ServiceModel + - EnrichedServiceModel + - ServiceTemplate + - Templates + - Artifact + - Artifacts + - test + yours: + type: object + additionalProperties: + type: object + ConflictInfoDto: + type: object + properties: + id: + type: string + name: + type: string + type: + type: string + enum: + - itemVersion + - VendorLicenseModel + - LicenseAgreements + - LicenseAgreement + - FeatureGroups + - FeatureGroup + - LicenseKeyGroups + - LicenseKeyGroup + - EntitlementPools + - EntitlementPool + - Limits + - Limit + - VendorSoftwareProduct + - VSPQuestionnaire + - VspModel + - NetworkPackage + - OrchestrationTemplateCandidate + - OrchestrationTemplateCandidateContent + - OrchestrationTemplateCandidateValidationData + - ORIGINAL_ONBOARDED_PACKAGE + - OrchestrationTemplateStructure + - OrchestrationTemplate + - OrchestrationTemplateValidationData + - OrchestrationTemplateContent + - Networks + - Network + - Components + - Component + - ComponentQuestionnaire + - ComponentDependencies + - ComponentDependency + - Nics + - Nic + - NicQuestionnaire + - Mibs + - SNMP_POLL + - SNMP_TRAP + - VES_EVENTS + - Processes + - Process + - DeploymentFlavors + - DeploymentFlavor + - Computes + - Compute + - ComputeQuestionnaire + - Images + - Image + - ImageQuestionnaire + - ServiceModel + - EnrichedServiceModel + - ServiceTemplate + - Templates + - Artifact + - Artifacts + - test + ConflictResolutionDto: + type: object + properties: + otherResolution: + type: object + additionalProperties: + type: object + resolution: + type: string + enum: + - THEIRS + - YOURS + - OTHER + ContentDisposition: + type: object + properties: + filename: + type: string + parameters: + type: object + additionalProperties: + type: string + type: + type: string + DeploymentFlavorDto: + type: object + properties: + componentComputeAssociations: + type: array + items: + $ref: '#/components/schemas/ComponentComputeAssociation' + description: + type: string + maxLength: 300 + minLength: 0 + featureGroupId: + type: string + id: + type: string + model: + type: string + maxLength: 30 + minLength: 0 + required: + - model + DeploymentFlavorListResponseDto: + type: object + properties: + description: + type: string + id: + type: string + model: + type: string + DeploymentFlavorRequestDto: + type: object + properties: + componentComputeAssociations: + type: array + items: + $ref: '#/components/schemas/ComponentComputeAssociation' + description: + type: string + maxLength: 300 + minLength: 0 + featureGroupId: + type: string + model: + type: string + maxLength: 30 + minLength: 0 + required: + - model + EntitlementPoolEntityDto: + type: object + description: EntitlementPoolEntity + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + expiryDate: + type: string + id: + type: string + increments: + type: string + maxLength: 120 + minLength: 0 + manufacturerReferenceNumber: + type: string + maxLength: 100 + minLength: 0 + name: + type: string + maxLength: 120 + minLength: 0 + operationalScope: + $ref: '#/components/schemas/MultiChoiceOrOtherDtoOperationalScope' + referencingFeatureGroups: + type: array + items: + type: string + uniqueItems: true + startDate: + type: string + thresholdUnits: + type: string + enum: + - Absolute + - Percentage + thresholdValue: + type: integer + format: int32 + type: + type: string + enum: + - Universal + - Unique + - One_Time + versionUUID: + type: string + required: + - manufacturerReferenceNumber + - name + - type + EntitlementPoolRequestDto: + type: object + description: EntitlementPoolRequest + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + expiryDate: + type: string + increments: + type: string + maxLength: 120 + minLength: 0 + manufacturerReferenceNumber: + type: string + maxLength: 100 + minLength: 0 + name: + type: string + maxLength: 120 + minLength: 0 + operationalScope: + $ref: '#/components/schemas/MultiChoiceOrOtherDtoOperationalScope' + startDate: + type: string + thresholdUnits: + type: string + enum: + - Absolute + - Percentage + thresholdValue: + type: integer + format: int32 + type: + type: string + enum: + - Universal + - Unique + - One_Time + required: + - manufacturerReferenceNumber + - name + - type + ErrorMessage: + type: object + properties: + level: + type: string + enum: + - ERROR + - WARNING + - INFO + message: + type: string + FeatureDto: + type: object + properties: + active: + type: boolean + name: + type: string + FeatureGroupEntityDto: + type: object + description: FeatureGroupEntity + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + entitlementPoolsIds: + type: array + items: + type: string + maxItems: 2147483647 + minItems: 1 + uniqueItems: true + id: + type: string + licenseKeyGroupsIds: + type: array + items: + type: string + uniqueItems: true + name: + type: string + maxLength: 120 + minLength: 0 + partNumber: + type: string + referencingLicenseAgreements: + type: array + items: + type: string + uniqueItems: true + required: + - name + - partNumber + FeatureGroupModelDto: + type: object + description: FeatureGroupModel + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + entitlementPools: + type: array + items: + $ref: '#/components/schemas/EntitlementPoolEntityDto' + id: + type: string + licenseKeyGroups: + type: array + items: + $ref: '#/components/schemas/LicenseKeyGroupEntityDto' + name: + type: string + maxLength: 120 + minLength: 0 + partNumber: + type: string + referencingLicenseAgreements: + type: array + items: + type: string + uniqueItems: true + required: + - name + - partNumber + FeatureGroupRequestDto: + type: object + description: FeatureGroupRequest + properties: + addedEntitlementPoolsIds: + type: array + items: + type: string + uniqueItems: true + addedLicenseKeyGroupsIds: + type: array + items: + type: string + uniqueItems: true + description: + type: string + maxLength: 1000 + minLength: 0 + name: + type: string + maxLength: 120 + minLength: 0 + partNumber: + type: string + required: + - name + - partNumber + FeatureGroupUpdateRequestDto: + type: object + description: FeatureGroupUpdateRequest + properties: + addedEntitlementPoolsIds: + type: array + items: + type: string + uniqueItems: true + addedLicenseKeyGroupsIds: + type: array + items: + type: string + uniqueItems: true + description: + type: string + maxLength: 1000 + minLength: 0 + name: + type: string + maxLength: 120 + minLength: 0 + partNumber: + type: string + removedEntitlementPoolsIds: + type: array + items: + type: string + uniqueItems: true + removedLicenseKeyGroupsIds: + type: array + items: + type: string + uniqueItems: true + required: + - name + - partNumber + FeatureSetDto: + type: object + properties: + features: + type: array + items: + $ref: '#/components/schemas/FeatureDto' + uniqueItems: true + FileDataStructureDto: + type: object + properties: + artifacts: + type: array + items: + type: string + modules: + type: array + items: + $ref: '#/components/schemas/Module' + nested: + type: array + items: + type: string + unassigned: + type: array + items: + type: string + HealthInfoDto: + type: object + properties: + description: + type: string + healthCheckComponent: + type: string + enum: + - BE + - Cassandra + - Zusammen + healthStatus: + type: string + enum: + - UP + - DOWN + version: + type: string + HealthInfoDtos: + type: object + properties: + healthInfos: + type: array + items: + $ref: '#/components/schemas/HealthInfoDto' + HeatStructureTree: + type: object + properties: + artifacts: + type: array + items: + $ref: '#/components/schemas/Artifact' + uniqueItems: true + base: + type: boolean + env: + $ref: '#/components/schemas/HeatStructureTree' + errors: + type: array + items: + $ref: '#/components/schemas/ErrorMessage' + fileName: + type: string + heat: + type: array + items: + $ref: '#/components/schemas/HeatStructureTree' + uniqueItems: true + helm: + type: array + items: + $ref: '#/components/schemas/HeatStructureTree' + uniqueItems: true + nested: + type: array + items: + $ref: '#/components/schemas/HeatStructureTree' + uniqueItems: true + network: + type: array + items: + $ref: '#/components/schemas/HeatStructureTree' + uniqueItems: true + other: + type: array + items: + $ref: '#/components/schemas/HeatStructureTree' + uniqueItems: true + type: + type: string + enum: + - HEAT + - HEAT_ENV + - HEAT_NET + - HEAT_VOL + - CHEF + - PUPPET + - SHELL + - YANG + - YANG_XML + - BPEL + - DG_XML + - MURANO_PKG + - VENDOR_LICENSE + - VF_LICENSE + - CLOUD_TECHNOLOGY_SPECIFIC_ARTIFACT + - CONTROLLER_BLUEPRINT_ARCHIVE + - HELM + - OTHER + - PNF_SW_INFORMATION + - PM_DICTIONARY + volume: + type: array + items: + $ref: '#/components/schemas/HeatStructureTree' + uniqueItems: true + ImageDto: + type: object + properties: + description: + type: string + fileName: + type: string + id: + type: string + required: + - fileName + ImageRequestDto: + type: object + properties: + description: + type: string + fileName: + type: string + required: + - fileName + Item: + type: object + properties: + creationTime: + type: string + format: date-time + description: + type: string + id: + type: string + modificationTime: + type: string + format: date-time + name: + type: string + owner: + type: string + properties: + type: object + additionalProperties: + type: object + status: + type: string + enum: + - ACTIVE + - ARCHIVED + type: + type: string + versionStatusCounters: + type: object + additionalProperties: + type: integer + format: int32 + ItemActionRequestDto: + type: object + properties: + action: + type: string + enum: + - ARCHIVE + - RESTORE + ItemCreationDto: + type: object + properties: + itemId: + type: string + version: + $ref: '#/components/schemas/VersionDto' + ItemDto: + type: object + properties: + description: + type: string + id: + type: string + name: + type: string + owner: + type: string + properties: + type: object + additionalProperties: + type: object + status: + type: string + type: + type: string + ItemPermissionsDto: + type: object + properties: + permission: + type: string + userId: + type: string + ItemPermissionsRequestDto: + type: object + description: ItemPermissionsRequest + properties: + addedUsersIds: + type: array + items: + type: string + uniqueItems: true + removedUsersIds: + type: array + items: + type: string + uniqueItems: true + ItemVersionConflictDto: + type: object + properties: + conflict: + $ref: '#/components/schemas/ConflictDto' + conflictInfoList: + type: array + items: + $ref: '#/components/schemas/ConflictInfoDto' + LicenseAgreementEntityDto: + type: object + description: LicenseAgreementEntity + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + featureGroupsIds: + type: array + items: + type: string + maxItems: 2147483647 + minItems: 1 + uniqueItems: true + id: + type: string + licenseTerm: + $ref: '#/components/schemas/ChoiceOrOtherDtoLicenseTerm' + name: + type: string + maxLength: 120 + minLength: 0 + requirementsAndConstrains: + type: string + maxLength: 1000 + minLength: 0 + required: + - licenseTerm + - name + LicenseAgreementModelDto: + type: object + description: LicenseAgreementModel + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + featureGroups: + type: array + items: + $ref: '#/components/schemas/FeatureGroupEntityDto' + uniqueItems: true + id: + type: string + licenseTerm: + $ref: '#/components/schemas/ChoiceOrOtherDtoLicenseTerm' + name: + type: string + maxLength: 120 + minLength: 0 + requirementsAndConstrains: + type: string + maxLength: 1000 + minLength: 0 + required: + - licenseTerm + - name + LicenseAgreementRequestDto: + type: object + description: LicenseAgreementRequest + properties: + addedFeatureGroupsIds: + type: array + items: + type: string + uniqueItems: true + description: + type: string + maxLength: 1000 + minLength: 0 + licenseTerm: + $ref: '#/components/schemas/ChoiceOrOtherDtoLicenseTerm' + name: + type: string + maxLength: 120 + minLength: 0 + requirementsAndConstrains: + type: string + maxLength: 1000 + minLength: 0 + required: + - licenseTerm + - name + LicenseAgreementUpdateRequestDto: + type: object + description: LicenseAgreementUpdateRequest + properties: + addedFeatureGroupsIds: + type: array + items: + type: string + uniqueItems: true + description: + type: string + maxLength: 1000 + minLength: 0 + licenseTerm: + $ref: '#/components/schemas/ChoiceOrOtherDtoLicenseTerm' + name: + type: string + maxLength: 120 + minLength: 0 + removedFeatureGroupsIds: + type: array + items: + type: string + uniqueItems: true + requirementsAndConstrains: + type: string + maxLength: 1000 + minLength: 0 + required: + - licenseTerm + - name + LicenseKeyGroupEntityDto: + type: object + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + expiryDate: + type: string + id: + type: string + increments: + type: string + maxLength: 120 + minLength: 0 + manufacturerReferenceNumber: + type: string + maxLength: 100 + minLength: 0 + name: + type: string + maxLength: 120 + minLength: 0 + operationalScope: + $ref: '#/components/schemas/MultiChoiceOrOtherDtoOperationalScope' + referencingFeatureGroups: + type: array + items: + type: string + uniqueItems: true + startDate: + type: string + thresholdUnits: + type: string + enum: + - Absolute + - Percentage + thresholdValue: + type: integer + format: int32 + type: + type: string + enum: + - Universal + - Unique + - One_Time + versionUUID: + type: string + required: + - name + - type + LicenseKeyGroupRequestDto: + type: object + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + expiryDate: + type: string + increments: + type: string + maxLength: 120 + minLength: 0 + manufacturerReferenceNumber: + type: string + maxLength: 100 + minLength: 0 + name: + type: string + maxLength: 120 + minLength: 0 + operationalScope: + $ref: '#/components/schemas/MultiChoiceOrOtherDtoOperationalScope' + startDate: + type: string + thresholdUnits: + type: string + enum: + - Absolute + - Percentage + thresholdValue: + type: integer + format: int32 + type: + type: string + enum: + - Universal + - Unique + - One_Time + required: + - name + - type + LicensingData: + type: object + properties: + featureGroups: + type: array + items: + type: string + licenseAgreement: + type: string + LimitEntityDto: + type: object + properties: + aggregationFunction: + type: string + description: + type: string + id: + type: string + metric: + type: string + name: + type: string + time: + type: string + type: + type: string + unit: + type: string + value: + type: string + LimitRequestDto: + type: object + description: LimitRequest + properties: + aggregationFunction: + type: string + description: + type: string + maxLength: 1000 + minLength: 0 + metric: + type: string + name: + type: string + maxLength: 120 + minLength: 0 + time: + type: string + type: + type: string + unit: + type: string + value: + type: string + required: + - metric + - name + - type + - value + ListResponseWrapper: + type: object + properties: + actionList: + type: array + items: + $ref: '#/components/schemas/ActionResponseDto' + componentList: + type: array + items: + $ref: '#/components/schemas/OpenEcompComponent' + versions: + type: array + items: + $ref: '#/components/schemas/ActionResponseDto' + Module: + type: object + properties: + env: + type: string + isBase: + type: boolean + name: + type: string + type: + type: string + enum: + - HEAT + - HEAT_ENV + - HEAT_NET + - HEAT_VOL + - CHEF + - PUPPET + - SHELL + - YANG + - YANG_XML + - BPEL + - DG_XML + - MURANO_PKG + - VENDOR_LICENSE + - VF_LICENSE + - CLOUD_TECHNOLOGY_SPECIFIC_ARTIFACT + - CONTROLLER_BLUEPRINT_ARCHIVE + - HELM + - OTHER + - PNF_SW_INFORMATION + - PM_DICTIONARY + vol: + type: string + volEnv: + type: string + yaml: + type: string + MonitoringUploadStatusDto: + type: object + properties: + snmpPoll: + type: string + snmpTrap: + type: string + vesEvent: + type: string + MultiChoiceOrOtherDtoOperationalScope: + type: object + properties: + choices: + type: array + items: + type: string + enum: + - Network_Wide + - Availability_Zone + - Data_Center + - Tenant + - VM + - CPU + - Core + - Other + maxItems: 2147483647 + minItems: 1 + uniqueItems: true + other: + type: string + required: + - choices + - other + NetworkDto: + type: object + properties: + dhcp: + type: boolean + id: + type: string + name: + type: string + required: + - dhcp + - name + NetworkRequestDto: + type: object + properties: + dhcp: + type: boolean + name: + type: string + required: + - dhcp + - name + NicDto: + type: object + properties: + description: + type: string + id: + type: string + name: + type: string + networkDescription: + type: string + networkId: + type: string + networkName: + type: string + networkType: + type: string + required: + - name + - networkType + NicRequestDto: + type: object + properties: + description: + type: string + name: + type: string + networkDescription: + type: string + networkId: + type: string + networkType: + type: string + required: + - name + - networkType + NotificationEntityDto: + type: object + properties: + dateTime: + type: string + eventAttributes: + type: object + additionalProperties: + type: object + eventId: + type: string + format: uuid + eventType: + type: string + read: + type: boolean + NotificationsStatusDto: + type: object + properties: + endOfPage: + type: string + format: uuid + lastScanned: + type: string + format: uuid + newEntries: + type: array + items: + type: string + format: uuid + notifications: + type: array + items: + $ref: '#/components/schemas/NotificationEntityDto' + numOfNotSeenNotifications: + type: integer + format: int64 + OpenEcompComponent: + type: object + properties: + id: + type: string + name: + type: string + PackageInfoDto: + type: object + properties: + category: + type: string + description: + type: string + displayName: + type: string + models: + type: array + items: + type: string + uniqueItems: true + packageChecksum: + type: string + packageId: + type: string + packageType: + type: string + resourceType: + type: string + subCategory: + type: string + vendorName: + type: string + vendorRelease: + type: string + version: + type: string + versionId: + type: string + vspName: + type: string + ProcessEntityDto: + type: object + properties: + artifactName: + type: string + description: + type: string + id: + type: string + name: + type: string + type: + type: string + enum: + - Lifecycle_Operations + - Other + required: + - name + ProcessRequestDto: + type: object + properties: + description: + type: string + name: + type: string + type: + type: string + enum: + - Lifecycle_Operations + - Other + required: + - name + QuestionnaireResponseDto: + type: object + properties: + data: + type: string + errorMessage: + $ref: '#/components/schemas/ErrorMessage' + schema: + type: string + RemoteTestingEndpointDefinition: + type: object + properties: + apiKey: + type: string + enabled: + type: boolean + id: + type: string + scenarioFilter: + type: string + title: + type: string + url: + type: string + RevisionRequestDto: + type: object + properties: + revisionId: + type: string + SubmitRequestDto: + type: object + properties: + message: + type: string + UpdateNotificationResponseStatus: + type: object + properties: + errors: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ErrorMessage' + status: + type: string + enum: + - Success + - Failure + UploadFileResponseDto: + type: object + properties: + errors: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ErrorMessage' + networkPackageName: + type: string + onboardingOrigin: + type: string + status: + type: string + enum: + - Success + - Failure + ValidationStructureList: + type: object + properties: + importStructure: + $ref: '#/components/schemas/HeatStructureTree' + VendorLicenseModelActionRequestDto: + type: object + properties: + action: + type: string + enum: + - Submit + submitRequest: + $ref: '#/components/schemas/SubmitRequestDto' + VendorLicenseModelEntityDto: + type: object + description: VendorLicenseModelEntity + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + iconRef: + type: string + id: + type: string + vendorName: + type: string + maxLength: 25 + minLength: 0 + required: + - description + - iconRef + - vendorName + VendorLicenseModelRequestDto: + type: object + description: VendorLicenseModelRequest + properties: + description: + type: string + maxLength: 1000 + minLength: 0 + iconRef: + type: string + vendorName: + type: string + maxLength: 25 + minLength: 0 + required: + - description + - iconRef + - vendorName + VersionActionRequestDto: + type: object + properties: + action: + type: string + enum: + - Sync + - Commit + - Revert + - Reset + - Clean + commitRequest: + $ref: '#/components/schemas/CommitRequestDto' + revisionRequest: + $ref: '#/components/schemas/RevisionRequestDto' + VersionDto: + type: object + properties: + additionalInfo: + type: object + additionalProperties: + type: object + baseId: + type: string + creationTime: + type: string + format: date-time + description: + type: string + id: + type: string + modificationTime: + type: string + format: date-time + name: + type: string + state: + $ref: '#/components/schemas/VersionState' + status: + type: string + enum: + - Draft + - Locked + - Certified + - Deprecated + - Deleted + VersionRequestDto: + type: object + properties: + creationMethod: + type: string + enum: + - major + - minor + description: + type: string + VersionSoftwareProductActionRequestDto: + type: object + properties: + action: + type: string + enum: + - Submit + - Create_Package + submitRequest: + $ref: '#/components/schemas/SubmitRequestDto' + VersionState: + type: object + properties: + dirty: + type: boolean + synchronizationState: + type: string + enum: + - Up to date + - Out of sync + - Merging + VspComputeDto: + type: object + properties: + componentId: + type: string + computeFlavorId: + type: string + name: + type: string + VspDescriptionDto: + type: object + properties: + category: + type: string + description: + type: string + icon: + type: string + licenseType: + type: string + enum: + - EXTERNAL + - INTERNAL + licensingData: + $ref: '#/components/schemas/LicensingData' + licensingVersion: + type: string + name: + type: string + selectedModelList: + type: array + items: + type: string + subCategory: + type: string + vendorId: + type: string + vendorName: + type: string + required: + - category + - description + - name + - subCategory + - vendorId + - vendorName + VspDetailsDto: + type: object + description: VspDetails + properties: + candidateOnboardingOrigin: + type: string + category: + type: string + description: + type: string + icon: + type: string + id: + type: string + licenseType: + type: string + enum: + - EXTERNAL + - INTERNAL + licensingData: + $ref: '#/components/schemas/LicensingData' + licensingVersion: + type: string + name: + type: string + networkPackageName: + type: string + onboardingMethod: + type: string + onboardingOrigin: + type: string + owner: + type: string + selectedModelList: + type: array + items: + type: string + status: + type: string + subCategory: + type: string + validationData: + $ref: '#/components/schemas/ValidationStructureList' + vendorId: + type: string + vendorName: + type: string + version: + type: string + required: + - category + - description + - name + - onboardingMethod + - subCategory + - vendorId + - vendorName + VspRequestDto: + type: object + properties: + category: + type: string + description: + type: string + icon: + type: string + licenseType: + type: string + enum: + - EXTERNAL + - INTERNAL + licensingData: + $ref: '#/components/schemas/LicensingData' + licensingVersion: + type: string + name: + type: string + onboardingMethod: + type: string + selectedModelList: + type: array + items: + type: string + subCategory: + type: string + vendorId: + type: string + vendorName: + type: string + required: + - category + - description + - name + - onboardingMethod + - subCategory + - vendorId + - vendorName |