From 9899749c0052040091414c715667e17984e3bbad Mon Sep 17 00:00:00 2001 From: WangLiNaruto <122504203+WangLiNaruto@users.noreply.github.com> Date: Fri, 18 Oct 2024 14:55:36 +0800 Subject: [PATCH] update api (#1227) --- src/xpanse-api/api.json | 1852 +++++++++++----------- src/xpanse-api/generated/core/OpenAPI.ts | 2 +- src/xpanse-api/generated/services.gen.ts | 2 +- src/xpanse-api/generated/types.gen.ts | 7 +- 4 files changed, 939 insertions(+), 924 deletions(-) diff --git a/src/xpanse-api/api.json b/src/xpanse-api/api.json index 016048879..5f6594e42 100644 --- a/src/xpanse-api/api.json +++ b/src/xpanse-api/api.json @@ -3,7 +3,7 @@ "info": { "title": "XpanseAPI", "description": "RESTful Services to interact with Xpanse runtime.", - "version": "1.0.20-SNAPSHOT" + "version": "1.0.22-SNAPSHOT" }, "servers": [ { @@ -102,7 +102,7 @@ "/xpanse/workflow/task/{id}": { "put": { "tags": ["Workflow"], - "description": "Manage failed task orders.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Manage failed task orders.
Required role: admin or user
", "operationId": "manageFailedOrder", "parameters": [ { @@ -135,8 +135,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -145,8 +145,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -155,8 +155,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -165,8 +165,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -175,8 +175,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -204,7 +204,7 @@ "/xpanse/workflow/complete/task/{id}": { "put": { "tags": ["Workflow"], - "description": "Complete tasks by task ID and set global process variables .\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Complete tasks by task ID and set global process variables .
Required role: admin or user
", "operationId": "completeTask", "parameters": [ { @@ -241,8 +241,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -251,8 +251,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -261,8 +261,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -271,8 +271,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -281,8 +281,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -310,7 +310,7 @@ "/xpanse/user/credentials": { "get": { "tags": ["UserCloudCredentialsManagement"], - "description": "List all cloud provider credentials added by the user for a cloud service provider.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "List all cloud provider credentials added by the user for a cloud service provider.
Required role: admin or user
", "operationId": "getUserCloudCredentials", "parameters": [ { @@ -355,8 +355,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -365,8 +365,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -375,8 +375,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -385,8 +385,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -395,8 +395,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -432,7 +432,7 @@ }, "put": { "tags": ["UserCloudCredentialsManagement"], - "description": "Update user's credential for connecting to the cloud service provider.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Update user's credential for connecting to the cloud service provider.
Required role: admin or user
", "operationId": "updateUserCloudCredential", "requestBody": { "content": { @@ -455,8 +455,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -465,8 +465,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -475,8 +475,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -485,8 +485,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -495,8 +495,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -522,7 +522,7 @@ }, "post": { "tags": ["UserCloudCredentialsManagement"], - "description": "Add user's credential for connecting to the cloud service provider.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Add user's credential for connecting to the cloud service provider.
Required role: admin or user
", "operationId": "addUserCloudCredential", "requestBody": { "content": { @@ -545,8 +545,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -555,8 +555,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -565,8 +565,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -575,8 +575,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -585,8 +585,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -612,7 +612,7 @@ }, "delete": { "tags": ["UserCloudCredentialsManagement"], - "description": "Delete user's credential for connecting to the cloud service provider.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Delete user's credential for connecting to the cloud service provider.
Required role: admin or user
", "operationId": "deleteUserCloudCredential", "parameters": [ { @@ -675,8 +675,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -685,8 +685,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -695,8 +695,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -705,8 +705,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -715,8 +715,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -744,7 +744,7 @@ "/xpanse/services/stop/{serviceId}": { "put": { "tags": ["ServiceStatusManagement"], - "description": "Start a task to stop the service instance.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Start a task to stop the service instance.
Required role: admin or user
", "operationId": "stopService", "parameters": [ { @@ -767,8 +767,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -777,8 +777,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -787,8 +787,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -797,8 +797,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -807,8 +807,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -844,7 +844,7 @@ "/xpanse/services/start/{serviceId}": { "put": { "tags": ["ServiceStatusManagement"], - "description": "Start a task to start the service instance.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Start a task to start the service instance.
Required role: admin or user
", "operationId": "startService", "parameters": [ { @@ -867,8 +867,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -877,8 +877,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -887,8 +887,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -897,8 +897,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -907,8 +907,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -944,7 +944,7 @@ "/xpanse/services/restart/{serviceId}": { "put": { "tags": ["ServiceStatusManagement"], - "description": "Start a task to restart the service instance.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Start a task to restart the service instance.
Required role: admin or user
", "operationId": "restartService", "parameters": [ { @@ -967,8 +967,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -977,8 +977,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -987,8 +987,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -997,8 +997,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -1007,8 +1007,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -1044,7 +1044,7 @@ "/xpanse/services/recreate/{serviceId}": { "put": { "tags": ["Service"], - "description": "Create a job to recreate the deployed service.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Create a job to recreate the deployed service.
Required role: admin or user
", "operationId": "recreateService", "parameters": [ { @@ -1067,8 +1067,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -1077,8 +1077,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -1087,8 +1087,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -1097,8 +1097,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -1107,8 +1107,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -1144,7 +1144,7 @@ "/xpanse/services/modify/{serviceId}": { "put": { "tags": ["Service"], - "description": "Create an order task to modify the deployed service.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Create an order task to modify the deployed service.
Required role: admin or user
", "operationId": "modify", "parameters": [ { @@ -1178,7 +1178,7 @@ } } }, - "422": { + "401": { "description": "", "content": { "application/json": { @@ -1188,7 +1188,7 @@ } } }, - "400": { + "502": { "description": "", "content": { "application/json": { @@ -1198,7 +1198,7 @@ } } }, - "403": { + "422": { "description": "", "content": { "application/json": { @@ -1208,7 +1208,7 @@ } } }, - "401": { + "400": { "description": "", "content": { "application/json": { @@ -1218,7 +1218,7 @@ } } }, - "502": { + "403": { "description": "", "content": { "application/json": { @@ -1254,7 +1254,7 @@ "/xpanse/services/deploy/retry/{serviceId}": { "put": { "tags": ["Service"], - "description": "Create an order to redeploy the failed service using service id.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Create an order to redeploy the failed service using service id.
Required role: admin or user
", "operationId": "redeployFailedDeployment", "parameters": [ { @@ -1277,7 +1277,7 @@ } } }, - "422": { + "401": { "description": "", "content": { "application/json": { @@ -1287,7 +1287,7 @@ } } }, - "400": { + "502": { "description": "", "content": { "application/json": { @@ -1297,7 +1297,7 @@ } } }, - "403": { + "422": { "description": "", "content": { "application/json": { @@ -1307,7 +1307,7 @@ } } }, - "401": { + "400": { "description": "", "content": { "application/json": { @@ -1317,7 +1317,7 @@ } } }, - "502": { + "403": { "description": "", "content": { "application/json": { @@ -1353,7 +1353,7 @@ "/xpanse/services/config/{serviceId}": { "put": { "tags": ["ServiceConfiguration"], - "description": "Update the service's configuration to the registered service template.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Update the service's configuration to the registered service template.
Required role: admin or user
", "operationId": "changeServiceConfiguration", "parameters": [ { @@ -1387,8 +1387,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -1397,8 +1397,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -1407,8 +1407,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -1417,8 +1417,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -1427,8 +1427,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -1463,7 +1463,7 @@ "/xpanse/services/changelock/{serviceId}": { "put": { "tags": ["Service"], - "description": "Change the lock config of the service.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Change the lock config of the service.
Required role: admin or user
", "operationId": "changeServiceLockConfig", "parameters": [ { @@ -1497,8 +1497,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -1507,8 +1507,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -1517,8 +1517,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -1527,8 +1527,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -1537,8 +1537,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -1566,7 +1566,7 @@ "/xpanse/service_templates/{id}": { "get": { "tags": ["ServiceVendor"], - "description": "Get service template using id.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "Get service template using id.
Required role: admin or isv
", "operationId": "details", "parameters": [ { @@ -1590,8 +1590,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -1600,8 +1600,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -1610,8 +1610,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -1620,8 +1620,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -1630,8 +1630,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -1664,7 +1664,7 @@ }, "put": { "tags": ["ServiceVendor"], - "description": "Update service template using id and ocl model.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "Update service template using id and ocl model.
Required role: admin or isv
", "operationId": "update", "parameters": [ { @@ -1698,8 +1698,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -1708,8 +1708,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -1718,8 +1718,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -1728,8 +1728,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -1738,8 +1738,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -1772,7 +1772,7 @@ }, "delete": { "tags": ["ServiceVendor"], - "description": "Delete unregistered service template using id.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "Delete unregistered service template using id.
Required role: admin or isv
", "operationId": "deleteServiceTemplate", "parameters": [ { @@ -1796,8 +1796,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -1806,8 +1806,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -1816,8 +1816,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -1826,8 +1826,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -1836,8 +1836,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -1865,7 +1865,7 @@ "/xpanse/service_templates/unregister/{id}": { "put": { "tags": ["ServiceVendor"], - "description": "Unregister service template using id.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "Unregister service template using id.
Required role: admin or isv
", "operationId": "unregister", "parameters": [ { @@ -1889,8 +1889,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -1899,8 +1899,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -1909,8 +1909,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -1919,8 +1919,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -1929,8 +1929,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -1965,7 +1965,7 @@ "/xpanse/service_templates/review/{id}": { "put": { "tags": ["CloudServiceProvider"], - "description": "Review service template registration.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Ecsp\u003C/b\u003E \u003C/br\u003E", + "description": "Review service template registration.
Required role: admin or csp
", "operationId": "reviewRegistration", "parameters": [ { @@ -1999,8 +1999,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -2009,8 +2009,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -2019,8 +2019,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -2029,8 +2029,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -2039,8 +2039,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -2068,7 +2068,7 @@ "/xpanse/service_templates/re-register/{id}": { "put": { "tags": ["ServiceVendor"], - "description": "Re-register the unregistered service template using id.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "Re-register the unregistered service template using id.
Required role: admin or isv
", "operationId": "reRegisterServiceTemplate", "parameters": [ { @@ -2092,8 +2092,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -2102,8 +2102,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -2112,8 +2112,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -2122,8 +2122,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -2132,8 +2132,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -2168,7 +2168,7 @@ "/xpanse/service_templates/file/{id}": { "put": { "tags": ["ServiceVendor"], - "description": "Update service template using id and URL of Ocl file.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "Update service template using id and URL of Ocl file.
Required role: admin or isv
", "operationId": "fetchUpdate", "parameters": [ { @@ -2201,8 +2201,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -2211,8 +2211,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -2221,8 +2221,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -2231,8 +2231,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -2241,8 +2241,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -2277,7 +2277,7 @@ "/xpanse/service/policies/{id}": { "get": { "tags": ["ServicePoliciesManagement"], - "description": "Get details of policy belongs to the registered service template.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "Get details of policy belongs to the registered service template.
Required role: admin or isv
", "operationId": "getServicePolicyDetails", "parameters": [ { @@ -2300,8 +2300,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -2310,8 +2310,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -2320,8 +2320,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -2330,8 +2330,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -2340,8 +2340,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -2374,7 +2374,7 @@ }, "put": { "tags": ["ServicePoliciesManagement"], - "description": "Update the policy belongs to the registered service template.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "Update the policy belongs to the registered service template.
Required role: admin or isv
", "operationId": "updateServicePolicy", "parameters": [ { @@ -2408,8 +2408,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -2418,8 +2418,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -2428,8 +2428,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -2438,8 +2438,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -2448,8 +2448,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -2482,7 +2482,7 @@ }, "delete": { "tags": ["ServicePoliciesManagement"], - "description": "Delete the policy belongs to the registered service template.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "Delete the policy belongs to the registered service template.
Required role: admin or isv
", "operationId": "deleteServicePolicy", "parameters": [ { @@ -2505,8 +2505,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -2515,8 +2515,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -2525,8 +2525,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -2535,8 +2535,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -2545,8 +2545,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -2574,7 +2574,7 @@ "/xpanse/policies/{id}": { "get": { "tags": ["UserPoliciesManagement"], - "description": "Get the details of the policy created by the user.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Get the details of the policy created by the user.
Required role: admin or user
", "operationId": "getPolicyDetails", "parameters": [ { @@ -2597,8 +2597,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -2607,8 +2607,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -2617,8 +2617,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -2627,8 +2627,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -2637,8 +2637,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -2671,7 +2671,7 @@ }, "put": { "tags": ["UserPoliciesManagement"], - "description": "Update the policy created by the user.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Update the policy created by the user.
Required role: admin or user
", "operationId": "updateUserPolicy", "parameters": [ { @@ -2705,8 +2705,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -2715,8 +2715,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -2725,8 +2725,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -2735,8 +2735,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -2745,8 +2745,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -2779,7 +2779,7 @@ }, "delete": { "tags": ["UserPoliciesManagement"], - "description": "Delete the policy created by the user.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Delete the policy created by the user.
Required role: admin or user
", "operationId": "deleteUserPolicy", "parameters": [ { @@ -2802,8 +2802,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -2812,8 +2812,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -2822,8 +2822,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -2832,8 +2832,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -2842,8 +2842,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -2871,7 +2871,7 @@ "/xpanse/isv/credentials": { "get": { "tags": ["ISVCloudCredentialsManagement"], - "description": "Users in the ISV role get all cloud provider credentials added by the user for a cloud service provider.\u003Cbr\u003E Required role: \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "Users in the ISV role get all cloud provider credentials added by the user for a cloud service provider.
Required role: isv
", "operationId": "getIsvCloudCredentials", "parameters": [ { @@ -2916,8 +2916,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -2926,8 +2926,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -2936,8 +2936,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -2946,8 +2946,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -2956,8 +2956,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -2993,7 +2993,7 @@ }, "put": { "tags": ["ISVCloudCredentialsManagement"], - "description": "Update the user credentials used for ISV to connect to the cloud service provider.\u003Cbr\u003E Required role: \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "Update the user credentials used for ISV to connect to the cloud service provider.
Required role: isv
", "operationId": "updateIsvCloudCredential", "requestBody": { "content": { @@ -3016,8 +3016,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -3026,8 +3026,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -3036,8 +3036,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -3046,8 +3046,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -3056,8 +3056,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -3083,7 +3083,7 @@ }, "post": { "tags": ["ISVCloudCredentialsManagement"], - "description": "Add the user credentials for the ISV role used to connect to the cloud service provider.\u003Cbr\u003E Required role: \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "Add the user credentials for the ISV role used to connect to the cloud service provider.
Required role: isv
", "operationId": "addIsvCloudCredential", "requestBody": { "content": { @@ -3106,8 +3106,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -3116,8 +3116,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -3126,8 +3126,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -3136,8 +3136,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -3146,8 +3146,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -3173,7 +3173,7 @@ }, "delete": { "tags": ["ISVCloudCredentialsManagement"], - "description": "Delete the credentials of the user in the USER role to connect to the cloud service provider.\u003Cbr\u003E Required role: \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "Delete the credentials of the user in the USER role to connect to the cloud service provider.
Required role: isv
", "operationId": "deleteIsvCloudCredential", "parameters": [ { @@ -3236,8 +3236,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -3246,8 +3246,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -3256,8 +3256,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -3266,8 +3266,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -3276,8 +3276,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -3339,8 +3339,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -3349,8 +3349,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -3359,8 +3359,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -3369,8 +3369,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -3379,8 +3379,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -3399,8 +3399,8 @@ } } }, - "200": { - "description": "OK" + "204": { + "description": "No Content" } } } @@ -3408,7 +3408,7 @@ "/xpanse/services": { "get": { "tags": ["Service"], - "description": "List all deployed services belongs to the user.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "List all deployed services belongs to the user.
Required role: admin or user
", "operationId": "listDeployedServices", "parameters": [ { @@ -3504,8 +3504,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -3514,8 +3514,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -3524,8 +3524,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -3534,8 +3534,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -3544,8 +3544,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -3581,7 +3581,7 @@ }, "post": { "tags": ["Service"], - "description": "Create an order task to deploy new service using approved service template.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Create an order task to deploy new service using approved service template.
Required role: admin or user
", "operationId": "deploy", "requestBody": { "content": { @@ -3604,7 +3604,7 @@ } } }, - "422": { + "401": { "description": "", "content": { "application/json": { @@ -3614,7 +3614,7 @@ } } }, - "400": { + "502": { "description": "", "content": { "application/json": { @@ -3624,7 +3624,7 @@ } } }, - "403": { + "422": { "description": "", "content": { "application/json": { @@ -3634,7 +3634,7 @@ } } }, - "401": { + "400": { "description": "", "content": { "application/json": { @@ -3644,7 +3644,7 @@ } } }, - "502": { + "403": { "description": "", "content": { "application/json": { @@ -3680,7 +3680,7 @@ "/xpanse/services/migration": { "post": { "tags": ["Migration"], - "description": "Create a job to migrate the deployed service.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Create a job to migrate the deployed service.
Required role: admin or user
", "operationId": "migrate", "requestBody": { "content": { @@ -3703,8 +3703,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -3713,8 +3713,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -3723,8 +3723,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -3733,8 +3733,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -3743,8 +3743,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -3780,7 +3780,7 @@ "/xpanse/service_templates": { "get": { "tags": ["ServiceVendor"], - "description": "List service templates with query params.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "List service templates with query params.
Required role: admin or isv
", "operationId": "listServiceTemplates", "parameters": [ { @@ -3875,8 +3875,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -3885,8 +3885,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -3895,8 +3895,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -3905,8 +3905,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -3915,8 +3915,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -3952,7 +3952,7 @@ }, "post": { "tags": ["ServiceVendor"], - "description": "Register new service template using ocl model.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "Register new service template using ocl model.
Required role: admin or isv
", "operationId": "register", "requestBody": { "content": { @@ -3975,8 +3975,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -3985,8 +3985,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -3995,8 +3995,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -4005,8 +4005,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -4015,8 +4015,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -4051,7 +4051,7 @@ "/xpanse/service_templates/file": { "post": { "tags": ["ServiceVendor"], - "description": "Register new service template using URL of Ocl file.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "Register new service template using URL of Ocl file.
Required role: admin or isv
", "operationId": "fetch", "parameters": [ { @@ -4075,8 +4075,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -4085,8 +4085,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -4095,8 +4095,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -4105,8 +4105,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -4115,8 +4115,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -4151,7 +4151,7 @@ "/xpanse/service/policies": { "get": { "tags": ["ServicePoliciesManagement"], - "description": "List the policies belongs to the service.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "List the policies belongs to the service.
Required role: admin or isv
", "operationId": "listServicePolicies", "parameters": [ { @@ -4175,8 +4175,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -4185,8 +4185,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -4195,8 +4195,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -4205,8 +4205,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -4215,8 +4215,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -4252,7 +4252,7 @@ }, "post": { "tags": ["ServicePoliciesManagement"], - "description": "Add policy for the registered service template.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "Add policy for the registered service template.
Required role: admin or isv
", "operationId": "addServicePolicy", "requestBody": { "content": { @@ -4275,8 +4275,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -4285,8 +4285,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -4295,8 +4295,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -4305,8 +4305,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -4315,8 +4315,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -4351,7 +4351,7 @@ "/xpanse/policies": { "get": { "tags": ["UserPoliciesManagement"], - "description": "List the policies defined by the user.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "List the policies defined by the user.
Required role: admin or user
", "operationId": "listUserPolicies", "parameters": [ { @@ -4395,8 +4395,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -4405,8 +4405,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -4415,8 +4415,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -4425,8 +4425,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -4435,8 +4435,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -4472,7 +4472,7 @@ }, "post": { "tags": ["UserPoliciesManagement"], - "description": "Add policy created by the user.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Add policy created by the user.
Required role: admin or user
", "operationId": "addUserPolicy", "requestBody": { "content": { @@ -4495,8 +4495,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -4505,8 +4505,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -4515,8 +4515,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -4525,8 +4525,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -4535,8 +4535,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -4571,7 +4571,7 @@ "/xpanse/workflow/tasks": { "get": { "tags": ["Workflow"], - "description": "Query all tasks of the given user\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Query all tasks of the given user
Required role: admin or user
", "operationId": "queryTasks", "parameters": [ { @@ -4596,8 +4596,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -4606,8 +4606,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -4616,8 +4616,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -4626,8 +4626,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -4636,8 +4636,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -4675,7 +4675,7 @@ "/xpanse/services/{serviceId}/tasks": { "get": { "tags": ["ServiceStatusManagement"], - "description": "List state management tasks of the service.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "List state management tasks of the service.
Required role: admin or user
", "operationId": "listServiceStateManagementTasks", "parameters": [ { @@ -4719,8 +4719,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -4729,8 +4729,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -4739,8 +4739,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -4749,8 +4749,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -4759,8 +4759,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -4796,7 +4796,7 @@ }, "delete": { "tags": ["ServiceStatusManagement"], - "description": "Delete all state management tasks of the service.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Delete all state management tasks of the service.
Required role: admin or user
", "operationId": "deleteManagementTasksByServiceId", "parameters": [ { @@ -4820,8 +4820,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -4830,8 +4830,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -4840,8 +4840,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -4850,8 +4850,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -4860,8 +4860,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -4889,7 +4889,7 @@ "/xpanse/services/{serviceId}/resources/compute": { "get": { "tags": ["Service"], - "description": "List compute resources of the service.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "List compute resources of the service.
Required role: admin or user
", "operationId": "getComputeResourceInventoryOfService", "parameters": [ { @@ -4913,8 +4913,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -4923,8 +4923,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -4933,8 +4933,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -4943,8 +4943,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -4953,8 +4953,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -4992,7 +4992,7 @@ "/xpanse/services/{serviceId}/orders": { "get": { "tags": ["ServiceOrders"], - "description": "List service orders of the service\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "List service orders of the service
Required role: admin or isv or user
", "operationId": "getAllOrdersByServiceId", "parameters": [ { @@ -5036,8 +5036,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -5046,8 +5046,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -5056,8 +5056,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -5066,8 +5066,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -5076,8 +5076,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -5113,7 +5113,7 @@ }, "delete": { "tags": ["ServiceOrders"], - "description": "Delete all service orders of the service.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Delete all service orders of the service.
Required role: admin or isv or user
", "operationId": "deleteOrdersByServiceId", "parameters": [ { @@ -5137,8 +5137,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -5147,8 +5147,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -5157,8 +5157,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -5167,8 +5167,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -5177,8 +5177,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -5206,7 +5206,7 @@ "/xpanse/services/{serviceId}/deployment/status": { "get": { "tags": ["Service"], - "description": "Long-polling method to get the latest service deployment or service update status.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Long-polling method to get the latest service deployment or service update status.
Required role: admin or isv or user
", "operationId": "getLatestServiceDeploymentStatus", "parameters": [ { @@ -5252,8 +5252,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -5262,8 +5262,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -5272,8 +5272,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -5282,8 +5282,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -5292,8 +5292,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -5328,7 +5328,7 @@ "/xpanse/services/tasks/{taskId}": { "get": { "tags": ["ServiceStatusManagement"], - "description": "Get state management task details by the task id.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Get state management task details by the task id.
Required role: admin or user
", "operationId": "getManagementTaskDetailsByTaskId", "parameters": [ { @@ -5352,8 +5352,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -5362,8 +5362,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -5372,8 +5372,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -5382,8 +5382,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -5392,8 +5392,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -5426,7 +5426,7 @@ }, "delete": { "tags": ["ServiceStatusManagement"], - "description": "Delete service state management task by the task id.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Delete service state management task by the task id.
Required role: admin or user
", "operationId": "deleteManagementTaskByTaskId", "parameters": [ { @@ -5450,8 +5450,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -5460,8 +5460,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -5470,8 +5470,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -5480,8 +5480,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -5490,8 +5490,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -5519,7 +5519,7 @@ "/xpanse/services/recreate": { "get": { "tags": ["Service"], - "description": "List all services recreate by a user.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "List all services recreate by a user.
Required role: admin or user
", "operationId": "listServiceRecreates", "parameters": [ { @@ -5572,8 +5572,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -5582,8 +5582,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -5592,8 +5592,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -5602,8 +5602,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -5612,8 +5612,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -5651,7 +5651,7 @@ "/xpanse/services/recreate/{recreateId}": { "get": { "tags": ["Service"], - "description": "Get recreate records based on recreate id.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Get recreate records based on recreate id.
Required role: admin or user
", "operationId": "getRecreateOrderDetailsById", "parameters": [ { @@ -5675,8 +5675,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -5685,8 +5685,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -5695,8 +5695,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -5705,8 +5705,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -5715,8 +5715,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -5751,7 +5751,7 @@ "/xpanse/services/orders/{orderId}": { "get": { "tags": ["ServiceOrders"], - "description": "Get details of the service order by the order id.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Get details of the service order by the order id.
Required role: admin or isv or user
", "operationId": "getOrderDetailsByOrderId", "parameters": [ { @@ -5775,8 +5775,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -5785,8 +5785,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -5795,8 +5795,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -5805,8 +5805,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -5815,8 +5815,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -5849,7 +5849,7 @@ }, "delete": { "tags": ["ServiceOrders"], - "description": "Delete the service order by the order id.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Delete the service order by the order id.
Required role: admin or isv or user
", "operationId": "deleteOrderByOrderId", "parameters": [ { @@ -5873,8 +5873,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -5883,8 +5883,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -5893,8 +5893,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -5903,8 +5903,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -5913,8 +5913,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -5942,7 +5942,7 @@ "/xpanse/services/orders/{orderId}/status": { "get": { "tags": ["ServiceOrders"], - "description": "Long-polling method to get the latest or updated task status of the service order.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Long-polling method to get the latest or updated task status of the service order.
Required role: admin or isv or user
", "operationId": "getLatestServiceOrderStatus", "parameters": [ { @@ -5976,8 +5976,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -5986,8 +5986,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -5996,8 +5996,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -6006,8 +6006,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -6016,8 +6016,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -6052,7 +6052,7 @@ "/xpanse/services/migrations": { "get": { "tags": ["Migration"], - "description": "List all services migration by a user.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "List all services migration by a user.
Required role: admin or user
", "operationId": "listServiceMigrations", "parameters": [ { @@ -6123,8 +6123,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -6133,8 +6133,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -6143,8 +6143,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -6153,8 +6153,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -6163,8 +6163,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -6202,7 +6202,7 @@ "/xpanse/services/migration/{migrationId}": { "get": { "tags": ["Migration"], - "description": "Get migration records based on migration id.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Get migration records based on migration id.
Required role: admin or user
", "operationId": "getMigrationOrderDetailsById", "parameters": [ { @@ -6226,8 +6226,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -6236,8 +6236,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -6246,8 +6246,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -6256,8 +6256,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -6266,8 +6266,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -6302,7 +6302,7 @@ "/xpanse/services/isv": { "get": { "tags": ["Service"], - "description": "List all deployed services by a user.\u003Cbr\u003E Required role: \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "List all deployed services by a user.
Required role: isv
", "operationId": "listDeployedServicesOfIsv", "parameters": [ { @@ -6398,8 +6398,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -6408,8 +6408,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -6418,8 +6418,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -6428,8 +6428,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -6438,8 +6438,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -6477,7 +6477,7 @@ "/xpanse/services/isv/details/vendor_hosted/{serviceId}": { "get": { "tags": ["Service"], - "description": "Get the details of the deployed service by service id.\u003Cbr\u003E Required role: \u003Cb\u003Eisv\u003C/b\u003E \u003C/br\u003E", + "description": "Get the details of the deployed service by service id.
Required role: isv
", "operationId": "getServiceDetailsByIdForIsv", "parameters": [ { @@ -6501,8 +6501,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -6511,8 +6511,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -6521,8 +6521,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -6531,8 +6531,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -6541,8 +6541,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -6577,7 +6577,7 @@ "/xpanse/services/details": { "get": { "tags": ["Service"], - "description": "List details of deployed services using parameters.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "List details of deployed services using parameters.
Required role: admin or user
", "operationId": "listDeployedServicesDetails", "parameters": [ { @@ -6673,8 +6673,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -6683,8 +6683,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -6693,8 +6693,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -6703,8 +6703,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -6713,8 +6713,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -6752,7 +6752,7 @@ "/xpanse/services/details/vendor_hosted/{serviceId}": { "get": { "tags": ["Service"], - "description": "Get deployed service details by serviceId.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Get deployed service details by serviceId.
Required role: admin or user
", "operationId": "getVendorHostedServiceDetailsById", "parameters": [ { @@ -6776,8 +6776,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -6786,8 +6786,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -6796,8 +6796,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -6806,8 +6806,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -6816,8 +6816,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -6852,7 +6852,7 @@ "/xpanse/services/details/self_hosted/{serviceId}": { "get": { "tags": ["Service"], - "description": "Get details of the deployed service by id.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Get details of the deployed service by id.
Required role: admin or user
", "operationId": "getSelfHostedServiceDetailsById", "parameters": [ { @@ -6876,8 +6876,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -6886,8 +6886,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -6896,8 +6896,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -6906,8 +6906,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -6916,8 +6916,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -6952,7 +6952,7 @@ "/xpanse/services/config/requests": { "get": { "tags": ["ServiceConfiguration"], - "description": "List service's configuration.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "List service's configuration.
Required role: admin or user
", "operationId": "getAllServiceConfigurationChangeDetails", "parameters": [ { @@ -7013,8 +7013,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -7023,8 +7023,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -7033,8 +7033,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -7043,8 +7043,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -7053,8 +7053,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -7092,7 +7092,7 @@ "/xpanse/service/current/config/{serviceId}": { "get": { "tags": ["ServiceConfiguration"], - "description": "Query the service's current configuration by id of the deployed service.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Query the service's current configuration by id of the deployed service.
Required role: admin or user
", "operationId": "getCurrentConfigurationOfService", "parameters": [ { @@ -7116,8 +7116,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -7126,8 +7126,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -7136,8 +7136,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -7146,8 +7146,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -7156,8 +7156,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -7192,7 +7192,7 @@ "/xpanse/pricing/{templateId}/{regionName}/{siteName}/{billingMode}/{flavorName}": { "get": { "tags": ["ServicePrices"], - "description": "Get the price of one specific flavor of the service.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Get the price of one specific flavor of the service.
Required role: admin or user
", "operationId": "getServicePriceByFlavor", "parameters": [ { @@ -7253,8 +7253,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -7263,8 +7263,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -7273,8 +7273,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -7283,8 +7283,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -7293,8 +7293,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -7329,7 +7329,7 @@ "/xpanse/pricing/service/{templateId}/{regionName}/{siteName}/{billingMode}": { "get": { "tags": ["ServicePrices"], - "description": "Get the prices of all flavors of the service\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Get the prices of all flavors of the service
Required role: admin or user
", "operationId": "getPricesByService", "parameters": [ { @@ -7381,8 +7381,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -7391,8 +7391,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -7401,8 +7401,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -7411,8 +7411,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -7421,8 +7421,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -7460,7 +7460,7 @@ "/xpanse/metrics": { "get": { "tags": ["Monitor"], - "description": "Get metrics of a deployed service or a resource.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Get metrics of a deployed service or a resource.
Required role: admin or user
", "operationId": "getMetrics", "parameters": [ { @@ -7545,8 +7545,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -7555,8 +7555,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -7565,8 +7565,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -7575,8 +7575,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -7585,8 +7585,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -7624,7 +7624,7 @@ "/xpanse/health": { "get": { "tags": ["Admin"], - "description": "Check health of API service and backend systems.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Ecsp\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Check health of API service and backend systems.
Required role: admin or csp or isv or user
", "operationId": "healthCheck", "responses": { "500": { @@ -7637,8 +7637,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -7647,8 +7647,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -7657,8 +7657,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -7667,8 +7667,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -7677,8 +7677,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -7713,7 +7713,7 @@ "/xpanse/csps/{cspName}/sites": { "get": { "tags": ["CredentialsConfiguration"], - "description": "List the sites of the cloud service provider.\u003Cbr\u003E Required role: \u003Cb\u003Eisv\u003C/b\u003E or \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "List the sites of the cloud service provider.
Required role: isv or admin or user
", "operationId": "getSitesOfCsp", "parameters": [ { @@ -7748,8 +7748,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -7758,8 +7758,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -7768,8 +7768,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -7778,8 +7778,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -7788,8 +7788,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -7827,7 +7827,7 @@ "/xpanse/csps/active": { "get": { "tags": ["Admin"], - "description": "List cloud service providers with active plugin.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Ecsp\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "List cloud service providers with active plugin.
Required role: admin or csp or isv or user
", "operationId": "getActiveCsps", "responses": { "500": { @@ -7840,8 +7840,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -7850,8 +7850,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -7860,8 +7860,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -7870,8 +7870,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -7880,8 +7880,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -7930,7 +7930,7 @@ "/xpanse/csp/service_templates": { "get": { "tags": ["CloudServiceProvider"], - "description": "List managed service templates with query params.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Ecsp\u003C/b\u003E \u003C/br\u003E", + "description": "List managed service templates with query params.
Required role: admin or csp
", "operationId": "listManagedServiceTemplates", "parameters": [ { @@ -8005,8 +8005,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -8015,8 +8015,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -8025,8 +8025,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -8035,8 +8035,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -8045,8 +8045,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -8084,7 +8084,7 @@ "/xpanse/csp/service_templates/{id}": { "get": { "tags": ["CloudServiceProvider"], - "description": "view service template by id.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Ecsp\u003C/b\u003E \u003C/br\u003E", + "description": "view service template by id.
Required role: admin or csp
", "operationId": "getRegistrationDetails", "parameters": [ { @@ -8108,8 +8108,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -8118,8 +8118,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -8128,8 +8128,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -8138,8 +8138,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -8148,8 +8148,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -8184,7 +8184,7 @@ "/xpanse/csp/resources/{deployResourceKind}": { "get": { "tags": ["CloudResources"], - "description": "List existing cloud resource names with kind\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "List existing cloud resource names with kind
Required role: admin or user
", "operationId": "getExistingResourceNamesWithKind", "parameters": [ { @@ -8267,8 +8267,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -8277,8 +8277,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -8287,8 +8287,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -8297,8 +8297,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -8307,8 +8307,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -8346,7 +8346,7 @@ "/xpanse/csp/region/azs": { "get": { "tags": ["Service"], - "description": "Get availability zones with csp and region.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Ecsp\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Get availability zones with csp and region.
Required role: admin or csp or isv or user
", "operationId": "getAvailabilityZones", "parameters": [ { @@ -8408,8 +8408,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -8418,8 +8418,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -8428,8 +8428,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -8438,8 +8438,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -8448,8 +8448,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -8487,7 +8487,7 @@ "/xpanse/credentials/openapi/{csp}/{type}": { "get": { "tags": ["CredentialsConfiguration"], - "description": "Returns the OpenAPI document for adding a credential.\u003Cbr\u003E Required role: \u003Cb\u003Eisv\u003C/b\u003E or \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Returns the OpenAPI document for adding a credential.
Required role: isv or admin or user
", "operationId": "getCredentialOpenApi", "parameters": [ { @@ -8532,8 +8532,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -8542,8 +8542,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -8552,8 +8552,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -8562,8 +8562,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -8572,8 +8572,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -8608,7 +8608,7 @@ "/xpanse/credentials/capabilities": { "get": { "tags": ["CredentialsConfiguration"], - "description": "List the credential capabilities defined by the cloud service provider.\u003Cbr\u003E Required role: \u003Cb\u003Eisv\u003C/b\u003E or \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "List the credential capabilities defined by the cloud service provider.
Required role: isv or admin or user
", "operationId": "getCredentialCapabilities", "parameters": [ { @@ -8662,8 +8662,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -8672,8 +8672,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -8682,8 +8682,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -8692,8 +8692,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -8702,8 +8702,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -8741,7 +8741,7 @@ "/xpanse/credential_types": { "get": { "tags": ["CredentialsConfiguration"], - "description": "List the credential types supported by the cloud service provider.\u003Cbr\u003E Required role: \u003Cb\u003Eisv\u003C/b\u003E or \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "List the credential types supported by the cloud service provider.
Required role: isv or admin or user
", "operationId": "getCredentialTypes", "parameters": [ { @@ -8776,8 +8776,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -8786,8 +8786,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -8796,8 +8796,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -8806,8 +8806,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -8816,8 +8816,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -8856,7 +8856,7 @@ "/xpanse/catalog/services": { "get": { "tags": ["ServiceCatalog"], - "description": "List of all approved services which are available for user to order.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "List of all approved services which are available for user to order.
Required role: admin or user
", "operationId": "listOrderableServices", "parameters": [ { @@ -8941,8 +8941,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -8951,8 +8951,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -8961,8 +8961,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -8971,8 +8971,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -8981,8 +8981,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -9028,7 +9028,7 @@ "/xpanse/catalog/services/{id}": { "get": { "tags": ["ServiceCatalog"], - "description": "Get deployable service by id.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Get deployable service by id.
Required role: admin or user
", "operationId": "getOrderableServiceDetails", "parameters": [ { @@ -9052,8 +9052,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -9062,8 +9062,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -9072,8 +9072,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -9082,8 +9082,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -9092,8 +9092,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -9128,7 +9128,7 @@ "/xpanse/catalog/services/{id}/openapi": { "get": { "tags": ["ServiceCatalog"], - "description": "Get the API document of the orderable service.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Eisv\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Get the API document of the orderable service.
Required role: admin or isv or user
", "operationId": "openApi", "parameters": [ { @@ -9151,8 +9151,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -9161,8 +9161,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -9171,8 +9171,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -9181,8 +9181,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -9191,8 +9191,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -9260,8 +9260,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -9270,8 +9270,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -9280,8 +9280,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -9290,8 +9290,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -9300,8 +9300,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -9372,8 +9372,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -9382,8 +9382,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -9392,8 +9392,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -9402,8 +9402,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -9412,8 +9412,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -9461,8 +9461,8 @@ } } }, - "422": { - "description": "Unprocessable Entity", + "401": { + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -9471,8 +9471,8 @@ } } }, - "400": { - "description": "Bad Request", + "502": { + "description": "Bad Gateway", "content": { "application/json": { "schema": { @@ -9481,8 +9481,8 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -9491,8 +9491,8 @@ } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -9501,8 +9501,8 @@ } } }, - "502": { - "description": "Bad Gateway", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -9530,7 +9530,7 @@ "/xpanse/services/{serviceId}": { "delete": { "tags": ["Service"], - "description": "Create an order task to destroy the deployed service using id.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Create an order task to destroy the deployed service using id.
Required role: admin or user
", "operationId": "destroy", "parameters": [ { @@ -9554,7 +9554,7 @@ } } }, - "422": { + "401": { "description": "", "content": { "application/json": { @@ -9564,7 +9564,7 @@ } } }, - "400": { + "502": { "description": "", "content": { "application/json": { @@ -9574,7 +9574,7 @@ } } }, - "403": { + "422": { "description": "", "content": { "application/json": { @@ -9584,7 +9584,7 @@ } } }, - "401": { + "400": { "description": "", "content": { "application/json": { @@ -9594,7 +9594,7 @@ } } }, - "502": { + "403": { "description": "", "content": { "application/json": { @@ -9630,7 +9630,7 @@ "/xpanse/services/purge/{serviceId}": { "delete": { "tags": ["Service"], - "description": "Create an order task to purge the deployed service using service id.\u003Cbr\u003E Required role: \u003Cb\u003Eadmin\u003C/b\u003E or \u003Cb\u003Euser\u003C/b\u003E \u003C/br\u003E", + "description": "Create an order task to purge the deployed service using service id.
Required role: admin or user
", "operationId": "purge", "parameters": [ { @@ -9654,7 +9654,7 @@ } } }, - "422": { + "401": { "description": "", "content": { "application/json": { @@ -9664,7 +9664,7 @@ } } }, - "400": { + "502": { "description": "", "content": { "application/json": { @@ -9674,7 +9674,7 @@ } } }, - "403": { + "422": { "description": "", "content": { "application/json": { @@ -9684,7 +9684,7 @@ } } }, - "401": { + "400": { "description": "", "content": { "application/json": { @@ -9694,7 +9694,7 @@ } } }, - "502": { + "403": { "description": "", "content": { "application/json": { @@ -10286,7 +10286,7 @@ "enum": ["terraform", "opentofu"] }, "version": { - "pattern": "^(=|\u003E=|\u003C=)\\s*[vV]?\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$", + "pattern": "^(=|>=|<=)\\s*[vV]?\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$", "type": "string", "description": "The version of the deployer which will handle the service deployment." } @@ -10967,6 +10967,9 @@ "type": "string", "description": "End user license agreement content of the service." }, + "serviceConfigurationManage": { + "$ref": "#/components/schemas/ServiceConfigurationManage" + }, "links": { "type": "array", "items": { @@ -12782,6 +12785,13 @@ "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/ServiceConfigurationParameter" + } + }, "links": { "type": "array", "items": { diff --git a/src/xpanse-api/generated/core/OpenAPI.ts b/src/xpanse-api/generated/core/OpenAPI.ts index c7c8d773c..8c25c0444 100644 --- a/src/xpanse-api/generated/core/OpenAPI.ts +++ b/src/xpanse-api/generated/core/OpenAPI.ts @@ -52,7 +52,7 @@ export const OpenAPI: OpenAPIConfig = { PASSWORD: undefined, TOKEN: undefined, USERNAME: undefined, - VERSION: '1.0.20-SNAPSHOT', + VERSION: '1.0.22-SNAPSHOT', WITH_CREDENTIALS: false, interceptors: { request: new Interceptors(), diff --git a/src/xpanse-api/generated/services.gen.ts b/src/xpanse-api/generated/services.gen.ts index e9a283688..dd6779047 100644 --- a/src/xpanse-api/generated/services.gen.ts +++ b/src/xpanse-api/generated/services.gen.ts @@ -1063,7 +1063,7 @@ export const deleteIsvCloudCredential = ( * @param data The data for the request. * @param data.changeId id of the update request. * @param data.requestBody - * @returns unknown OK + * @returns void No Content * @throws ApiError */ export const updateConfigurationChangeResult = ( diff --git a/src/xpanse-api/generated/types.gen.ts b/src/xpanse-api/generated/types.gen.ts index 9a457034d..535adb2e8 100644 --- a/src/xpanse-api/generated/types.gen.ts +++ b/src/xpanse-api/generated/types.gen.ts @@ -1188,6 +1188,7 @@ export type ServiceTemplateDetailVo = { * End user license agreement content of the service. */ eula?: string; + serviceConfigurationManage?: ServiceConfigurationManage; links?: Array; }; @@ -2772,6 +2773,10 @@ export type UserOrderableServiceVo = { * End user license agreement content of the service. */ eula?: string; + /** + * The collection of service configuration parameters. + */ + configurationParameters?: Array; links?: Array; }; @@ -3145,7 +3150,7 @@ export type UpdateConfigurationChangeResultData = { requestBody: ServiceConfigurationChangeResult; }; -export type UpdateConfigurationChangeResultResponse = unknown; +export type UpdateConfigurationChangeResultResponse = void; export type ListDeployedServicesData = { /**