From 07d37e87d03ba95a52991fa9cd7e86f3f9a27bd1 Mon Sep 17 00:00:00 2001 From: "swaroop.ar" Date: Mon, 6 Jan 2025 07:35:21 +0100 Subject: [PATCH] update latest API version --- .../policies/AddOrUpdateServicePolicy.tsx | 2 +- .../content/monitor/MetricQueries.ts | 4 +- src/xpanse-api/api.json | 7473 +++++------------ src/xpanse-api/generated/sdk.gen.ts | 12 +- src/xpanse-api/generated/types.gen.ts | 23 +- 5 files changed, 2033 insertions(+), 5481 deletions(-) diff --git a/src/components/content/catalog/services/policies/AddOrUpdateServicePolicy.tsx b/src/components/content/catalog/services/policies/AddOrUpdateServicePolicy.tsx index 35ebb1ec1..d14eb7ef5 100644 --- a/src/components/content/catalog/services/policies/AddOrUpdateServicePolicy.tsx +++ b/src/components/content/catalog/services/policies/AddOrUpdateServicePolicy.tsx @@ -71,7 +71,7 @@ export const AddOrUpdateServicePolicy = ({ const policyUpdateRequest: ServicePolicyUpdateRequest = { enabled: policyRequest.enabled, policy: policyRequest.policy, - flavorNameList: policyRequest.flavors, + flavorNames: policyRequest.flavors, }; setUpdatePolicyRequest(policyUpdateRequest); updatePoliciesManagementServiceRequest.mutate({ diff --git a/src/components/content/monitor/MetricQueries.ts b/src/components/content/monitor/MetricQueries.ts index 9b6b951ec..eb0e3f01a 100644 --- a/src/components/content/monitor/MetricQueries.ts +++ b/src/components/content/monitor/MetricQueries.ts @@ -16,7 +16,7 @@ const onlyLastKnownMetricQueryFn = (serviceId: string, metricType: monitorResour serviceId: serviceId, resourceId: undefined, monitorResourceType: metricType, - from: undefined, + _from: undefined, to: undefined, granularity: undefined, onlyLastKnownMetric: true, @@ -49,7 +49,7 @@ const monitorMetricQueryFn = (serviceId: string, metricType: monitorResourceType serviceId: serviceId, resourceId: undefined, monitorResourceType: metricType, - from: getMetricRequestParams(getTotalSecondsOfTimePeriod(timePeriod)).from, + _from: getMetricRequestParams(getTotalSecondsOfTimePeriod(timePeriod)).from, to: getMetricRequestParams(getTotalSecondsOfTimePeriod(timePeriod)).to, granularity: undefined, onlyLastKnownMetric: false, diff --git a/src/xpanse-api/api.json b/src/xpanse-api/api.json index b4de418e6..6d6e6f11c 100644 --- a/src/xpanse-api/api.json +++ b/src/xpanse-api/api.json @@ -5,227 +5,129 @@ "description": "RESTful Services to interact with Xpanse runtime.", "version": "1.0.23-SNAPSHOT" }, - "servers": [ - { - "url": "http://localhost:8080", - "description": "Generated server url" - } - ], - "security": [ - { - "OAuth2Flow": [] - } - ], + "servers": [{ "url": "http://localhost:8080", "description": "Generated server url" }], + "security": [{ "OAuth2Flow": [] }], "tags": [ { "name": "CloudServiceProvider", "description": "APIs for cloud service provider to manage service templates." }, - { - "name": "AuthManagement", - "description": "APIs for user authentication and authorization." - }, - { - "name": "ServiceOrders", - "description": "APIs to manage orders of services" - }, - { - "name": "CredentialsConfiguration", - "description": "APIs Viewing Cloud Credentials Configuration" - }, - { - "name": "CloudResources", - "description": "API to view cloud resources by type" - }, - { - "name": "Service", - "description": "APIs to manage the services" - }, + { "name": "AuthManagement", "description": "APIs for user authentication and authorization." }, + { "name": "ServiceOrders", "description": "APIs to manage orders of services" }, + { "name": "CredentialsConfiguration", "description": "APIs Viewing Cloud Credentials Configuration" }, + { "name": "CloudResources", "description": "API to view cloud resources by type" }, + { "name": "Service", "description": "APIs to manage the services" }, { "name": "ServiceCatalog", "description": "APIs to query the services which are available for the user to order." }, - { - "name": "UserPoliciesManagement", - "description": "APIs for managing user's infra policies." - }, - { - "name": "Migration", - "description": "APIs to manage the service migration." - }, - { - "name": "Admin", - "description": "APIs for administrating Xpanse" - }, - { - "name": "Workflow", - "description": "APIs to manage the Workflow" - }, - { - "name": "ServicePrices", - "description": "API to manage prices of the flavors of the service." - }, - { - "name": "ServiceStatusManagement", - "description": "APIs to manage status of the service instances" - }, + { "name": "UserPoliciesManagement", "description": "APIs for managing user's infra policies." }, + { "name": "Migration", "description": "APIs to manage the service migration." }, + { "name": "Admin", "description": "APIs for administrating Xpanse" }, + { "name": "Workflow", "description": "APIs to manage the Workflow" }, + { "name": "ServicePrices", "description": "API to manage prices of the flavors of the service." }, + { "name": "ServiceStatusManagement", "description": "APIs to manage status of the service instances" }, { "name": "ISVCloudCredentialsManagement", "description": "APIs for managing isv's cloud provider credentials" }, - { - "name": "ServicePoliciesManagement", - "description": "APIs for managing service's infra policies." - }, - { - "name": "ServiceVendor", - "description": "APIs to manage service templates." - }, + { "name": "ServicePoliciesManagement", "description": "APIs for managing service's infra policies." }, + { "name": "ServiceVendor", "description": "APIs to manage service templates." }, { "name": "UserCloudCredentialsManagement", "description": "APIs for managing user's cloud provider credentials" }, - { - "name": "Agent Api", - "description": "APIs for agent to poll pending configuration change requests." - }, - { - "name": "ServiceConfiguration", - "description": "APIs for managing service's configuration." - }, - { - "name": "Monitor", - "description": "APIs for getting metrics of deployed services." - } + { "name": "Agent Api", "description": "APIs for agent to poll pending configuration change requests." }, + { "name": "ServiceConfiguration", "description": "APIs for managing service's configuration." }, + { "name": "Monitor", "description": "APIs for getting metrics of deployed services." } ], "paths": { - "/xpanse/workflow/task/{id}": { + "/xpanse/workflow/task/{taskId}": { "put": { "tags": ["Workflow"], "description": "Manage failed task orders.
Required role: admin or user
", "operationId": "manageFailedOrder", "parameters": [ { - "name": "id", + "name": "taskId", "in": "path", "description": "ID of the workflow task that needs to be handled", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "retryOrder", "in": "query", "description": "Controls if the order must be retried again or simply closed.", "required": true, - "schema": { - "type": "boolean" - } + "schema": { "type": "boolean" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "200": { - "description": "OK" - } + "200": { "description": "OK" } } } }, - "/xpanse/workflow/complete/task/{id}": { + "/xpanse/workflow/complete/task/{taskId}": { "put": { "tags": ["Workflow"], "description": "Complete tasks by task ID and set global process variables .
Required role: admin or user
", "operationId": "completeTask", "parameters": [ { - "name": "id", + "name": "taskId", "in": "path", "description": "ID of the workflow task that needs to be handled", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } + "schema": { "type": "object", "additionalProperties": { "type": "object" } } } }, "required": true @@ -234,76 +136,46 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "200": { - "description": "OK" - } + "200": { "description": "OK" } } } }, @@ -348,71 +220,43 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { @@ -421,9 +265,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/AbstractCredentialInfo" - } + "items": { "$ref": "#/components/schemas/AbstractCredentialInfo" } } } } @@ -436,11 +278,7 @@ "operationId": "updateUserCloudCredential", "requestBody": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateCredential" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/CreateCredential" } } }, "required": true }, @@ -448,76 +286,46 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "204": { - "description": "No Content" - } + "204": { "description": "No Content" } } }, "post": { @@ -526,11 +334,7 @@ "operationId": "addUserCloudCredential", "requestBody": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateCredential" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/CreateCredential" } } }, "required": true }, @@ -538,76 +342,46 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "204": { - "description": "No Content" - } + "204": { "description": "No Content" } } }, "delete": { @@ -640,9 +414,7 @@ "in": "query", "description": "The site of the provider.", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "type", @@ -659,85 +431,53 @@ "in": "query", "description": "The name of credential.", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "204": { - "description": "No Content" - } + "204": { "description": "No Content" } } } }, @@ -751,91 +491,55 @@ "name": "serviceId", "in": "path", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "202": { "description": "Accepted", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceOrder" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceOrder" } } } } } } @@ -850,91 +554,55 @@ "name": "serviceId", "in": "path", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "202": { "description": "Accepted", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceOrder" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceOrder" } } } } } } @@ -949,91 +617,55 @@ "name": "serviceId", "in": "path", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "408": { - "description": "Request Timeout", + "401": { + "description": "Unauthorized", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "202": { - "description": "Accepted", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceOrder" - } - } + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "408": { + "description": "Request Timeout", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } + }, + "202": { + "description": "Accepted", + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceOrder" } } } } } } @@ -1048,91 +680,55 @@ "name": "serviceId", "in": "path", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "202": { "description": "Accepted", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceOrder" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceOrder" } } } } } } @@ -1148,19 +744,11 @@ "in": "path", "description": "Id of the service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ModifyRequest" - } - } - }, + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModifyRequest" } } }, "required": true }, "responses": { @@ -1168,59 +756,47 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "502": { + "400": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "401": { + "422": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "400": { + "403": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "422": { + "401": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "403": { + "502": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, @@ -1228,21 +804,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, "202": { "description": "Accepted", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceOrder" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceOrder" } } } } } } @@ -1257,9 +825,7 @@ "name": "serviceId", "in": "path", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { @@ -1267,59 +833,47 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "502": { + "400": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "401": { + "422": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "400": { + "403": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "422": { + "401": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "403": { + "502": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, @@ -1327,21 +881,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, "202": { "description": "Accepted", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceOrder" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceOrder" } } } } } } @@ -1357,18 +903,12 @@ "in": "path", "description": "The id of the deployed service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceConfigurationUpdate" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ServiceConfigurationUpdate" } } }, "required": true }, @@ -1376,82 +916,48 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceOrder" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceOrder" } } } } } } @@ -1467,18 +973,12 @@ "in": "path", "description": "Id of the service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceLockConfig" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ServiceLockConfig" } } }, "required": true }, @@ -1486,82 +986,48 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceOrder" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceOrder" } } } } } } @@ -1577,98 +1043,63 @@ "in": "path", "description": "id of service template", "required": true, - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceTemplateDetailVo" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTemplateDetailVo" } } } } } }, "put": { "tags": ["ServiceVendor"], - "description": "Update service template using id and ocl model.
Required role: admin or isv
", + "description": "Updates an existing service template using Ocl model. When the request is approved, the updated service template will be published to catalog.
Required role: admin or isv
", "operationId": "update", "parameters": [ { @@ -1676,109 +1107,68 @@ "in": "path", "description": "id of service template", "required": true, - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } }, { - "name": "isRemoveServiceTemplateUntilApproved", + "name": "isUnpublishUntilApproved", "in": "query", "description": "If true, the old service template is also removed from catalog until the updated one is reviewed and approved.", "required": true, - "schema": { - "type": "boolean" - } + "schema": { "type": "boolean" } } ], "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Ocl" - } - } - }, + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ocl" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceTemplateRequestInfo" - } + "schema": { "$ref": "#/components/schemas/ServiceTemplateRequestInfo" } } } } @@ -1794,285 +1184,247 @@ "in": "path", "description": "id of service template", "required": true, - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "204": { - "description": "No Content" - } + "204": { "description": "No Content" } } } }, - "/xpanse/service_templates/remove_from_catalog/{serviceTemplateId}": { + "/xpanse/service_templates/unpublish/{serviceTemplateId}": { "put": { "tags": ["ServiceVendor"], - "description": "Remove service template from catalog using id.
Required role: admin or isv
", - "operationId": "removeFromCatalog", + "description": "Remove the service template from catalog.
Required role: admin or isv
", + "operationId": "unpublish", "parameters": [ { "name": "serviceTemplateId", "in": "path", "description": "id of service template", "required": true, - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceTemplateRequestInfo" - } + "schema": { "$ref": "#/components/schemas/ServiceTemplateRequestInfo" } } } } } } }, - "/xpanse/service_templates/re_add_to_catalog/{serviceTemplateId}": { + "/xpanse/service_templates/requests/cancel/{requestId}": { "put": { "tags": ["ServiceVendor"], - "description": "Re-add the service template to catalog using id.
Required role: admin or isv
", - "operationId": "reAddToCatalog", + "description": "Cancel service template request using request id.
Required role: admin or isv
", + "operationId": "cancelServiceTemplateRequestByRequestId", "parameters": [ { - "name": "serviceTemplateId", + "name": "requestId", "in": "path", - "description": "id of service template", + "description": "id of service template request", "required": true, - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "502": { - "description": "Bad Gateway", + "400": { + "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "408": { + "description": "Request Timeout", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "204": { "description": "No Content" } + } + } + }, + "/xpanse/service_templates/republish/{serviceTemplateId}": { + "put": { + "tags": ["ServiceVendor"], + "description": "Publishes the same service template to catalog again.
Required role: admin or isv
", + "operationId": "republish", + "parameters": [ + { + "name": "serviceTemplateId", + "in": "path", + "description": "id of service template", + "required": true, + "schema": { "type": "string", "format": "uuid" } + } + ], + "responses": { + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceTemplateRequestInfo" - } + "schema": { "$ref": "#/components/schemas/ServiceTemplateRequestInfo" } } } } @@ -2082,7 +1434,7 @@ "/xpanse/service_templates/file/{serviceTemplateId}": { "put": { "tags": ["ServiceVendor"], - "description": "Update service template using id and URL of Ocl file.
Required role: admin or isv
", + "description": "Updates an existing service template using URL of Ocl file. When the request is approved, the updated service template will be published to catalog.
Required role: admin or isv
", "operationId": "fetchUpdate", "parameters": [ { @@ -2090,208 +1442,137 @@ "in": "path", "description": "id of service template", "required": true, - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } }, { - "name": "isRemoveServiceTemplateUntilApproved", + "name": "isUnpublishUntilApproved", "in": "query", "description": "If true, the old service template is also removed from catalog until the updated one is reviewed and approved.", "required": true, - "schema": { - "type": "boolean" - } + "schema": { "type": "boolean" } }, { "name": "oclLocation", "in": "query", "description": "URL of Ocl file", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "502": { - "description": "Bad Gateway", + "422": { + "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "403": { - "description": "Forbidden", + "502": { + "description": "Bad Gateway", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceTemplateRequestInfo" - } + "schema": { "$ref": "#/components/schemas/ServiceTemplateRequestInfo" } } } } } } }, - "/xpanse/service/policies/{id}": { + "/xpanse/service/policies/{servicePolicyId}": { "get": { "tags": ["ServicePoliciesManagement"], "description": "Get details of policy belongs to the registered service template.
Required role: admin or isv
", "operationId": "getServicePolicyDetails", "parameters": [ { - "name": "id", + "name": "servicePolicyId", "in": "path", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServicePolicy" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ServicePolicy" } } } } } @@ -2302,22 +1583,16 @@ "operationId": "updateServicePolicy", "parameters": [ { - "name": "id", + "name": "servicePolicyId", "in": "path", "description": "ID of the policy to be updated", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServicePolicyUpdateRequest" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ServicePolicyUpdateRequest" } } }, "required": true }, @@ -2325,81 +1600,49 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServicePolicy" - } - } + "description": "OK", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ServicePolicy" } } } } } @@ -2410,186 +1653,118 @@ "operationId": "deleteServicePolicy", "parameters": [ { - "name": "id", + "name": "servicePolicyId", "in": "path", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "204": { - "description": "No Content" - } + "204": { "description": "No Content" } } } }, - "/xpanse/policies/{id}": { + "/xpanse/policies/{userPolicyId}": { "get": { "tags": ["UserPoliciesManagement"], "description": "Get the details of the policy created by the user.
Required role: admin or user
", "operationId": "getPolicyDetails", "parameters": [ { - "name": "id", + "name": "userPolicyId", "in": "path", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserPolicy" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPolicy" } } } } } }, @@ -2599,22 +1774,16 @@ "operationId": "updateUserPolicy", "parameters": [ { - "name": "id", + "name": "userPolicyId", "in": "path", - "description": "ID of the policy to be updated", + "description": "id of the policy created by user to be updated", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserPolicyUpdateRequest" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/UserPolicyUpdateRequest" } } }, "required": true }, @@ -2622,82 +1791,48 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserPolicy" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPolicy" } } } } } }, @@ -2707,88 +1842,57 @@ "operationId": "deleteUserPolicy", "parameters": [ { - "name": "id", + "name": "userPolicyId", "in": "path", + "description": "id of the policy created by user to be updated", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "204": { - "description": "No Content" - } + "204": { "description": "No Content" } } } }, @@ -2833,71 +1937,43 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "502": { - "description": "Bad Gateway", + "400": { + "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "401": { - "description": "Unauthorized", + "422": { + "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "403": { - "description": "Forbidden", + "502": { + "description": "Bad Gateway", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { @@ -2906,9 +1982,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/AbstractCredentialInfo" - } + "items": { "$ref": "#/components/schemas/AbstractCredentialInfo" } } } } @@ -2921,11 +1995,7 @@ "operationId": "updateIsvCloudCredential", "requestBody": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateCredential" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/CreateCredential" } } }, "required": true }, @@ -2933,76 +2003,46 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "204": { - "description": "No Content" - } + "204": { "description": "No Content" } } }, "post": { @@ -3011,11 +2051,7 @@ "operationId": "addIsvCloudCredential", "requestBody": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateCredential" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/CreateCredential" } } }, "required": true }, @@ -3023,76 +2059,46 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "204": { - "description": "No Content" - } + "204": { "description": "No Content" } } }, "delete": { @@ -3125,9 +2131,7 @@ "in": "query", "description": "The site of the provider.", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "type", @@ -3144,85 +2148,53 @@ "in": "query", "description": "The name of credential.", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "204": { - "description": "No Content" - } + "204": { "description": "No Content" } } } }, @@ -3237,18 +2209,13 @@ "in": "path", "description": "id of service template request", "required": true, - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ReviewServiceTemplateRequest" - } + "schema": { "$ref": "#/components/schemas/ReviewServiceTemplateRequest" } } }, "required": true @@ -3257,76 +2224,46 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "204": { - "description": "No Content" - } + "204": { "description": "No Content" } } } }, @@ -3341,17 +2278,13 @@ "in": "path", "description": "id of the update request.", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceConfigurationChangeResult" - } + "schema": { "$ref": "#/components/schemas/ServiceConfigurationChangeResult" } } }, "required": true @@ -3360,76 +2293,46 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "502": { - "description": "Bad Gateway", + "400": { + "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "401": { - "description": "Unauthorized", + "422": { + "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "403": { + "description": "Forbidden", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "403": { - "description": "Forbidden", + "502": { + "description": "Bad Gateway", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "204": { - "description": "No Content" - } + "204": { "description": "No Content" } } } }, @@ -3485,18 +2388,14 @@ "in": "query", "description": "name of the service", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "serviceVersion", "in": "query", "description": "version of the service", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "serviceState", @@ -3525,71 +2424,43 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { @@ -3598,9 +2469,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/DeployedService" - } + "items": { "$ref": "#/components/schemas/DeployedService" } } } } @@ -3612,13 +2481,7 @@ "description": "Create an order task to deploy new service using approved service template.
Required role: admin or user
", "operationId": "deploy", "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeployRequest" - } - } - }, + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeployRequest" } } }, "required": true }, "responses": { @@ -3626,59 +2489,47 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "502": { + "400": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "401": { + "422": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "400": { + "403": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "422": { + "401": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "403": { + "502": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, @@ -3686,21 +2537,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, "202": { "description": "Accepted", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceOrder" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceOrder" } } } } } } @@ -3711,95 +2554,55 @@ "description": "Create a job to migrate the deployed service.
Required role: admin or user
", "operationId": "migrate", "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MigrateRequest" - } - } - }, + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MigrateRequest" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "202": { "description": "Accepted", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceOrder" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceOrder" } } } } } } @@ -3856,18 +2659,14 @@ "in": "query", "description": "name of the service", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "serviceVersion", "in": "query", "description": "version of the service", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "serviceHostingType", @@ -3885,99 +2684,64 @@ "in": "query", "description": "state of service template registration", "required": false, - "schema": { - "type": "string", - "enum": ["in-review", "approved", "rejected"] - } + "schema": { "type": "string", "enum": ["in-review", "approved", "cancelled", "rejected"] } }, { "name": "isAvailableInCatalog", "in": "query", "description": "is available in catalog", "required": false, - "schema": { - "type": "boolean" - } + "schema": { "type": "boolean" } }, { "name": "isReviewInProgress", "in": "query", "description": "is any request in review progress", "required": false, - "schema": { - "type": "boolean" - } + "schema": { "type": "boolean" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { @@ -3986,9 +2750,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/ServiceTemplateDetailVo" - } + "items": { "$ref": "#/components/schemas/ServiceTemplateDetailVo" } } } } @@ -3997,96 +2759,60 @@ }, "post": { "tags": ["ServiceVendor"], - "description": "Register new service template using ocl model.
Required role: admin or isv
", + "description": "Submits a new service template using Ocl model. When the request is approved, the service template will be published to catalog.
Required role: admin or isv
", "operationId": "register", "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Ocl" - } - } - }, + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ocl" } } }, "required": true }, "responses": { - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", + "500": { + "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceTemplateRequestInfo" - } + "schema": { "$ref": "#/components/schemas/ServiceTemplateRequestInfo" } } } } @@ -4096,7 +2822,7 @@ "/xpanse/service_templates/file": { "post": { "tags": ["ServiceVendor"], - "description": "Register new service template using URL of Ocl file.
Required role: admin or isv
", + "description": "Submits a new service template using URL of Ocl file. When the request is approved, the service template will be published to catalog.
Required role: admin or isv
", "operationId": "fetch", "parameters": [ { @@ -4104,89 +2830,57 @@ "in": "query", "description": "URL of Ocl file", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "502": { - "description": "Bad Gateway", + "422": { + "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "403": { - "description": "Forbidden", + "502": { + "description": "Bad Gateway", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceTemplateRequestInfo" - } + "schema": { "$ref": "#/components/schemas/ServiceTemplateRequestInfo" } } } } @@ -4202,94 +2896,59 @@ { "name": "serviceTemplateId", "in": "query", - "description": "The id of registered service template which the policy belongs to.", + "description": "The id of service template which the policy belongs to.", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ServicePolicy" - } - } + "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServicePolicy" } } } } } @@ -4301,11 +2960,7 @@ "operationId": "addServicePolicy", "requestBody": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServicePolicyCreateRequest" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ServicePolicyCreateRequest" } } }, "required": true }, @@ -4313,81 +2968,49 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServicePolicy" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ServicePolicy" } } } } } @@ -4424,92 +3047,57 @@ "in": "query", "description": "Is the policy enabled.", "required": false, - "schema": { - "type": "boolean" - } + "schema": { "type": "boolean" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserPolicy" - } - } + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserPolicy" } } } } } @@ -4521,11 +3109,7 @@ "operationId": "addUserPolicy", "requestBody": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserPolicyCreateRequest" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/UserPolicyCreateRequest" } } }, "required": true }, @@ -4533,82 +3117,48 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserPolicy" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPolicy" } } } } } } @@ -4624,93 +3174,57 @@ "in": "query", "description": "the status of task", "required": false, - "schema": { - "type": "string", - "enum": ["done", "failed"] - } + "schema": { "type": "string", "enum": ["done", "failed"] } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WorkFlowTask" - } - } + "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkFlowTask" } } } } } @@ -4728,90 +3242,56 @@ "in": "path", "description": "The id of deployed service.", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserOrderableServiceVo" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/UserOrderableServiceVo" } } } } } @@ -4828,80 +3308,50 @@ "in": "path", "description": "Id of the deployed service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { @@ -4910,9 +3360,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/DeployResource" - } + "items": { "$ref": "#/components/schemas/DeployResource" } } } } @@ -4931,9 +3379,7 @@ "in": "path", "description": "Id of the service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } }, { "name": "taskType", @@ -4955,90 +3401,59 @@ "purge", "serviceStart", "serviceStop", - "serviceRestart" - ] - } - }, - { - "name": "taskStatus", - "in": "query", - "description": "Task status of the service order", - "required": false, - "schema": { - "type": "string", - "enum": ["created", "in-progress", "successful", "failed"] - } - } - ], - "responses": { - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "serviceRestart" + ] } }, - "401": { - "description": "Unauthorized", + { + "name": "taskStatus", + "in": "query", + "description": "Task status of the service order", + "required": false, + "schema": { "type": "string", "enum": ["created", "in-progress", "successful", "failed"] } + } + ], + "responses": { + "500": { + "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { @@ -5047,9 +3462,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/ServiceOrderDetails" - } + "items": { "$ref": "#/components/schemas/ServiceOrderDetails" } } } } @@ -5066,85 +3479,53 @@ "in": "path", "description": "Id of the service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "204": { - "description": "No Content" - } + "204": { "description": "No Content" } } } }, @@ -5159,9 +3540,7 @@ "in": "path", "description": "ID of the service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } }, { "name": "lastKnownServiceDeploymentState", @@ -5190,81 +3569,49 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeploymentStatusUpdate" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentStatusUpdate" } } } } } @@ -5281,90 +3628,56 @@ "in": "path", "description": "Id of the service order", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceOrderDetails" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ServiceOrderDetails" } } } } } @@ -5379,85 +3692,53 @@ "in": "path", "description": "Id of the service order", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "204": { - "description": "No Content" - } + "204": { "description": "No Content" } } } }, @@ -5472,99 +3753,64 @@ "in": "path", "description": "Id of the service order", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } }, { "name": "lastKnownServiceDeploymentState", "in": "query", "description": "Last known service order task status to client. When provided, the service will wait for a configured period time until to see if there is a change to the last known state.", "required": false, - "schema": { - "type": "string", - "enum": ["created", "in-progress", "successful", "failed"] - } + "schema": { "type": "string", "enum": ["created", "in-progress", "successful", "failed"] } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceOrderStatusUpdate" - } + "schema": { "$ref": "#/components/schemas/ServiceOrderStatusUpdate" } } } } @@ -5623,18 +3869,14 @@ "in": "query", "description": "name of the service", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "serviceVersion", "in": "query", "description": "version of the service", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "serviceState", @@ -5663,71 +3905,43 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { @@ -5736,9 +3950,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/DeployedService" - } + "items": { "$ref": "#/components/schemas/DeployedService" } } } } @@ -5757,90 +3969,56 @@ "in": "path", "description": "Id of deployed service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeployedServiceDetails" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/DeployedServiceDetails" } } } } } @@ -5898,18 +4076,14 @@ "in": "query", "description": "name of the service", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "serviceVersion", "in": "query", "description": "version of the service", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "serviceState", @@ -5938,71 +4112,43 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { @@ -6011,110 +4157,76 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/DeployedService" - } + "items": { "$ref": "#/components/schemas/DeployedService" } } } } } } } - }, - "/xpanse/services/details/vendor_hosted/{serviceId}": { - "get": { - "tags": ["Service"], - "description": "Get deployed service details by serviceId.
Required role: admin or user
", - "operationId": "getVendorHostedServiceDetailsById", - "parameters": [ - { - "name": "serviceId", - "in": "path", - "description": "Id of the service", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", + }, + "/xpanse/services/details/vendor_hosted/{serviceId}": { + "get": { + "tags": ["Service"], + "description": "Get deployed service details by serviceId.
Required role: admin or user
", + "operationId": "getVendorHostedServiceDetailsById", + "parameters": [ + { + "name": "serviceId", + "in": "path", + "description": "Id of the service", + "required": true, + "schema": { "type": "string", "format": "uuid" } + } + ], + "responses": { + "500": { + "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/VendorHostedDeployedServiceDetails" - } + "schema": { "$ref": "#/components/schemas/VendorHostedDeployedServiceDetails" } } } } @@ -6132,90 +4244,56 @@ "in": "path", "description": "Id of the service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeployedServiceDetails" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/DeployedServiceDetails" } } } } } @@ -6232,117 +4310,78 @@ "in": "query", "description": "Id of the deployed service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } }, { "name": "orderId", "in": "query", "description": "id of the service order", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } }, { "name": "resourceName", "in": "query", "description": "name of the service resource", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "configManager", "in": "query", "description": "Manager of the service configuration parameter.", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Status of the service configuration", "required": false, - "schema": { - "type": "string", - "enum": ["pending", "processing", "successful", "error"] - } + "schema": { "type": "string", "enum": ["pending", "processing", "successful", "error"] } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { @@ -6351,9 +4390,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/ServiceConfigurationChangeOrderDetails" - } + "items": { "$ref": "#/components/schemas/ServiceChangeOrderDetails" } } } } @@ -6364,7 +4401,7 @@ "/xpanse/service_templates/{serviceTemplateId}/requests": { "get": { "tags": ["ServiceVendor"], - "description": "Get service template requests using id of service template. The returned requests is sorted by the ascending order of the change requested time.
Required role: admin or isv
", + "description": "Get service template requests using id of service template. The returned requests is sorted in descending order according to the requested time.
Required role: admin or isv
", "operationId": "getServiceTemplateRequestHistoryByServiceTemplateId", "parameters": [ { @@ -6372,101 +4409,64 @@ "in": "path", "description": "id of service template", "required": true, - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } }, { "name": "requestType", "in": "query", "description": "type of service template request", "required": false, - "schema": { - "type": "string", - "enum": ["register", "update", "remove from catalog", "re-add to catalog"] - } + "schema": { "type": "string", "enum": ["register", "update", "unpublish", "republish"] } }, { "name": "requestStatus", "in": "query", "description": "status of service template request", "required": false, - "schema": { - "type": "string", - "enum": ["in-review", "accepted", "rejected"] - } + "schema": { "type": "string", "enum": ["in-review", "accepted", "rejected", "cancelled"] } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { @@ -6475,9 +4475,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/ServiceTemplateRequestHistory" - } + "items": { "$ref": "#/components/schemas/ServiceTemplateRequestHistory" } } } } @@ -6496,92 +4494,55 @@ "in": "path", "description": "id of service template request", "required": true, - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Ocl" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ocl" } } } } } } @@ -6597,345 +4558,233 @@ "in": "path", "description": "The id of the deployed service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceConfigurationDetails" - } + "schema": { "$ref": "#/components/schemas/ServiceConfigurationDetails" } } } } } } }, - "/xpanse/pricing/{templateId}/{regionName}/{siteName}/{billingMode}/{flavorName}": { + "/xpanse/pricing/{serviceTemplateId}/{regionName}/{siteName}/{billingMode}/{flavorName}": { "get": { "tags": ["ServicePrices"], "description": "Get the price of one specific flavor of the service.
Required role: admin or user
", "operationId": "getServicePriceByFlavor", "parameters": [ { - "name": "templateId", + "name": "serviceTemplateId", "in": "path", "description": "id of the service template", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } }, { "name": "regionName", "in": "path", "description": "region name of the service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "siteName", "in": "path", "description": "site name of the region belongs to", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "billingMode", "in": "path", "description": "mode of billing", "required": true, - "schema": { - "type": "string", - "enum": ["Fixed", "Pay per Use"] - } + "schema": { "type": "string", "enum": ["Fixed", "Pay per Use"] } }, { "name": "flavorName", "in": "path", "description": "flavor name of the service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FlavorPriceResult" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/FlavorPriceResult" } } } } } } }, - "/xpanse/pricing/service/{templateId}/{regionName}/{siteName}/{billingMode}": { + "/xpanse/pricing/service/{serviceTemplateId}/{regionName}/{siteName}/{billingMode}": { "get": { "tags": ["ServicePrices"], "description": "Get the prices of all flavors of the service
Required role: admin or user
", "operationId": "getPricesByService", "parameters": [ { - "name": "templateId", + "name": "serviceTemplateId", "in": "path", "description": "id of the service template", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } }, { "name": "regionName", "in": "path", "description": "region name of the service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "siteName", "in": "path", "description": "site name of the region belongs to", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "billingMode", "in": "path", "description": "mode of billing", "required": true, - "schema": { - "type": "string", - "enum": ["Fixed", "Pay per Use"] - } + "schema": { "type": "string", "enum": ["Fixed", "Pay per Use"] } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { @@ -6944,9 +4793,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/FlavorPriceResult" - } + "items": { "$ref": "#/components/schemas/FlavorPriceResult" } } } } @@ -6965,18 +4812,14 @@ "in": "query", "description": "Id of the deployed service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } }, { "name": "resourceId", "in": "query", "description": "Id of resource in the deployed service", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } }, { "name": "monitorResourceType", @@ -6993,125 +4836,78 @@ "in": "query", "description": "Start UNIX timestamp in milliseconds. If no value filled,the default value is the UNIX timestamp in milliseconds of the five minutes ago.", "required": false, - "schema": { - "minimum": 0, - "type": "integer", - "format": "int64" - } + "schema": { "minimum": 0, "type": "integer", "format": "int64" } }, { "name": "to", "in": "query", "description": "End UNIX timestamp in milliseconds. If no value filled,the default value is the UNIX timestamp in milliseconds of the current time.", "required": false, - "schema": { - "minimum": 0, - "type": "integer", - "format": "int64" - } + "schema": { "minimum": 0, "type": "integer", "format": "int64" } }, { "name": "granularity", "in": "query", "description": "Return metrics collected in provided time interval. This depends on how the source systems have generated/collected metrics.", "required": false, - "schema": { - "type": "integer", - "format": "int32" - } + "schema": { "type": "integer", "format": "int32" } }, { "name": "onlyLastKnownMetric", "in": "query", "description": "Returns only the last known metric. When this parameter is set then all other query parameters are ignored.", "required": false, - "schema": { - "type": "boolean", - "default": false - } + "schema": { "type": "boolean", "default": false } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Metric" - } - } + "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Metric" } } } } } @@ -7127,82 +4923,48 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SystemStatus" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemStatus" } } } } } } @@ -7238,84 +5000,49 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } + "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } @@ -7330,71 +5057,43 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { @@ -7456,18 +5155,14 @@ "in": "query", "description": "name of the service", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "serviceVersion", "in": "query", "description": "version of the service", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "serviceHostingType", @@ -7485,99 +5180,64 @@ "in": "query", "description": "state of service template registration", "required": false, - "schema": { - "type": "string", - "enum": ["in-review", "approved", "rejected"] - } + "schema": { "type": "string", "enum": ["in-review", "approved", "cancelled", "rejected"] } }, { "name": "isAvailableInCatalog", "in": "query", "description": "is available in catalog", "required": false, - "schema": { - "type": "boolean" - } + "schema": { "type": "boolean" } }, { "name": "isReviewInProgress", "in": "query", "description": "is any request in review progress", "required": false, - "schema": { - "type": "boolean" - } + "schema": { "type": "boolean" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { @@ -7586,9 +5246,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/ServiceTemplateDetailVo" - } + "items": { "$ref": "#/components/schemas/ServiceTemplateDetailVo" } } } } @@ -7606,92 +5264,57 @@ "name": "serviceTemplateId", "in": "path", "description": "id of service template", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", + "required": true, + "schema": { "type": "string", "format": "uuid" } + } + ], + "responses": { + "500": { + "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceTemplateDetailVo" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTemplateDetailVo" } } } } } @@ -7708,81 +5331,50 @@ "in": "query", "description": "id of service template", "required": false, - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { @@ -7791,9 +5383,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/ServiceTemplateRequestToReview" - } + "items": { "$ref": "#/components/schemas/ServiceTemplateRequestToReview" } } } } @@ -7832,18 +5422,14 @@ "in": "query", "description": "the site of the service belongs to", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "regionName", "in": "query", "description": "name of the region", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "deployResourceKind", @@ -7871,93 +5457,56 @@ "in": "query", "description": "id of the deployed service", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } + "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } @@ -7994,122 +5543,77 @@ "in": "query", "description": "site of the region belongs to", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "regionName", "in": "query", "description": "name of the region", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "serviceTemplateId", "in": "query", "description": "Id of the serviceTemplate", "required": false, - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } }, { "name": "serviceId", "in": "query", "description": "Id of the deployed service", "required": false, - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } + "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } @@ -8156,82 +5660,48 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Link" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Link" } } } } } } @@ -8277,80 +5747,50 @@ "in": "query", "description": "The name of credential.", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { @@ -8359,9 +5799,7 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/AbstractCredentialInfo" - } + "items": { "$ref": "#/components/schemas/AbstractCredentialInfo" } } } } @@ -8400,71 +5838,43 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { @@ -8536,18 +5946,14 @@ "in": "query", "description": "name of the service", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "serviceVersion", "in": "query", "description": "version of the service", "required": false, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "serviceHostingType", @@ -8565,71 +5971,43 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { @@ -8638,17 +6016,13 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/UserOrderableServiceVo" - } + "items": { "$ref": "#/components/schemas/UserOrderableServiceVo" } } }, "application/hal+json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/UserOrderableServiceVo" - } + "items": { "$ref": "#/components/schemas/UserOrderableServiceVo" } } } } @@ -8656,201 +6030,131 @@ } } }, - "/xpanse/catalog/services/{id}": { + "/xpanse/catalog/services/{serviceTemplateId}": { "get": { "tags": ["ServiceCatalog"], "description": "Get deployable service by id.
Required role: admin or user
", "operationId": "getOrderableServiceDetailsById", "parameters": [ { - "name": "id", + "name": "serviceTemplateId", "in": "path", "description": "The id of orderable service.", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserOrderableServiceVo" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/UserOrderableServiceVo" } } } } } } }, - "/xpanse/catalog/services/{id}/openapi": { + "/xpanse/catalog/services/{serviceTemplateId}/openapi": { "get": { "tags": ["ServiceCatalog"], "description": "Get the API document of the orderable service.
Required role: admin or isv or user
", "operationId": "openApi", "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", + { + "name": "serviceTemplateId", + "in": "path", + "required": true, + "schema": { "type": "string", "format": "uuid" } + } + ], + "responses": { + "500": { + "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Link" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Link" } } } } } } @@ -8866,101 +6170,65 @@ "in": "path", "description": "The id of the deployed service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "resourceName", "in": "path", "description": "The name of the resource of deployed service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "204": { - "description": "no pending configuration update requests" - }, + "204": { "description": "no pending configuration update requests" }, "200": { "description": "pending configuration update request details", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceConfigurationChangeRequest" - } + "schema": { "$ref": "#/components/schemas/ServiceConfigurationChangeRequest" } } } } @@ -8978,99 +6246,63 @@ "in": "query", "description": "The authorization code.", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Opaque value used to maintain state.", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TokenResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } } } @@ -9085,76 +6317,46 @@ "500": { "description": "Internal Server Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } + } + }, + "502": { + "description": "Bad Gateway", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "Request Timeout", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "200": { - "description": "OK" - } + "200": { "description": "OK" } } } }, @@ -9169,9 +6371,7 @@ "in": "path", "description": "Id of the service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { @@ -9179,59 +6379,47 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "502": { + "400": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "401": { + "422": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "400": { + "403": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "422": { + "401": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "403": { + "502": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, @@ -9239,21 +6427,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, "202": { "description": "Accepted", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceOrder" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceOrder" } } } } } } @@ -9269,9 +6449,7 @@ "in": "path", "description": "Id of the service", "required": true, - "schema": { - "type": "string" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { @@ -9279,59 +6457,47 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "502": { + "400": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "401": { + "422": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "400": { + "403": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "422": { + "401": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, - "403": { + "502": { "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, @@ -9339,21 +6505,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFailedErrorResponse" - } + "schema": { "$ref": "#/components/schemas/OrderFailedErrorResponse" } } } }, "202": { "description": "Accepted", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceOrder" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceOrder" } } } } } } @@ -9391,7 +6549,7 @@ "Service Template Disabled", "Service Template Request Not Allowed", "Service Template Request Not Found", - "Service Template Request Already Reviewed", + "Review Service Template Request Not Allowed", "Invalid Service Version", "Invalid Service Flavors", "Mandatory Value Missing", @@ -9443,10 +6601,7 @@ "details": { "type": "array", "description": "Details of the errors occurred", - "items": { - "type": "string", - "description": "Details of the errors occurred" - } + "items": { "type": "string", "description": "Details of the errors occurred" } } } }, @@ -9454,10 +6609,7 @@ "required": ["csp", "name", "site", "timeToLive", "type", "variables"], "type": "object", "properties": { - "name": { - "type": "string", - "description": "The name of the credential" - }, + "name": { "type": "string", "description": "The name of the credential" }, "csp": { "type": "string", "description": "The cloud service provider of the credential.", @@ -9473,14 +6625,8 @@ "GoogleCloudPlatform" ] }, - "site": { - "type": "string", - "description": "The site to which the credentials belong to." - }, - "description": { - "type": "string", - "description": "The description of the credential" - }, + "site": { "type": "string", "description": "The site to which the credentials belong to." }, + "description": { "type": "string", "description": "The description of the credential" }, "type": { "type": "string", "description": "The type of the credential", @@ -9489,9 +6635,7 @@ "variables": { "type": "array", "description": "The variables list of the credential. The list elements must be unique.", - "items": { - "$ref": "#/components/schemas/CredentialVariable" - } + "items": { "$ref": "#/components/schemas/CredentialVariable" } }, "timeToLive": { "type": "integer", @@ -9533,11 +6677,7 @@ "required": ["orderId", "serviceId"], "type": "object", "properties": { - "orderId": { - "type": "string", - "description": "The id of the service order.", - "format": "uuid" - }, + "orderId": { "type": "string", "description": "The id of the service order.", "format": "uuid" }, "serviceId": { "type": "string", "description": "The id of the deployed service.", @@ -9552,10 +6692,7 @@ "type": "string", "description": "Customer's name for the service. Used only for customer's reference. If not provided, the existing customerServiceName from the service will be reused." }, - "flavor": { - "type": "string", - "description": "The flavor of the Service." - }, + "flavor": { "type": "string", "description": "The flavor of the Service." }, "serviceRequestProperties": { "type": "object", "additionalProperties": true, @@ -9593,7 +6730,7 @@ "Service Template Disabled", "Service Template Request Not Allowed", "Service Template Request Not Found", - "Service Template Request Already Reviewed", + "Review Service Template Request Not Allowed", "Invalid Service Version", "Invalid Service Flavors", "Mandatory Value Missing", @@ -9645,19 +6782,10 @@ "details": { "type": "array", "description": "Details of the errors occurred", - "items": { - "type": "string", - "description": "Details of the errors occurred" - } + "items": { "type": "string", "description": "Details of the errors occurred" } }, - "serviceId": { - "type": "string", - "description": "The service id associated with the request." - }, - "orderId": { - "type": "string", - "description": "The order id associated with the request." - } + "serviceId": { "type": "string", "description": "The service id associated with the request." }, + "orderId": { "type": "string", "description": "The order id associated with the request." } } }, "ServiceConfigurationUpdate": { @@ -9673,14 +6801,7 @@ }, "ServiceLockConfig": { "type": "object", - "properties": { - "modifyLocked": { - "type": "boolean" - }, - "destroyLocked": { - "type": "boolean" - } - } + "properties": { "modifyLocked": { "type": "boolean" }, "destroyLocked": { "type": "boolean" } } }, "AnsibleScriptConfig": { "required": [ @@ -9714,14 +6835,8 @@ "type": "boolean", "description": "The agent will prepare the virtual environment if this true.Otherwise it is assumed that the environment is already prepared as part of the resource creation or the VM base image build." }, - "repoUrl": { - "type": "string", - "description": "Url of the script repo." - }, - "branch": { - "type": "string", - "description": "Branch of the git repo." - }, + "repoUrl": { "type": "string", "description": "Url of the script repo." }, + "branch": { "type": "string", "description": "Branch of the git repo." }, "requirementsFile": { "type": "string", "description": "the python module requirements file in GIT repo. Should be the fully qualified file name (including the directory path). ", @@ -9762,28 +6877,16 @@ "description": " defines if the required cloud resource can be newly created or should the existing resources must only be used." } }, - "description": "Service config parameter autofill" + "description": "Variable autofill. Defines if the variable must be one of the existing resources of a specific type." }, "AvailabilityZoneConfig": { "required": ["displayName", "mandatory", "varName"], "type": "object", "properties": { - "displayName": { - "type": "string", - "description": "The display name of availability zone." - }, - "varName": { - "type": "string", - "description": "The variable name of availability zone." - }, - "mandatory": { - "type": "boolean", - "description": "Indicates if the variable is mandatory." - }, - "description": { - "type": "string", - "description": "The description of availability zone." - } + "displayName": { "type": "string", "description": "The display name of availability zone." }, + "varName": { "type": "string", "description": "The variable name of availability zone." }, + "mandatory": { "type": "boolean", "description": "Indicates if the variable is mandatory." }, + "description": { "type": "string", "description": "The description of availability zone." } }, "description": "The list of availability zone configuration of the service.The list elements must be unique." }, @@ -9830,9 +6933,7 @@ "regions": { "type": "array", "description": "The regions of the Cloud Service Provider. The list elements must be unique.", - "items": { - "$ref": "#/components/schemas/Region" - } + "items": { "$ref": "#/components/schemas/Region" } } }, "description": "The cloud service provider of the managed service" @@ -9841,52 +6942,34 @@ "required": ["dataType", "description", "kind", "mandatory", "modificationImpact", "name"], "type": "object", "properties": { - "name": { - "type": "string", - "description": "The name of the deploy variable" - }, - "kind": { - "$ref": "#/components/schemas/DeployVariableKind" - }, + "name": { "type": "string", "description": "The name of the deploy variable" }, + "kind": { "$ref": "#/components/schemas/DeployVariableKind" }, "dataType": { "type": "string", "description": "The type of the deploy variable", "enum": ["string", "number", "boolean"] }, - "example": { - "type": "string", - "description": "The example value of the deploy variable" - }, - "description": { - "type": "string", - "description": "The description of the deploy variable" - }, + "example": { "type": "string", "description": "The example value of the deploy variable" }, + "description": { "type": "string", "description": "The description of the deploy variable" }, "value": { "type": "string", "description": "The value of the deploy variable. Value can be provided for default variables" }, - "mandatory": { - "type": "boolean", - "description": "Indicates if the variable is mandatory" - }, + "mandatory": { "type": "boolean", "description": "Indicates if the variable is mandatory" }, "valueSchema": { "type": "object", "additionalProperties": true, - "description": "valueSchema of the variable. The key be any keyword that is part of the JSON schema definition which can be found here https://json-schema.org/draft/2020-12/schema" + "description": "valueSchema of the variable. The key be any keyword that is part of the JSON schema definition which can be found here https://json-schema.org/draft/2020-12/meta/validation. Only the type field is taken from dataType parameter directly. " }, "sensitiveScope": { "type": "string", "description": "Sensitive scope of variable storage", "enum": ["none", "once", "always"] }, - "autoFill": { - "$ref": "#/components/schemas/AutoFill" - }, - "modificationImpact": { - "$ref": "#/components/schemas/ModificationImpact" - } + "autoFill": { "$ref": "#/components/schemas/AutoFill" }, + "modificationImpact": { "$ref": "#/components/schemas/ModificationImpact" } }, - "description": "The variables for the deployment, which will be passed to the deployer.The list elements must be unique." + "description": "The variables for the deployment, which will be passed to the deployer.The list elements must be unique. All variables are put together to build a JSON 'object' with each variable as a property of this object." }, "DeployVariableKind": { "type": "string", @@ -9914,15 +6997,11 @@ "required": ["deployerTool", "variables"], "type": "object", "properties": { - "deployerTool": { - "$ref": "#/components/schemas/DeployerTool" - }, + "deployerTool": { "$ref": "#/components/schemas/DeployerTool" }, "variables": { "type": "array", - "description": "The variables for the deployment, which will be passed to the deployer.The list elements must be unique.", - "items": { - "$ref": "#/components/schemas/DeployVariable" - } + "description": "The variables for the deployment, which will be passed to the deployer.The list elements must be unique. All variables are put together to build a JSON 'object' with each variable as a property of this object.", + "items": { "$ref": "#/components/schemas/DeployVariable" } }, "credentialType": { "type": "string", @@ -9934,17 +7013,17 @@ "minItems": 1, "type": "array", "description": "The list of availability zone configuration of the service.The list elements must be unique.", - "items": { - "$ref": "#/components/schemas/AvailabilityZoneConfig" - } + "items": { "$ref": "#/components/schemas/AvailabilityZoneConfig" } }, - "deployer": { - "type": "string", - "description": "The real deployer, something like terraform scripts. Either deployer or deployFromGitRepo must be provided." + "scriptFiles": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "Deployment scripts stored in a Map. file name as the key and content as the value. Either scriptFiles or scriptsRepo must be provided." + }, + "description": "Deployment scripts stored in a Map. file name as the key and content as the value. Either scriptFiles or scriptsRepo must be provided." }, - "scriptsRepo": { - "$ref": "#/components/schemas/ScriptsRepo" - } + "scriptsRepo": { "$ref": "#/components/schemas/ScriptsRepo" } }, "description": "The deployment of the managed service" }, @@ -9955,20 +7034,14 @@ "serviceFlavors": { "type": "array", "description": "The flavors of the managed service. The list elements must be unique.", - "items": { - "$ref": "#/components/schemas/ServiceFlavorWithPrice" - } - }, - "modificationImpact": { - "$ref": "#/components/schemas/ModificationImpact" + "items": { "$ref": "#/components/schemas/ServiceFlavorWithPrice" } }, + "modificationImpact": { "$ref": "#/components/schemas/ModificationImpact" }, "isDowngradeAllowed": { "type": "boolean", "description": "Whether the downgrading is allowed, default value: true." }, - "downgradeAllowed": { - "type": "boolean" - } + "downgradeAllowed": { "type": "boolean" } }, "description": "The flavors of the managed service" }, @@ -10020,63 +7093,28 @@ "others" ] }, - "version": { - "type": "string", - "description": "The version of the Ocl" - }, - "name": { - "type": "string", - "description": "The name of the managed service" - }, - "serviceVersion": { - "type": "string", - "description": "The version of the managed service" - }, - "description": { - "type": "string", - "description": "The description of the managed service" - }, - "serviceVendor": { - "type": "string", - "description": "The serviceVendor of the managed service" - }, - "icon": { - "type": "string", - "description": "The icon of the managed service" - }, - "cloudServiceProvider": { - "$ref": "#/components/schemas/CloudServiceProvider" - }, - "deployment": { - "$ref": "#/components/schemas/Deployment" - }, - "flavors": { - "$ref": "#/components/schemas/FlavorsWithPrice" - }, - "billing": { - "$ref": "#/components/schemas/Billing" - }, + "version": { "type": "string", "description": "The version of the Ocl" }, + "name": { "type": "string", "description": "The name of the managed service" }, + "serviceVersion": { "type": "string", "description": "The version of the managed service" }, + "description": { "type": "string", "description": "The description of the managed service" }, + "serviceVendor": { "type": "string", "description": "The serviceVendor of the managed service" }, + "icon": { "type": "string", "description": "The icon of the managed service" }, + "cloudServiceProvider": { "$ref": "#/components/schemas/CloudServiceProvider" }, + "deployment": { "$ref": "#/components/schemas/Deployment" }, + "flavors": { "$ref": "#/components/schemas/FlavorsWithPrice" }, + "billing": { "$ref": "#/components/schemas/Billing" }, "serviceHostingType": { "type": "string", "description": "Defines which cloud service account is used for deploying cloud resources.", "enum": ["self", "service-vendor"] }, - "serviceProviderContactDetails": { - "$ref": "#/components/schemas/ServiceProviderContactDetails" - }, - "eula": { - "type": "string", - "description": "End user license agreement content of the service." - }, - "serviceConfigurationManage": { - "$ref": "#/components/schemas/ServiceChangeManage" - }, + "serviceProviderContactDetails": { "$ref": "#/components/schemas/ServiceProviderContactDetails" }, + "eula": { "type": "string", "description": "End user license agreement content of the service." }, + "serviceConfigurationManage": { "$ref": "#/components/schemas/ServiceChangeManage" }, "serviceActions": { "type": "array", "description": "manage service action.", - "items": { - "$ref": "#/components/schemas/ServiceAction" - } + "items": { "$ref": "#/components/schemas/ServiceAction" } } } }, @@ -10084,10 +7122,7 @@ "required": ["cost", "currency"], "type": "object", "properties": { - "cost": { - "type": "number", - "description": "The value of the cost." - }, + "cost": { "type": "number", "description": "The value of the cost." }, "currency": { "type": "string", "description": "The currency of the cost.", @@ -10113,9 +7148,7 @@ "type": "string", "description": "The defined site name. If the special name 'default' provided, this price for all sites." }, - "price": { - "$ref": "#/components/schemas/Price" - } + "price": { "$ref": "#/components/schemas/Price" } }, "description": "The listed price list of the flavor of the manged service." }, @@ -10126,13 +7159,9 @@ "fixedPrices": { "type": "array", "description": "The fixed prices of the flavor in the managed service for regions. The fixed price of the region includes all prices and shown to the customer.", - "items": { - "$ref": "#/components/schemas/PriceWithRegion" - } - }, - "resourceUsage": { - "$ref": "#/components/schemas/ResourceUsage" + "items": { "$ref": "#/components/schemas/PriceWithRegion" } }, + "resourceUsage": { "$ref": "#/components/schemas/ResourceUsage" }, "isPriceOnlyForManagementLayer": { "type": "boolean", "description": "Whether the price is only for management layer. Consumption of the workload resources will be billed additionally.." @@ -10144,10 +7173,7 @@ "required": ["area", "name", "site"], "type": "object", "properties": { - "name": { - "type": "string", - "description": "The name of the region" - }, + "name": { "type": "string", "description": "The name of the region" }, "site": { "type": "string", "description": "The site with the region belongs to, such as default, Chinese Mainland, International, " @@ -10163,11 +7189,7 @@ "required": ["count", "deployResourceKind"], "type": "object", "properties": { - "count": { - "type": "integer", - "description": "The count of the same resource.", - "format": "int32" - }, + "count": { "type": "integer", "description": "The count of the same resource.", "format": "int32" }, "deployResourceKind": { "type": "string", "description": "The kind of the same resource.", @@ -10202,23 +7224,17 @@ "resources": { "type": "array", "description": "The resources of the flavor of the manged service.", - "items": { - "$ref": "#/components/schemas/Resource" - } + "items": { "$ref": "#/components/schemas/Resource" } }, "licensePrices": { "type": "array", "description": "The license prices of the flavor of the manged service.", - "items": { - "$ref": "#/components/schemas/PriceWithRegion" - } + "items": { "$ref": "#/components/schemas/PriceWithRegion" } }, "markUpPrices": { "type": "array", "description": "The listed price list of the flavor of the manged service.", - "items": { - "$ref": "#/components/schemas/PriceWithRegion" - } + "items": { "$ref": "#/components/schemas/PriceWithRegion" } } }, "description": "The resource usage of the flavor in the managed service." @@ -10227,29 +7243,20 @@ "required": ["branch", "repoUrl"], "type": "object", "properties": { - "repoUrl": { - "type": "string", - "description": "URL of the repo" - }, - "branch": { - "type": "string", - "description": "Branch to be checked out. Can be branch or a Tag" - }, + "repoUrl": { "type": "string", "description": "URL of the repo" }, + "branch": { "type": "string", "description": "Branch to be checked out. Can be branch or a Tag" }, "scriptsPath": { "type": "string", "description": "Directory in the repo where scripts are present. If not provided, the root directory of the repo is considered" } }, - "description": "Deployment scripts hosted on a GIT repo. Either deployer or deployFromGitRepo must be provided." + "description": "Deployment scripts hosted on a GIT repo. Either scriptFiles or scriptsRepo must be provided." }, "ServiceAction": { "required": ["name", "type"], "type": "object", "properties": { - "name": { - "type": "string", - "description": "the name of service action." - }, + "name": { "type": "string", "description": "the name of service action." }, "type": { "type": "string", "description": "the tool used to manage the service action.", @@ -10260,18 +7267,14 @@ "minItems": 1, "type": "array", "description": "The collection of the action manage script.", - "items": { - "$ref": "#/components/schemas/ServiceChangeScript" - } + "items": { "$ref": "#/components/schemas/ServiceChangeScript" } }, "actionParameters": { "maxItems": 2147483647, "minItems": 1, "type": "array", - "description": "The collection of service action parameters.", - "items": { - "$ref": "#/components/schemas/ServiceChangeParameter" - } + "description": "The configuration parameters of service .The list elements must be unique. All parameters are put together to build a JSON 'object' with each parameter as a property of this object.", + "items": { "$ref": "#/components/schemas/ServiceChangeParameter" } } }, "description": "manage service action." @@ -10294,18 +7297,14 @@ "minItems": 1, "type": "array", "description": "The collection of the configuration manage script.", - "items": { - "$ref": "#/components/schemas/ServiceChangeScript" - } + "items": { "$ref": "#/components/schemas/ServiceChangeScript" } }, "configurationParameters": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "The collection of service configuration parameters.", - "items": { - "$ref": "#/components/schemas/ServiceChangeParameter" - } + "items": { "$ref": "#/components/schemas/ServiceChangeParameter" } } }, "description": "manage service configuration." @@ -10323,22 +7322,14 @@ ], "type": "object", "properties": { - "name": { - "type": "string", - "description": "The name of the service config parameter" - }, - "kind": { - "$ref": "#/components/schemas/DeployVariableKind" - }, + "name": { "type": "string", "description": "The name of the service config parameter" }, + "kind": { "$ref": "#/components/schemas/DeployVariableKind" }, "dataType": { "type": "string", "description": "The type of the service config parameter", "enum": ["string", "number", "boolean"] }, - "example": { - "type": "string", - "description": "The example value of the service config parameter" - }, + "example": { "type": "string", "description": "The example value of the service config parameter" }, "description": { "type": "string", "description": "The description of the service config parameter" @@ -10354,19 +7345,14 @@ "valueSchema": { "type": "object", "additionalProperties": true, - "description": "valueSchema of the service config parameter. The key be any keyword that is part of the JSON schema definition which can be found here https://json-schema.org/draft/2020-12/schema" + "description": "valueSchema of the variable. The key be any keyword that is part of the JSON schema definition which can be found here https://json-schema.org/draft/2020-12/meta/validation. Only the type field is taken from dataType parameter directly. " }, "sensitiveScope": { "type": "string", "description": "Sensitive scope of service config parameter storage", "enum": ["none", "once", "always"] }, - "autoFill": { - "$ref": "#/components/schemas/AutoFill" - }, - "modificationImpact": { - "$ref": "#/components/schemas/ModificationImpact" - }, + "modificationImpact": { "$ref": "#/components/schemas/ModificationImpact" }, "isReadOnly": { "type": "boolean", "description": "Whether the service configuration parameters are read-only" @@ -10376,7 +7362,7 @@ "description": "Service component which manages this configuration parameter." } }, - "description": "The collection of service action parameters." + "description": "The configuration parameters of service .The list elements must be unique. All parameters are put together to build a JSON 'object' with each parameter as a property of this object." }, "ServiceChangeScript": { "required": ["ansibleScriptConfig", "changeHandler", "runOnlyOnce"], @@ -10390,9 +7376,7 @@ "type": "boolean", "description": "Means should the configuration update run on each node of the specific component or just one." }, - "ansibleScriptConfig": { - "$ref": "#/components/schemas/AnsibleScriptConfig" - } + "ansibleScriptConfig": { "$ref": "#/components/schemas/AnsibleScriptConfig" } }, "description": "The collection of the action manage script." }, @@ -10400,16 +7384,10 @@ "required": ["name", "pricing", "priority", "properties"], "type": "object", "properties": { - "name": { - "type": "string", - "description": "The flavor name" - }, + "name": { "type": "string", "description": "The flavor name" }, "properties": { "type": "object", - "additionalProperties": { - "type": "string", - "description": "The properties of the flavor" - }, + "additionalProperties": { "type": "string", "description": "The properties of the flavor" }, "description": "The properties of the flavor" }, "priority": { @@ -10426,9 +7404,7 @@ "description": "Important features and differentiators of the flavor." } }, - "pricing": { - "$ref": "#/components/schemas/RatingMode" - } + "pricing": { "$ref": "#/components/schemas/RatingMode" } }, "description": "The flavors of the managed service. The list elements must be unique." }, @@ -10492,28 +7468,21 @@ "description": "ID of the request history of the service template.", "format": "uuid" }, - "requestSubmittedForReview": { - "type": "boolean" - } + "requestSubmittedForReview": { "type": "boolean" } } }, "ServicePolicyUpdateRequest": { "type": "object", "properties": { - "flavorNameList": { - "maxItems": 2147483647, - "minItems": 1, + "flavorNames": { "type": "array", - "description": "The flavor name list which the policy belongs to. If the list is empty, then the policy will be executed for during service deployment of all flavors.", + "description": "The flavor names to which the policy belongs. If the list is empty, then the policy will be executed for during service deployment of all flavors.", "items": { "type": "string", - "description": "The flavor name list which the policy belongs to. If the list is empty, then the policy will be executed for during service deployment of all flavors." + "description": "The flavor names to which the policy belongs. If the list is empty, then the policy will be executed for during service deployment of all flavors." } }, - "policy": { - "type": "string", - "description": "The policy." - }, + "policy": { "type": "string", "description": "The policy." }, "enabled": { "type": "boolean", "description": "Is the policy enabled. true:enabled;false:disabled." @@ -10531,15 +7500,8 @@ ], "type": "object", "properties": { - "servicePolicyId": { - "type": "string", - "description": "The id of the policy.", - "format": "uuid" - }, - "policy": { - "type": "string", - "description": "The valid policy belongs to the service." - }, + "servicePolicyId": { "type": "string", "description": "The id of the policy.", "format": "uuid" }, + "policy": { "type": "string", "description": "The valid policy belongs to the service." }, "serviceTemplateId": { "type": "string", "description": "The id of registered service template which the policy belongs to.", @@ -10553,10 +7515,7 @@ "description": "The flavor name list which the policy belongs to. If the list is empty, then the policy will be executed for during service deployment of all flavors." } }, - "enabled": { - "type": "boolean", - "description": "Is the policy enabled." - }, + "enabled": { "type": "boolean", "description": "Is the policy enabled." }, "createTime": { "type": "string", "description": "Time of the policy created.", @@ -10587,10 +7546,7 @@ "GoogleCloudPlatform" ] }, - "policy": { - "type": "string", - "description": "The policy." - }, + "policy": { "type": "string", "description": "The policy." }, "enabled": { "type": "boolean", "description": "Is the policy enabled. true:enabled;false:disabled." @@ -10601,15 +7557,8 @@ "required": ["createTime", "csp", "enabled", "lastModifiedTime", "policy", "userPolicyId"], "type": "object", "properties": { - "userPolicyId": { - "type": "string", - "description": "The id of the policy.", - "format": "uuid" - }, - "policy": { - "type": "string", - "description": "The valid policy created by the user." - }, + "userPolicyId": { "type": "string", "description": "The id of the policy.", "format": "uuid" }, + "policy": { "type": "string", "description": "The valid policy created by the user." }, "csp": { "type": "string", "description": "The csp which the policy belongs to.", @@ -10625,10 +7574,7 @@ "GoogleCloudPlatform" ] }, - "enabled": { - "type": "boolean", - "description": "Is the policy enabled." - }, + "enabled": { "type": "boolean", "description": "Is the policy enabled." }, "createTime": { "type": "string", "description": "Time of the policy created.", @@ -10642,7 +7588,7 @@ } }, "ReviewServiceTemplateRequest": { - "required": ["reviewResult"], + "required": ["reviewComment", "reviewResult"], "type": "object", "properties": { "reviewResult": { @@ -10650,41 +7596,23 @@ "description": "The result of review registration.", "enum": ["approved", "rejected"] }, - "reviewComment": { - "type": "string", - "description": "The comment of review registration." - } + "reviewComment": { "type": "string", "description": "The comment of review registration." } } }, "AnsibleTaskResult": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "isSuccessful": { - "type": "boolean" - }, - "message": { - "type": "string" - } + "name": { "type": "string" }, + "isSuccessful": { "type": "boolean" }, + "message": { "type": "string" } } }, "ServiceConfigurationChangeResult": { "type": "object", "properties": { - "isSuccessful": { - "type": "boolean" - }, - "error": { - "type": "string" - }, - "tasks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AnsibleTaskResult" - } - } + "isSuccessful": { "type": "boolean" }, + "error": { "type": "string" }, + "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/AnsibleTaskResult" } } }, "description": "result of the service configuration update request." }, @@ -10717,21 +7645,13 @@ "others" ] }, - "serviceName": { - "type": "string", - "description": "The name of the service ordered." - }, + "serviceName": { "type": "string", "description": "The name of the service ordered." }, "customerServiceName": { "type": "string", "description": "Customer's name for the service. Used only for customer's reference.If not provided, this value will be auto-generated" }, - "version": { - "type": "string", - "description": "The version of service" - }, - "region": { - "$ref": "#/components/schemas/Region" - }, + "version": { "type": "string", "description": "The version of service" }, + "region": { "$ref": "#/components/schemas/Region" }, "csp": { "type": "string", "description": "The csp of the Service.", @@ -10747,10 +7667,7 @@ "GoogleCloudPlatform" ] }, - "flavor": { - "type": "string", - "description": "The flavor of the Service." - }, + "flavor": { "type": "string", "description": "The flavor of the Service." }, "serviceHostingType": { "type": "string", "description": "Defines which cloud service account is used for deploying cloud resources.", @@ -10774,9 +7691,7 @@ "description": "The billing mode of the managed service.", "enum": ["Fixed", "Pay per Use"] }, - "eulaAccepted": { - "type": "boolean" - } + "eulaAccepted": { "type": "boolean" } } }, "MigrateRequest": { @@ -10809,21 +7724,13 @@ "others" ] }, - "serviceName": { - "type": "string", - "description": "The name of the service ordered." - }, + "serviceName": { "type": "string", "description": "The name of the service ordered." }, "customerServiceName": { "type": "string", "description": "Customer's name for the service. Used only for customer's reference.If not provided, this value will be auto-generated" }, - "version": { - "type": "string", - "description": "The version of service" - }, - "region": { - "$ref": "#/components/schemas/Region" - }, + "version": { "type": "string", "description": "The version of service" }, + "region": { "$ref": "#/components/schemas/Region" }, "csp": { "type": "string", "description": "The csp of the Service.", @@ -10839,10 +7746,7 @@ "GoogleCloudPlatform" ] }, - "flavor": { - "type": "string", - "description": "The flavor of the Service." - }, + "flavor": { "type": "string", "description": "The flavor of the Service." }, "serviceHostingType": { "type": "string", "description": "Defines which cloud service account is used for deploying cloud resources.", @@ -10871,9 +7775,7 @@ "description": "The id of the service to migrate", "format": "uuid" }, - "eulaAccepted": { - "type": "boolean" - } + "eulaAccepted": { "type": "boolean" } } }, "ServicePolicyCreateRequest": { @@ -10893,10 +7795,7 @@ "description": "The flavor name list which the policy belongs to. If the list is empty, then the policy will be executed for during service deployment of all flavors." } }, - "policy": { - "type": "string", - "description": "The policy." - }, + "policy": { "type": "string", "description": "The policy." }, "enabled": { "type": "boolean", "description": "Is the policy enabled. true:enabled;false:disabled." @@ -10922,67 +7821,35 @@ "GoogleCloudPlatform" ] }, - "policy": { - "type": "string", - "description": "The policy." - }, + "policy": { "type": "string", "description": "The policy." }, "enabled": { "type": "boolean", "description": "Is the policy enabled. true:enabled;false:disabled." } } }, - "WorkFlowTask": { - "required": [ - "businessKey", - "createTime", - "executionId", - "processDefinitionId", - "processDefinitionName", - "processInstanceId", - "status", - "taskId", - "taskName" - ], - "type": "object", - "properties": { - "processInstanceId": { - "type": "string", - "description": "The id of the ProcessInstance" - }, - "processInstanceName": { - "type": "string", - "description": "The name of the ProcessInstance" - }, - "processDefinitionId": { - "type": "string", - "description": "The id of the ProcessDefinition" - }, - "processDefinitionName": { - "type": "string", - "description": "The name of the ProcessDefinition" - }, - "executionId": { - "type": "string", - "description": "The execution id of the ProcessInstance" - }, - "taskId": { - "type": "string", - "description": "The id of the task" - }, - "taskName": { - "type": "string", - "description": "The name of the task" - }, - "businessKey": { - "type": "string", - "description": "The businessKey of the Process" - }, - "status": { - "type": "string", - "description": "The status of the Task", - "enum": ["done", "failed"] - }, + "WorkFlowTask": { + "required": [ + "createTime", + "executionId", + "processDefinitionId", + "processDefinitionName", + "processInstanceId", + "status", + "taskId", + "taskName" + ], + "type": "object", + "properties": { + "processInstanceId": { "type": "string", "description": "The id of the ProcessInstance" }, + "processInstanceName": { "type": "string", "description": "The name of the ProcessInstance" }, + "processDefinitionId": { "type": "string", "description": "The id of the ProcessDefinition" }, + "processDefinitionName": { "type": "string", "description": "The name of the ProcessDefinition" }, + "executionId": { "type": "string", "description": "The execution id of the ProcessInstance" }, + "taskId": { "type": "string", "description": "The id of the task" }, + "taskName": { "type": "string", "description": "The name of the task" }, + "businessKey": { "type": "string", "description": "The businessKey of the Process" }, + "status": { "type": "string", "description": "The status of the Task", "enum": ["done", "failed"] }, "createTime": { "type": "string", "description": "The create time of the task", @@ -10994,9 +7861,7 @@ "required": ["csp", "description", "name", "site", "type"], "type": "object", "allOf": [ - { - "$ref": "#/components/schemas/CredentialVariables" - }, + { "$ref": "#/components/schemas/CredentialVariables" }, { "type": "object", "properties": { @@ -11015,10 +7880,7 @@ "GoogleCloudPlatform" ] }, - "site": { - "type": "string", - "description": "The site which the credentials belong to." - }, + "site": { "type": "string", "description": "The site which the credentials belong to." }, "type": { "type": "string", "description": "The type of the credential, this field is provided by the plugin of cloud service provider.", @@ -11032,10 +7894,7 @@ "type": "string", "description": "The description of the credential,this field is provided by the plugin of cloud service provider." }, - "userId": { - "type": "string", - "description": "The id of user who created the credential." - } + "userId": { "type": "string", "description": "The id of user who created the credential." } } } ] @@ -11059,10 +7918,7 @@ "GoogleCloudPlatform" ] }, - "site": { - "type": "string", - "description": "The site which the credentials belong to." - }, + "site": { "type": "string", "description": "The site which the credentials belong to." }, "type": { "type": "string", "description": "The type of the credential, this field is provided by the plugin of cloud service provider.", @@ -11076,18 +7932,13 @@ "type": "string", "description": "The description of the credential,this field is provided by the plugin of cloud service provider." }, - "userId": { - "type": "string", - "description": "The id of user who created the credential." - }, + "userId": { "type": "string", "description": "The id of user who created the credential." }, "variables": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "The variables list of the credential.", - "items": { - "$ref": "#/components/schemas/CredentialVariable" - } + "items": { "$ref": "#/components/schemas/CredentialVariable" } } } }, @@ -11108,11 +7959,7 @@ ], "type": "object", "properties": { - "serviceId": { - "type": "string", - "description": "The ID of the service", - "format": "uuid" - }, + "serviceId": { "type": "string", "description": "The ID of the service", "format": "uuid" }, "category": { "type": "string", "description": "The catalog of the service", @@ -11129,18 +7976,12 @@ "others" ] }, - "name": { - "type": "string", - "description": "The name of the service" - }, + "name": { "type": "string", "description": "The name of the service" }, "customerServiceName": { "type": "string", "description": "Customer's name for the service. Used only for customer's reference.If not provided, this value will be auto-generated" }, - "version": { - "type": "string", - "description": "The version of the service" - }, + "version": { "type": "string", "description": "The version of the service" }, "csp": { "type": "string", "description": "The provider of the service", @@ -11156,27 +7997,19 @@ "GoogleCloudPlatform" ] }, - "flavor": { - "type": "string", - "description": "The flavor of the service" - }, + "flavor": { "type": "string", "description": "The flavor of the service" }, "billingMode": { "type": "string", "description": "The billing mode of the managed service.", "enum": ["Fixed", "Pay per Use"] }, - "region": { - "$ref": "#/components/schemas/Region" - }, + "region": { "$ref": "#/components/schemas/Region" }, "serviceTemplateId": { "type": "string", "description": "The id of the Service Template", "format": "uuid" }, - "userId": { - "type": "string", - "description": "The id of the user who deployed the service." - }, + "userId": { "type": "string", "description": "The id of the user who deployed the service." }, "serviceDeploymentState": { "type": "string", "description": "The deployment state of the service", @@ -11224,29 +8057,16 @@ "description": "Time of stop service.", "format": "date-time" }, - "lockConfig": { - "$ref": "#/components/schemas/ServiceLockConfig" - }, - "serviceConfigurationDetails": { - "$ref": "#/components/schemas/ServiceConfigurationDetails" - } + "lockConfig": { "$ref": "#/components/schemas/ServiceLockConfig" }, + "serviceConfigurationDetails": { "$ref": "#/components/schemas/ServiceConfigurationDetails" } } }, "ServiceConfigurationDetails": { "type": "object", "properties": { - "configuration": { - "type": "object", - "additionalProperties": true - }, - "createdTime": { - "type": "string", - "format": "date-time" - }, - "updatedTime": { - "type": "string", - "format": "date-time" - } + "configuration": { "type": "object", "additionalProperties": true }, + "createdTime": { "type": "string", "format": "date-time" }, + "updatedTime": { "type": "string", "format": "date-time" } }, "description": "Details of the service configuration." }, @@ -11261,16 +8081,10 @@ ], "type": "object", "properties": { - "name": { - "type": "string", - "description": "The flavor name" - }, + "name": { "type": "string", "description": "The flavor name" }, "properties": { "type": "object", - "additionalProperties": { - "type": "string", - "description": "The properties of the flavor" - }, + "additionalProperties": { "type": "string", "description": "The properties of the flavor" }, "description": "The properties of the flavor" }, "priority": { @@ -11290,69 +8104,39 @@ "serviceFlavors": { "type": "array", "description": "The flavors of the orderable service.", - "items": { - "$ref": "#/components/schemas/ServiceFlavor" - } - }, - "modificationImpact": { - "$ref": "#/components/schemas/ModificationImpact" + "items": { "$ref": "#/components/schemas/ServiceFlavor" } }, + "modificationImpact": { "$ref": "#/components/schemas/ModificationImpact" }, "isDowngradeAllowed": { "type": "boolean", "description": "Whether the downgrading is allowed, default value: true." }, - "downgradeAllowed": { - "type": "boolean" - } + "downgradeAllowed": { "type": "boolean" } }, "description": "The flavors of the orderable service." }, "Link": { "type": "object", "properties": { - "rel": { - "type": "string" - }, - "href": { - "type": "string" - }, - "hreflang": { - "type": "string" - }, - "media": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "deprecation": { - "type": "string" - }, - "profile": { - "type": "string" - }, - "name": { - "type": "string" - } + "rel": { "type": "string" }, + "href": { "type": "string" }, + "hreflang": { "type": "string" }, + "media": { "type": "string" }, + "title": { "type": "string" }, + "type": { "type": "string" }, + "deprecation": { "type": "string" }, + "profile": { "type": "string" }, + "name": { "type": "string" } } }, "ServiceFlavor": { "required": ["name", "priority", "properties"], "type": "object", "properties": { - "name": { - "type": "string", - "description": "The flavor name" - }, + "name": { "type": "string", "description": "The flavor name" }, "properties": { "type": "object", - "additionalProperties": { - "type": "string", - "description": "The properties of the flavor" - }, + "additionalProperties": { "type": "string", "description": "The properties of the flavor" }, "description": "The properties of the flavor" }, "priority": { @@ -11412,14 +8196,8 @@ "others" ] }, - "name": { - "type": "string", - "description": "The name of the orderable service." - }, - "version": { - "type": "string", - "description": "The version of the orderable service." - }, + "name": { "type": "string", "description": "The name of the orderable service." }, + "version": { "type": "string", "description": "The version of the orderable service." }, "csp": { "type": "string", "description": "The Cloud Service Provider of the orderable service.", @@ -11438,67 +8216,36 @@ "regions": { "type": "array", "description": "The regions of the Cloud Service Provider.", - "items": { - "$ref": "#/components/schemas/Region" - } - }, - "serviceVendor": { - "type": "string", - "description": "The serviceVendor of the orderable service." - }, - "description": { - "type": "string", - "description": "The description of the orderable service." - }, - "icon": { - "type": "string", - "description": "The icon of the orderable service." + "items": { "$ref": "#/components/schemas/Region" } }, + "serviceVendor": { "type": "string", "description": "The serviceVendor of the orderable service." }, + "description": { "type": "string", "description": "The description of the orderable service." }, + "icon": { "type": "string", "description": "The icon of the orderable service." }, "variables": { "type": "array", "description": "The variables for the deployment, which will be passed to the deployer.", - "items": { - "$ref": "#/components/schemas/DeployVariable" - } - }, - "flavors": { - "$ref": "#/components/schemas/EndUserFlavors" - }, - "billing": { - "$ref": "#/components/schemas/Billing" + "items": { "$ref": "#/components/schemas/DeployVariable" } }, + "flavors": { "$ref": "#/components/schemas/EndUserFlavors" }, + "billing": { "$ref": "#/components/schemas/Billing" }, "serviceHostingType": { "type": "string", "description": "Defines which cloud service account is used for deploying cloud resources.", "enum": ["self", "service-vendor"] }, - "serviceProviderContactDetails": { - "$ref": "#/components/schemas/ServiceProviderContactDetails" - }, + "serviceProviderContactDetails": { "$ref": "#/components/schemas/ServiceProviderContactDetails" }, "serviceAvailabilityConfig": { "type": "array", "description": "The list of availability zone configuration of the service.", - "items": { - "$ref": "#/components/schemas/AvailabilityZoneConfig" - } - }, - "eula": { - "type": "string", - "description": "End user license agreement content of the service." + "items": { "$ref": "#/components/schemas/AvailabilityZoneConfig" } }, + "eula": { "type": "string", "description": "End user license agreement content of the service." }, "configurationParameters": { "type": "array", "description": "The collection of service configuration parameters.", - "items": { - "$ref": "#/components/schemas/ServiceChangeParameter" - } + "items": { "$ref": "#/components/schemas/ServiceChangeParameter" } }, - "links": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Link" - } - } + "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } } }, "DeployResource": { @@ -11513,14 +8260,8 @@ "type": "string", "description": "The name of the group which configuration the deployed resource." }, - "resourceId": { - "type": "string", - "description": "The id of the deployed resource." - }, - "resourceName": { - "type": "string", - "description": "The name of the deployed resource." - }, + "resourceId": { "type": "string", "description": "The id of the deployed resource." }, + "resourceName": { "type": "string", "description": "The name of the deployed resource." }, "resourceKind": { "type": "string", "description": "The kind of the deployed resource.", @@ -11551,11 +8292,7 @@ "required": ["handler", "orderId", "serviceId", "taskStatus", "taskType"], "type": "object", "properties": { - "orderId": { - "type": "string", - "description": "The id of the service order.", - "format": "uuid" - }, + "orderId": { "type": "string", "description": "The id of the service order.", "format": "uuid" }, "serviceId": { "type": "string", "description": "The id of the deployed service.", @@ -11595,17 +8332,9 @@ "description": "The id of the parent service order.", "format": "uuid" }, - "workflowId": { - "type": "string", - "description": "The id of the workflow." - }, - "errorResponse": { - "$ref": "#/components/schemas/ErrorResponse" - }, - "userId": { - "type": "string", - "description": "The id of the user who created the service order." - }, + "workflowId": { "type": "string", "description": "The id of the workflow." }, + "errorResponse": { "$ref": "#/components/schemas/ErrorResponse" }, + "userId": { "type": "string", "description": "The id of the user who created the service order." }, "startedTime": { "type": "string", "description": "The started time of the service order.", @@ -11616,22 +8345,13 @@ "description": "The completed time of the service order.", "format": "date-time" }, - "requestBody": { - "type": "object", - "description": "The request json of the service order." - }, - "previousDeployRequest": { - "$ref": "#/components/schemas/DeployRequest" - }, - "newDeployRequest": { - "$ref": "#/components/schemas/DeployRequest" - }, + "requestBody": { "type": "object", "description": "The request json of the service order." }, + "previousDeployRequest": { "$ref": "#/components/schemas/DeployRequest" }, + "newDeployRequest": { "$ref": "#/components/schemas/DeployRequest" }, "previousDeployedResources": { "type": "array", "description": "The deployed resources of the service before this service order.", - "items": { - "$ref": "#/components/schemas/DeployResource" - } + "items": { "$ref": "#/components/schemas/DeployResource" } }, "previousDeployedServiceProperties": { "type": "object", @@ -11705,9 +8425,7 @@ "type": "boolean", "description": "Describes if the service order is now completed." }, - "error": { - "$ref": "#/components/schemas/ErrorResponse" - } + "error": { "$ref": "#/components/schemas/ErrorResponse" } } }, "DeployedServiceDetails": { @@ -11728,11 +8446,7 @@ ], "type": "object", "properties": { - "serviceId": { - "type": "string", - "description": "The ID of the service", - "format": "uuid" - }, + "serviceId": { "type": "string", "description": "The ID of the service", "format": "uuid" }, "category": { "type": "string", "description": "The catalog of the service", @@ -11749,18 +8463,12 @@ "others" ] }, - "name": { - "type": "string", - "description": "The name of the service" - }, + "name": { "type": "string", "description": "The name of the service" }, "customerServiceName": { "type": "string", "description": "Customer's name for the service. Used only for customer's reference.If not provided, this value will be auto-generated" }, - "version": { - "type": "string", - "description": "The version of the service" - }, + "version": { "type": "string", "description": "The version of the service" }, "csp": { "type": "string", "description": "The provider of the service", @@ -11776,27 +8484,19 @@ "GoogleCloudPlatform" ] }, - "flavor": { - "type": "string", - "description": "The flavor of the service" - }, + "flavor": { "type": "string", "description": "The flavor of the service" }, "billingMode": { "type": "string", "description": "The billing mode of the managed service.", "enum": ["Fixed", "Pay per Use"] }, - "region": { - "$ref": "#/components/schemas/Region" - }, + "region": { "$ref": "#/components/schemas/Region" }, "serviceTemplateId": { "type": "string", "description": "The id of the Service Template", "format": "uuid" }, - "userId": { - "type": "string", - "description": "The id of the user who deployed the service." - }, + "userId": { "type": "string", "description": "The id of the user who deployed the service." }, "serviceDeploymentState": { "type": "string", "description": "The deployment state of the service", @@ -11844,21 +8544,13 @@ "description": "Time of stop service.", "format": "date-time" }, - "lockConfig": { - "$ref": "#/components/schemas/ServiceLockConfig" - }, - "serviceConfigurationDetails": { - "$ref": "#/components/schemas/ServiceConfigurationDetails" - }, - "deployRequest": { - "$ref": "#/components/schemas/DeployRequest" - }, + "lockConfig": { "$ref": "#/components/schemas/ServiceLockConfig" }, + "serviceConfigurationDetails": { "$ref": "#/components/schemas/ServiceConfigurationDetails" }, + "deployRequest": { "$ref": "#/components/schemas/DeployRequest" }, "deployResources": { "type": "array", "description": "The resource list of the deployed service.", - "items": { - "$ref": "#/components/schemas/DeployResource" - } + "items": { "$ref": "#/components/schemas/DeployResource" } }, "deployedServiceProperties": { "type": "object", @@ -11868,10 +8560,7 @@ }, "description": "The properties of the deployed service." }, - "resultMessage": { - "type": "string", - "description": "The result message of the deployed service." - } + "resultMessage": { "type": "string", "description": "The result message of the deployed service." } } }, "VendorHostedDeployedServiceDetails": { @@ -11892,11 +8581,7 @@ ], "type": "object", "properties": { - "serviceId": { - "type": "string", - "description": "The ID of the service", - "format": "uuid" - }, + "serviceId": { "type": "string", "description": "The ID of the service", "format": "uuid" }, "category": { "type": "string", "description": "The catalog of the service", @@ -11913,18 +8598,12 @@ "others" ] }, - "name": { - "type": "string", - "description": "The name of the service" - }, + "name": { "type": "string", "description": "The name of the service" }, "customerServiceName": { "type": "string", "description": "Customer's name for the service. Used only for customer's reference.If not provided, this value will be auto-generated" }, - "version": { - "type": "string", - "description": "The version of the service" - }, + "version": { "type": "string", "description": "The version of the service" }, "csp": { "type": "string", "description": "The provider of the service", @@ -11940,27 +8619,19 @@ "GoogleCloudPlatform" ] }, - "flavor": { - "type": "string", - "description": "The flavor of the service" - }, + "flavor": { "type": "string", "description": "The flavor of the service" }, "billingMode": { "type": "string", "description": "The billing mode of the managed service.", "enum": ["Fixed", "Pay per Use"] }, - "region": { - "$ref": "#/components/schemas/Region" - }, + "region": { "$ref": "#/components/schemas/Region" }, "serviceTemplateId": { "type": "string", "description": "The id of the Service Template", "format": "uuid" }, - "userId": { - "type": "string", - "description": "The id of the user who deployed the service." - }, + "userId": { "type": "string", "description": "The id of the user who deployed the service." }, "serviceDeploymentState": { "type": "string", "description": "The deployment state of the service", @@ -12008,15 +8679,9 @@ "description": "Time of stop service.", "format": "date-time" }, - "lockConfig": { - "$ref": "#/components/schemas/ServiceLockConfig" - }, - "serviceConfigurationDetails": { - "$ref": "#/components/schemas/ServiceConfigurationDetails" - }, - "deployRequest": { - "$ref": "#/components/schemas/DeployRequest" - }, + "lockConfig": { "$ref": "#/components/schemas/ServiceLockConfig" }, + "serviceConfigurationDetails": { "$ref": "#/components/schemas/ServiceConfigurationDetails" }, + "deployRequest": { "$ref": "#/components/schemas/DeployRequest" }, "deployedServiceProperties": { "type": "object", "additionalProperties": { @@ -12027,7 +8692,7 @@ } } }, - "ServiceConfigurationChangeDetails": { + "ServiceChangeDetails": { "required": ["changeId", "configManager", "properties", "status"], "type": "object", "properties": { @@ -12059,17 +8724,13 @@ "enum": ["pending", "processing", "successful", "error"] } }, - "description": "Collection of service configuration change requests generated for the specific change order." + "description": "Collection of service change details requests generated for the specific change order." }, - "ServiceConfigurationChangeOrderDetails": { + "ServiceChangeOrderDetails": { "required": ["changeRequests", "configRequest", "orderId", "orderStatus"], "type": "object", "properties": { - "orderId": { - "type": "string", - "description": "The id of the order.", - "format": "uuid" - }, + "orderId": { "type": "string", "description": "The id of the order.", "format": "uuid" }, "orderStatus": { "type": "string", "description": "Order status of service configuration update result.", @@ -12082,10 +8743,8 @@ }, "changeRequests": { "type": "array", - "description": "Collection of service configuration change requests generated for the specific change order.", - "items": { - "$ref": "#/components/schemas/ServiceConfigurationChangeDetails" - } + "description": "Collection of service change details requests generated for the specific change order.", + "items": { "$ref": "#/components/schemas/ServiceChangeDetails" } } } }, @@ -12119,14 +8778,8 @@ "description": "ID of the registered service.", "format": "uuid" }, - "name": { - "type": "string", - "description": "Name of the registered service." - }, - "version": { - "type": "string", - "description": "Version of the registered service." - }, + "name": { "type": "string", "description": "Name of the registered service." }, + "version": { "type": "string", "description": "Version of the registered service." }, "csp": { "type": "string", "description": "Csp of the registered service.", @@ -12165,34 +8818,18 @@ "regions": { "type": "array", "description": "The regions of the Cloud Service Provider.", - "items": { - "$ref": "#/components/schemas/Region" - } - }, - "description": { - "type": "string", - "description": "The description of the registered service." - }, - "icon": { - "type": "string", - "description": "The icon of the registered service." - }, - "deployment": { - "$ref": "#/components/schemas/Deployment" + "items": { "$ref": "#/components/schemas/Region" } }, + "description": { "type": "string", "description": "The description of the registered service." }, + "icon": { "type": "string", "description": "The icon of the registered service." }, + "deployment": { "$ref": "#/components/schemas/Deployment" }, "variables": { "type": "array", "description": "The variables for the deployment, which will be passed to the deployer.", - "items": { - "$ref": "#/components/schemas/DeployVariable" - } - }, - "flavors": { - "$ref": "#/components/schemas/FlavorsWithPrice" - }, - "billing": { - "$ref": "#/components/schemas/Billing" + "items": { "$ref": "#/components/schemas/DeployVariable" } }, + "flavors": { "$ref": "#/components/schemas/FlavorsWithPrice" }, + "billing": { "$ref": "#/components/schemas/Billing" }, "serviceHostingType": { "type": "string", "description": "Defines which cloud service account is used for deploying cloud resources.", @@ -12211,32 +8848,17 @@ "serviceTemplateRegistrationState": { "type": "string", "description": "Registration state of service template.", - "enum": ["in-review", "approved", "rejected"] + "enum": ["in-review", "approved", "cancelled", "rejected"] }, "isReviewInProgress": { "type": "boolean", "description": "If any request for the service template has a review in-progress." }, - "isAvailableInCatalog": { - "type": "boolean", - "description": "Is available in catalog." - }, - "serviceProviderContactDetails": { - "$ref": "#/components/schemas/ServiceProviderContactDetails" - }, - "eula": { - "type": "string", - "description": "End user license agreement content of the service." - }, - "serviceConfigurationManage": { - "$ref": "#/components/schemas/ServiceChangeManage" - }, - "links": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Link" - } - } + "isAvailableInCatalog": { "type": "boolean", "description": "Is available in catalog." }, + "serviceProviderContactDetails": { "$ref": "#/components/schemas/ServiceProviderContactDetails" }, + "eula": { "type": "string", "description": "End user license agreement content of the service." }, + "serviceConfigurationManage": { "$ref": "#/components/schemas/ServiceChangeManage" }, + "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } } }, "ServiceTemplateRequestHistory": { @@ -12263,21 +8885,15 @@ "requestType": { "type": "string", "description": "Type of the request.", - "enum": ["register", "update", "remove from catalog", "re-add to catalog"] + "enum": ["register", "update", "unpublish", "republish"] }, "status": { "type": "string", "description": "Status of the request.", - "enum": ["in-review", "accepted", "rejected"] - }, - "reviewComment": { - "type": "string", - "description": "Comment of the review request." - }, - "blockTemplateUntilReviewed": { - "type": "boolean", - "description": "Status of the request." + "enum": ["in-review", "accepted", "rejected", "cancelled"] }, + "reviewComment": { "type": "string", "description": "Comment of the review request." }, + "blockTemplateUntilReviewed": { "type": "boolean", "description": "Status of the request." }, "createTime": { "type": "string", "description": "Create time of the service template request.", @@ -12288,51 +8904,31 @@ "description": "Last update time of the service template request.", "format": "date-time" }, - "requestSubmittedForReview": { - "type": "boolean" - } + "requestSubmittedForReview": { "type": "boolean" } } }, "FlavorPriceResult": { "required": ["billingMode", "flavorName"], "type": "object", "properties": { - "flavorName": { - "type": "string", - "description": "The name of the flavor." - }, + "flavorName": { "type": "string", "description": "The name of the flavor." }, "billingMode": { "type": "string", "description": "The billing mode of the price.", "enum": ["Fixed", "Pay per Use"] }, - "recurringPrice": { - "$ref": "#/components/schemas/Price" - }, - "oneTimePaymentPrice": { - "$ref": "#/components/schemas/Price" - }, - "errorMessage": { - "type": "string", - "description": "Error reason when price calculation fails." - }, - "successful": { - "type": "boolean" - } + "recurringPrice": { "$ref": "#/components/schemas/Price" }, + "oneTimePaymentPrice": { "$ref": "#/components/schemas/Price" }, + "errorMessage": { "type": "string", "description": "Error reason when price calculation fails." }, + "successful": { "type": "boolean" } } }, "Metric": { "required": ["monitorResourceType", "name", "type", "unit"], "type": "object", "properties": { - "name": { - "type": "string", - "description": "The name of the metric." - }, - "description": { - "type": "string", - "description": "The description of the metric." - }, + "name": { "type": "string", "description": "The name of the metric." }, + "description": { "type": "string", "description": "The description of the metric." }, "type": { "type": "string", "description": "The type of the metric.", @@ -12350,18 +8946,13 @@ }, "labels": { "type": "object", - "additionalProperties": { - "type": "string", - "description": "The labels of the metric." - }, + "additionalProperties": { "type": "string", "description": "The labels of the metric." }, "description": "The labels of the metric." }, "metrics": { "type": "array", "description": "The list of the metric items.", - "items": { - "$ref": "#/components/schemas/MetricItem" - } + "items": { "$ref": "#/components/schemas/MetricItem" } } } }, @@ -12371,10 +8962,7 @@ "properties": { "labels": { "type": "object", - "additionalProperties": { - "type": "string", - "description": "The labels for the MetricItem." - }, + "additionalProperties": { "type": "string", "description": "The labels for the MetricItem." }, "description": "The labels for the MetricItem." }, "type": { @@ -12387,10 +8975,7 @@ "description": "Timestamp of the recorded metric.", "format": "int64" }, - "value": { - "type": "number", - "description": "value of the MetricItem." - } + "value": { "type": "number", "description": "value of the MetricItem." } }, "description": "The list of the metric items." }, @@ -12411,10 +8996,7 @@ "OpenTelemetry Collector" ] }, - "name": { - "type": "string", - "description": "The name of backend system." - }, + "name": { "type": "string", "description": "The name of backend system." }, "healthStatus": { "type": "string", "description": "The health status of backend system.", @@ -12443,9 +9025,7 @@ "backendSystemStatuses": { "type": "array", "description": "The health status of backend systems. This list contains status of identity provider and status of database.The status of identity provider will return when authorization is enabled.", - "items": { - "$ref": "#/components/schemas/BackendSystemStatus" - } + "items": { "$ref": "#/components/schemas/BackendSystemStatus" } } } }, @@ -12466,11 +9046,9 @@ "requestType": { "type": "string", "description": "Type of the request.", - "enum": ["register", "update", "remove from catalog", "re-add to catalog"] - }, - "ocl": { - "$ref": "#/components/schemas/Ocl" + "enum": ["register", "update", "unpublish", "republish"] }, + "ocl": { "$ref": "#/components/schemas/Ocl" }, "createTime": { "type": "string", "description": "Create time of the service template request.", @@ -12481,55 +9059,30 @@ "description": "Last update time of the service template request.", "format": "date-time" }, - "requestSubmittedForReview": { - "type": "boolean" - } + "requestSubmittedForReview": { "type": "boolean" } } }, "ServiceConfigurationChangeRequest": { "type": "object", "properties": { - "changeId": { - "type": "string", - "format": "uuid" - }, - "configParameters": { - "type": "object", - "additionalProperties": true - }, - "ansibleScriptConfig": { - "$ref": "#/components/schemas/AnsibleScriptConfig" - }, - "ansibleInventory": { - "type": "object", - "additionalProperties": true - } + "changeId": { "type": "string", "format": "uuid" }, + "configParameters": { "type": "object", "additionalProperties": true }, + "ansibleScriptConfig": { "$ref": "#/components/schemas/AnsibleScriptConfig" }, + "ansibleInventory": { "type": "object", "additionalProperties": true } } }, "TokenResponse": { "required": ["access_token", "expires_in", "id_token", "token_type"], "type": "object", "properties": { - "access_token": { - "type": "string", - "description": "An access_token as a JWT or opaque token." - }, - "token_type": { - "type": "string", - "description": "Type of the access_token." - }, + "access_token": { "type": "string", "description": "An access_token as a JWT or opaque token." }, + "token_type": { "type": "string", "description": "Type of the access_token." }, "expires_in": { "type": "string", "description": "Number of second until the expiration of the access_token" }, - "id_token": { - "type": "string", - "description": "An id_token of the authorized service user" - }, - "scopes": { - "type": "string", - "description": "Scopes of the access_token." - } + "id_token": { "type": "string", "description": "An id_token of the authorized service user" }, + "scopes": { "type": "string", "description": "Scopes of the access_token." } } } }, diff --git a/src/xpanse-api/generated/sdk.gen.ts b/src/xpanse-api/generated/sdk.gen.ts index e22c5acb3..547141a56 100644 --- a/src/xpanse-api/generated/sdk.gen.ts +++ b/src/xpanse-api/generated/sdk.gen.ts @@ -1299,7 +1299,7 @@ export const fetch = (data: FetchData): CancelablePromise => { }; /** - * List the userPolicies belongs to the service.
Required role: admin or isv
+ * List the policies belongs to the service.
Required role: admin or isv
* @param data The data for the request. * @param data.serviceTemplateId The id of service template which the policy belongs to. * @returns ServicePolicy OK @@ -1350,7 +1350,7 @@ export const addServicePolicy = (data: AddServicePolicyData): CancelablePromise< }; /** - * List the userPolicies defined by the user.
Required role: admin or user
+ * List the policies defined by the user.
Required role: admin or user
* @param data The data for the request. * @param data.cspName Name of csp which the policy belongs to. * @param data.enabled Is the policy enabled. @@ -2022,7 +2022,7 @@ export const getPricesByService = (data: GetPricesByServiceData): CancelableProm * @param data.serviceId Id of the deployed service * @param data.resourceId Id of resource in the deployed service * @param data.monitorResourceType Types of the monitor resource. - * @param data.from Start UNIX timestamp in milliseconds. If no value filled,the default value is the UNIX timestamp in milliseconds of the five minutes ago. + * @param data._from Start UNIX timestamp in milliseconds. If no value filled,the default value is the UNIX timestamp in milliseconds of the five minutes ago. * @param data.to End UNIX timestamp in milliseconds. If no value filled,the default value is the UNIX timestamp in milliseconds of the current time. * @param data.granularity Return metrics collected in provided time interval. This depends on how the source systems have generated/collected metrics. * @param data.onlyLastKnownMetric Returns only the last known metric. When this parameter is set then all other query parameters are ignored. @@ -2037,7 +2037,7 @@ export const getMetrics = (data: GetMetricsData): CancelablePromise Required role: admin or user
+ * List of all approved services which are available for user to order.
Required role: admin or user
* @param data The data for the request. * @param data.categoryName category of the service * @param data.cspName name of the cloud service provider @@ -2419,7 +2419,7 @@ export const getOrderableServices = ( }; /** - * Get deployable service template by id.
Required role: admin or user
+ * Get deployable service by id.
Required role: admin or user
* @param data The data for the request. * @param data.serviceTemplateId The id of orderable service. * @returns UserOrderableServiceVo OK diff --git a/src/xpanse-api/generated/types.gen.ts b/src/xpanse-api/generated/types.gen.ts index a840e4411..992e6d436 100644 --- a/src/xpanse-api/generated/types.gen.ts +++ b/src/xpanse-api/generated/types.gen.ts @@ -142,7 +142,7 @@ export type AnsibleTaskResult = { }; /** - * Service config parameter autofill + * Variable autofill. Defines if the variable must be one of the existing resources of a specific type. */ export type AutoFill = { /** @@ -735,7 +735,7 @@ export enum kind { export type Deployment = { deployerTool: DeployerTool; /** - * The variables for the deployment, which will be passed to the deployer.The list elements must be unique. + * The variables for the deployment, which will be passed to the deployer.The list elements must be unique. All variables are put together to build a JSON 'object' with each variable as a property of this object. */ variables: Array; /** @@ -911,7 +911,7 @@ export enum resourceKind { } /** - * The variables for the deployment, which will be passed to the deployer.The list elements must be unique. + * The variables for the deployment, which will be passed to the deployer.The list elements must be unique. All variables are put together to build a JSON 'object' with each variable as a property of this object. */ export type DeployVariable = { /** @@ -940,7 +940,7 @@ export type DeployVariable = { */ mandatory: boolean; /** - * valueSchema of the variable. The key be any keyword that is part of the JSON schema definition which can be found here https://json-schema.org/draft/2020-12/schema + * valueSchema of the variable. The key be any keyword that is part of the JSON schema definition which can be found here https://json-schema.org/draft/2020-12/meta/validation. Only the type field is taken from dataType parameter directly. */ valueSchema?: { [key: string]: unknown; @@ -1777,7 +1777,7 @@ export type ServiceAction = { */ actionManageScripts?: Array; /** - * The collection of service action parameters. + * The configuration parameters of service .The list elements must be unique. All parameters are put together to build a JSON 'object' with each parameter as a property of this object. */ actionParameters?: Array; }; @@ -1885,7 +1885,7 @@ export enum orderStatus { } /** - * The collection of service action parameters. + * The configuration parameters of service .The list elements must be unique. All parameters are put together to build a JSON 'object' with each parameter as a property of this object. */ export type ServiceChangeParameter = { /** @@ -1914,7 +1914,7 @@ export type ServiceChangeParameter = { */ initialValue: string; /** - * valueSchema of the service config parameter. The key be any keyword that is part of the JSON schema definition which can be found here https://json-schema.org/draft/2020-12/schema + * valueSchema of the variable. The key be any keyword that is part of the JSON schema definition which can be found here https://json-schema.org/draft/2020-12/meta/validation. Only the type field is taken from dataType parameter directly. */ valueSchema?: { [key: string]: unknown; @@ -1923,7 +1923,6 @@ export type ServiceChangeParameter = { * Sensitive scope of service config parameter storage */ sensitiveScope?: 'none' | 'once' | 'always'; - autoFill?: AutoFill; modificationImpact: ModificationImpact; /** * Whether the service configuration parameters are read-only @@ -2255,9 +2254,9 @@ export type ServicePolicyCreateRequest = { export type ServicePolicyUpdateRequest = { /** - * The flavor name list which the policy belongs to. If the list is empty, then the policy will be executed for during service deployment of all flavors. + * The flavor names to which the policy belongs. If the list is empty, then the policy will be executed for during service deployment of all flavors. */ - flavorNameList?: Array; + flavorNames?: Array; /** * The policy. */ @@ -2832,7 +2831,7 @@ export type WorkFlowTask = { /** * The businessKey of the Process */ - businessKey: string; + businessKey?: string; /** * The status of the Task */ @@ -3758,7 +3757,7 @@ export type GetMetricsData = { /** * Start UNIX timestamp in milliseconds. If no value filled,the default value is the UNIX timestamp in milliseconds of the five minutes ago. */ - from?: number; + _from?: number; /** * Return metrics collected in provided time interval. This depends on how the source systems have generated/collected metrics. */