From 69fb17504e9fe43d0d940a9e4f9df3577d31bb46 Mon Sep 17 00:00:00 2001 From: Seokho Son Date: Thu, 22 Aug 2024 17:09:30 +0900 Subject: [PATCH] Arrange API resource group tags --- src/api/rest/docs/docs.go | 309 +++++++++++----------- src/api/rest/docs/swagger.json | 309 +++++++++++----------- src/api/rest/docs/swagger.yaml | 309 +++++++++++----------- src/api/rest/server/auth/auth.go | 3 +- src/api/rest/server/common/config.go | 18 +- src/api/rest/server/common/namespace.go | 12 +- src/api/rest/server/common/utility.go | 32 +-- src/api/rest/server/mci/benchmark.go | 8 +- src/api/rest/server/mci/control.go | 6 +- src/api/rest/server/mci/k8scluster.go | 28 +- src/api/rest/server/mci/manageInfo.go | 20 +- src/api/rest/server/mci/monitoring.go | 6 +- src/api/rest/server/mci/network.go | 12 +- src/api/rest/server/mci/nlb.go | 20 +- src/api/rest/server/mci/orchestration.go | 12 +- src/api/rest/server/mci/provisioning.go | 16 +- src/api/rest/server/mci/recommendation.go | 4 +- src/api/rest/server/mci/remoteCommand.go | 8 +- src/api/rest/server/mcir/common.go | 8 +- src/api/rest/server/mcir/customimage.go | 10 +- src/api/rest/server/mcir/dataDisk.go | 18 +- src/api/rest/server/mcir/firewallrule.go | 8 +- src/api/rest/server/mcir/image.go | 20 +- src/api/rest/server/mcir/securitygroup.go | 12 +- src/api/rest/server/mcir/spec.go | 16 +- src/api/rest/server/mcir/sshkey.go | 12 +- src/api/rest/server/mcir/subnet.go | 12 +- src/api/rest/server/mcir/vnet.go | 12 +- src/api/rest/server/server.go | 2 +- src/api/rest/server/util/netuil.go | 4 +- 30 files changed, 635 insertions(+), 631 deletions(-) diff --git a/src/api/rest/docs/docs.go b/src/api/rest/docs/docs.go index 96953a9f4..b6dfdedf6 100644 --- a/src/api/rest/docs/docs.go +++ b/src/api/rest/docs/docs.go @@ -38,9 +38,10 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Auth] Test JWT authentication" + "[Admin] API Request Management" ], "summary": "Test JWT authentication", + "operationId": "TestJWTAuth", "responses": { "200": { "description": "Information of JWT authentication", @@ -67,7 +68,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Get available kubernetes cluster node image", "operationId": "GetAvailableK8sClusterNodeImage", @@ -119,7 +120,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Get available kubernetes cluster version", "operationId": "GetAvailableK8sClusterVersion", @@ -171,7 +172,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Check whether nodegroups are required during the k8scluster creation", "operationId": "CheckNodeGroupsOnK8sCreation", @@ -216,7 +217,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] Multi-Cloud environment configuration" + "[Admin] Multi-Cloud Information" ], "summary": "Get cloud information", "operationId": "GetCloudInfo", @@ -252,7 +253,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] System environment" + "[Admin] System Configuration" ], "summary": "List all configs", "operationId": "GetAllConfig", @@ -286,7 +287,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] System environment" + "[Admin] System Configuration" ], "summary": "Create or Update config", "operationId": "PostConfig", @@ -331,7 +332,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] System environment" + "[Admin] System Configuration" ], "summary": "Init all configs", "operationId": "InitAllConfig", @@ -361,7 +362,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] System environment" + "[Admin] System Configuration" ], "summary": "Get config", "operationId": "GetConfig", @@ -404,7 +405,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] System environment" + "[Admin] System Configuration" ], "summary": "Init config", "operationId": "InitConfig", @@ -638,7 +639,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] System utility" + "[Admin] API Request Management" ], "summary": "Forward any (GET) request to CB-Spider", "operationId": "ForwardAnyReqToAny", @@ -681,7 +682,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] API Request Management" ], "summary": "Check HTTP version of incoming request", "operationId": "CheckHTTPVersion", @@ -717,7 +718,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "Inspect Resources (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug, CB-Spider, CSP", "operationId": "InspectResources", @@ -764,7 +765,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "Inspect Resources Overview (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug and CSP for all connections", "operationId": "InspectResourcesOverview", @@ -800,7 +801,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] Multi-Cloud environment configuration" + "[Kubernetes] Cluster Management" ], "summary": "Get kubernetes cluster information", "operationId": "GetK8sClusterInfo", @@ -836,7 +837,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] Multi-Cloud environment configuration" + "[Admin] System Configuration" ], "summary": "Load Common Resources from internal asset files", "operationId": "LoadCommonResource", @@ -866,7 +867,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Common" + "[Infra Resource] Image Management" ], "summary": "Lookup image", "operationId": "LookupImage", @@ -913,7 +914,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Common" + "[Infra Resource] Image Management" ], "summary": "Lookup image list", "operationId": "LookupImageList", @@ -960,7 +961,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Common" + "[Infra Resource] Spec Management" ], "summary": "Lookup spec", "operationId": "LookupSpec", @@ -1007,7 +1008,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Common" + "[Infra Resource] Spec Management" ], "summary": "Lookup spec list", "operationId": "LookupSpecList", @@ -1054,7 +1055,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Check available ConnectionConfig list for creating MCI Dynamically", "operationId": "PostMciDynamicCheckRequest", @@ -1101,7 +1102,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Recommend MCI plan (filter and priority)", "operationId": "RecommendVm", @@ -1150,7 +1151,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Namespace] Namespace management" + "[Admin] System Configuration" ], "summary": "List all namespaces or namespaces' ID", "operationId": "GetAllNs", @@ -1210,7 +1211,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Namespace] Namespace management" + "[Admin] System Configuration" ], "summary": "Create namespace", "operationId": "PostNs", @@ -1255,7 +1256,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Namespace] Namespace management" + "[Admin] System Configuration" ], "summary": "Delete all namespaces", "operationId": "DelAllNs", @@ -1285,7 +1286,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Namespace] Namespace management" + "[Admin] System Configuration" ], "summary": "Get namespace", "operationId": "GetNs", @@ -1329,7 +1330,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Namespace] Namespace management" + "[Admin] System Configuration" ], "summary": "Update namespace", "operationId": "PutNs", @@ -1382,7 +1383,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Namespace] Namespace management" + "[Admin] System Configuration" ], "summary": "Delete namespace", "operationId": "DelNs", @@ -1422,7 +1423,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Performance benchmarking (WIP)" + "[MC-Infra] MCI Performance Benchmarking (WIP)" ], "summary": "Run MCI benchmark for a single performance metric and return results", "operationId": "GetBenchmark", @@ -1507,7 +1508,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Performance benchmarking (WIP)" + "[MC-Infra] MCI Performance Benchmarking (WIP)" ], "summary": "Run MCI benchmark for all performance metrics and return results", "operationId": "GetAllBenchmark", @@ -1570,7 +1571,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Performance benchmarking (WIP)" + "[MC-Infra] MCI Performance Benchmarking (WIP)" ], "summary": "Run MCI benchmark for network latency", "operationId": "GetLatencyBenchmark", @@ -1624,7 +1625,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Common" + "[Infra Resource] Common Utility" ], "summary": "Check resources' existence", "operationId": "CheckResource", @@ -1678,7 +1679,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Remote command" + "[MC-Infra] MCI Remote Command" ], "summary": "Send a command to specified MCI", "operationId": "PostCmdMci", @@ -1761,7 +1762,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Control lifecycle" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Control the lifecycle of MCI (refine, suspend, resume, reboot, terminate)", "operationId": "GetControlMci", @@ -1841,7 +1842,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Control lifecycle" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Control the lifecycle of VM (suspend, resume, reboot, terminate)", "operationId": "GetControlMciVm", @@ -1926,7 +1927,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Performance benchmarking (WIP)" + "[MC-Infra] MCI Performance Benchmarking (WIP)" ], "summary": "Install the benchmark agent to specified MCI", "operationId": "PostInstallBenchmarkAgentToMci", @@ -1998,7 +1999,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "List all K8sClusters or K8sClusters' ID", "operationId": "GetAllK8sCluster", @@ -2078,7 +2079,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Create K8sCluster", "operationId": "PostK8sCluster", @@ -2140,7 +2141,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Delete all K8sClusters", "operationId": "DeleteAllK8sCluster", @@ -2187,7 +2188,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Get K8sCluster", "operationId": "GetK8sCluster", @@ -2239,7 +2240,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Delete K8sCluster", "operationId": "DeleteK8sCluster", @@ -2287,7 +2288,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Add a K8sNodeGroup", "operationId": "PostK8sNodeGroup", @@ -2350,7 +2351,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Remove a K8sNodeGroup", "operationId": "DeleteK8sNodeGroup", @@ -2406,7 +2407,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Change a K8sNodeGroup's Autoscale Size", "operationId": "PutChangeK8sNodeGroupAutoscaleSize", @@ -2477,7 +2478,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Set a K8sNodeGroup's Autoscaling On/Off", "operationId": "PutSetK8sNodeGroupAutoscaling", @@ -2548,7 +2549,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Upgrade a K8sCluster's version", "operationId": "PutUpgradeK8sCluster", @@ -2611,7 +2612,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Common" + "[Infra Resource] Common Utility" ], "summary": "Load Default Resource from internal asset file", "operationId": "LoadSharedResource", @@ -2671,7 +2672,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "List all MCIs or MCIs' ID", "operationId": "GetAllMci", @@ -2747,7 +2748,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Create MCI", "operationId": "PostMci", @@ -2800,7 +2801,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Delete all MCIs", "operationId": "DelAllMci", @@ -2849,7 +2850,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Get MCI object (option: status, accessInfo, vmId)", "operationId": "GetMci", @@ -2952,7 +2953,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Delete MCI", "operationId": "DelMci", @@ -3010,7 +3011,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Remote command" + "[MC-Infra] MCI Remote Command" ], "summary": "Remove a bastion VM from all vNets", "operationId": "RemoveBastionNodes", @@ -3072,7 +3073,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] NLB management" + "[Infra Resource] NLB Management" ], "summary": "Create a special purpose MCI for NLB and depoly and setting SW NLB", "operationId": "PostMcNLB", @@ -3135,7 +3136,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] NLB management" + "[Infra Resource] NLB Management" ], "summary": "List all NLBs or NLBs' ID", "operationId": "GetAllNLB", @@ -3223,7 +3224,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] NLB management" + "[Infra Resource] NLB Management" ], "summary": "Create NLB", "operationId": "PostNLB", @@ -3293,7 +3294,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] NLB management" + "[Infra Resource] NLB Management" ], "summary": "Delete all NLBs", "operationId": "DelAllNLB", @@ -3348,7 +3349,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] NLB management" + "[Infra Resource] NLB Management" ], "summary": "Get NLB", "operationId": "GetNLB", @@ -3408,7 +3409,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] NLB management" + "[Infra Resource] NLB Management" ], "summary": "Delete NLB", "operationId": "DelNLB", @@ -3463,7 +3464,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] NLB management" + "[Infra Resource] NLB Management" ], "summary": "Get NLB Health", "operationId": "GetNLBHealth", @@ -3525,7 +3526,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] NLB management (for developer)" + "[Infra Resource] NLB Management (for developer)" ], "summary": "Add VMs to NLB", "operationId": "AddNLBVMs", @@ -3594,7 +3595,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] NLB management (for developer)" + "[Infra Resource] NLB Management (for developer)" ], "summary": "Delete VMs from NLB", "operationId": "RemoveNLBVMs", @@ -3659,7 +3660,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[VPN] Sites in MCI" + "[Infra Resource] Network Management" ], "summary": "Get sites in MCI", "operationId": "GetSitesInMci", @@ -3719,7 +3720,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "List SubGroup IDs in a specified MCI", "operationId": "GetMciGroupIds", @@ -3773,7 +3774,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "List VMs with a SubGroup label in a specified MCI", "operationId": "GetMciGroupVms", @@ -3842,7 +3843,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "ScaleOut subGroup in specified MCI", "operationId": "PostMciSubGroupScaleOut", @@ -3913,7 +3914,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Create and add homogeneous VMs(subGroup) to a specified MCI (Set subGroupSize for multiple VMs)", "operationId": "PostMciVm", @@ -3976,7 +3977,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Remote command" + "[MC-Infra] MCI Remote Command" ], "summary": "Get bastion nodes for a VM", "operationId": "GetBastionNodes", @@ -4041,7 +4042,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Remote command" + "[MC-Infra] MCI Remote Command" ], "summary": "Set bastion nodes for a VM", "operationId": "SetBastionNodes", @@ -4111,7 +4112,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Get VM in specified MCI", "operationId": "GetMciVm", @@ -4200,7 +4201,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Delete VM in specified MCI", "operationId": "DelMciVm", @@ -4265,7 +4266,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "Get available dataDisks for a VM", "operationId": "GetVmDataDisk", @@ -4340,7 +4341,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "Attach/Detach available dataDisk", "operationId": "PutVmDataDisk", @@ -4429,7 +4430,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "Provisioning (Create and attach) dataDisk", "operationId": "PostVmDataDisk", @@ -4494,7 +4495,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] Snapshot and Custom Image Management" + "[Infra Resource] Image Management" ], "summary": "Snapshot VM and create a Custom Image Object using the Snapshot", "operationId": "PostMciVmSnapshot", @@ -4565,7 +4566,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Create VM Dynamically and add it to MCI", "operationId": "PostMciVmDynamic", @@ -4628,7 +4629,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[VPN] Site-to-site VPN (under development)" + "[Infra Resource] Site-to-site VPN Management (under development)" ], "summary": "Get resource info of a site-to-site VPN (Currently, GCP-AWS is supported)", "operationId": "GetSiteToSiteVpn", @@ -4703,7 +4704,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[VPN] Site-to-site VPN (under development)" + "[Infra Resource] Site-to-site VPN Management (under development)" ], "summary": "Check the status of a specific request by its ID", "operationId": "GetRequestStatusOfSiteToSiteVpn", @@ -4778,7 +4779,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Create MCI Dynamically", "operationId": "PostMciDynamic", @@ -4848,7 +4849,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Resource monitor (for developer)" + "[MC-Infra] MCI Resource Monitor (for developer)" ], "summary": "Install monitoring agent (CB-Dragonfly agent) to MCI", "operationId": "PostInstallMonitorAgentToMci", @@ -4911,7 +4912,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Resource monitor (for developer)" + "[MC-Infra] MCI Resource Monitor (for developer)" ], "summary": "Get monitoring data of specified MCI for specified monitoring metric (cpu, memory, disk, network)", "operationId": "GetMonitorData", @@ -4972,7 +4973,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Resource monitor (for developer)" + "[MC-Infra] MCI Resource Monitor (for developer)" ], "summary": "Set monitoring agent (CB-Dragonfly agent) installation status installed (for Windows VM only)", "operationId": "PutMonitorAgentStatusInstalled", @@ -5034,7 +5035,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Auto control policy management (WIP)" + "[MC-Infra] MCI Orchestration Management (WIP)" ], "summary": "List all MCI policies", "operationId": "GetAllMciPolicy", @@ -5078,7 +5079,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Auto control policy management (WIP)" + "[MC-Infra] MCI Orchestration Management (WIP)" ], "summary": "Delete all MCI policies", "operationId": "DelAllMciPolicy", @@ -5118,7 +5119,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Auto control policy management (WIP)" + "[MC-Infra] MCI Orchestration Management (WIP)" ], "summary": "Get MCI Policy", "operationId": "GetMciPolicy", @@ -5170,7 +5171,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Auto control policy management (WIP)" + "[MC-Infra] MCI Orchestration Management (WIP)" ], "summary": "Create MCI Automation policy", "operationId": "PostMciPolicy", @@ -5231,7 +5232,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Auto control policy management (WIP)" + "[MC-Infra] MCI Orchestration Management (WIP)" ], "summary": "Delete MCI Policy", "operationId": "DelMciPolicy", @@ -5279,7 +5280,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Register existing VM in a CSP to Cloud-Barista MCI", "operationId": "PostRegisterCSPNativeVM", @@ -5334,7 +5335,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] Snapshot and Custom Image Management" + "[Infra Resource] Image Management" ], "summary": "List all customImages or customImages' ID", "operationId": "GetAllCustomImage", @@ -5414,7 +5415,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] Snapshot and Custom Image Management" + "[Infra Resource] Image Management" ], "summary": "Register existing Custom Image in a CSP", "operationId": "PostCustomImage", @@ -5477,7 +5478,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] Snapshot and Custom Image Management" + "[Infra Resource] Image Management" ], "summary": "Delete all customImages", "operationId": "DelAllCustomImage", @@ -5524,7 +5525,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] Snapshot and Custom Image Management" + "[Infra Resource] Image Management" ], "summary": "Get customImage", "operationId": "GetCustomImage", @@ -5575,7 +5576,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] Snapshot and Custom Image Management" + "[Infra Resource] Image Management" ], "summary": "Delete customImage", "operationId": "DelCustomImage", @@ -5622,7 +5623,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "List all Data Disks or Data Disks' ID", "operationId": "GetAllDataDisk", @@ -5702,7 +5703,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "Create Data Disk", "operationId": "PostDataDisk", @@ -5764,7 +5765,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "Delete all Data Disks", "operationId": "DelAllDataDisk", @@ -5811,7 +5812,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "Get Data Disk", "operationId": "GetDataDisk", @@ -5862,7 +5863,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "Upsize Data Disk", "operationId": "PutDataDisk", @@ -5922,7 +5923,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "Delete Data Disk", "operationId": "DelDataDisk", @@ -5969,7 +5970,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Image management" + "[Infra Resource] Image Management" ], "summary": "Fetch images", "operationId": "FetchImages", @@ -6015,7 +6016,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Spec management" + "[Infra Resource] Spec Management" ], "summary": "Fetch specs", "operationId": "FetchSpecs", @@ -6061,7 +6062,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Spec management" + "[Infra Resource] Spec Management" ], "summary": "Filter specs by range", "operationId": "FilterSpecsByRange", @@ -6115,7 +6116,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Image management" + "[Infra Resource] Image Management" ], "summary": "List all images or images' ID", "operationId": "GetAllImage", @@ -6195,7 +6196,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Image management" + "[Infra Resource] Image Management" ], "summary": "Register image", "operationId": "PostImage", @@ -6273,7 +6274,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Image management" + "[Infra Resource] Image Management" ], "summary": "Delete all images", "operationId": "DelAllImage", @@ -6320,7 +6321,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Image management" + "[Infra Resource] Image Management" ], "summary": "Get image", "operationId": "GetImage", @@ -6371,7 +6372,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Image management" + "[Infra Resource] Image Management" ], "summary": "Update image", "operationId": "PutImage", @@ -6431,7 +6432,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Image management" + "[Infra Resource] Image Management" ], "summary": "Delete image", "operationId": "DelImage", @@ -6478,7 +6479,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Image management" + "[Infra Resource] Image Management" ], "summary": "Search image", "operationId": "SearchImage", @@ -6533,7 +6534,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Security group management" + "[Infra Resource] Security Group Management" ], "summary": "List all Security Groups or Security Groups' ID", "operationId": "GetAllSecurityGroup", @@ -6613,7 +6614,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Security group management" + "[Infra Resource] Security Group Management" ], "summary": "Create Security Group", "operationId": "PostSecurityGroup", @@ -6675,7 +6676,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Security group management" + "[Infra Resource] Security Group Management" ], "summary": "Delete all Security Groups", "operationId": "DelAllSecurityGroup", @@ -6722,7 +6723,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Security group management" + "[Infra Resource] Security Group Management" ], "summary": "Get Security Group", "operationId": "GetSecurityGroup", @@ -6773,7 +6774,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Security group management" + "[Infra Resource] Security Group Management" ], "summary": "Delete Security Group", "operationId": "DelSecurityGroup", @@ -6820,7 +6821,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Security group management" + "[Infra Resource] Security Group Management" ], "summary": "Create FirewallRules", "operationId": "PostFirewallRules", @@ -6873,7 +6874,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Security group management" + "[Infra Resource] Security Group Management" ], "summary": "Delete FirewallRules", "operationId": "DelFirewallRules", @@ -6922,7 +6923,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Spec management" + "[Infra Resource] Spec Management" ], "summary": "Register spec", "operationId": "PostSpec", @@ -7002,7 +7003,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Spec management" + "[Infra Resource] Spec Management" ], "summary": "Get spec", "operationId": "GetSpec", @@ -7053,7 +7054,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Spec management" + "[Infra Resource] Spec Management" ], "summary": "Update spec", "operationId": "PutSpec", @@ -7113,7 +7114,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Spec management" + "[Infra Resource] Spec Management" ], "summary": "Delete spec", "operationId": "DelSpec", @@ -7160,7 +7161,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Access key management" + "[Infra Resource] Access Key Management" ], "summary": "List all SSH Keys or SSH Keys' ID", "operationId": "GetAllSshKey", @@ -7240,7 +7241,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Access key management" + "[Infra Resource] Access Key Management" ], "summary": "Create SSH Key", "operationId": "PostSshKey", @@ -7302,7 +7303,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Access key management" + "[Infra Resource] Access Key Management" ], "summary": "Delete all SSH Keys", "operationId": "DelAllSshKey", @@ -7349,7 +7350,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Access key management" + "[Infra Resource] Access Key Management" ], "summary": "Get SSH Key", "operationId": "GetSshKey", @@ -7400,7 +7401,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Access key management" + "[Infra Resource] Access Key Management" ], "summary": "Update SSH Key", "operationId": "PutSshKey", @@ -7460,7 +7461,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Access key management" + "[Infra Resource] Access Key Management" ], "summary": "Delete SSH Key", "operationId": "DelSshKey", @@ -7507,7 +7508,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Network management" + "[Infra Resource] Network Management" ], "summary": "List all VNets or VNets' ID", "operationId": "GetAllVNet", @@ -7587,7 +7588,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Network management" + "[Infra Resource] Network Management" ], "summary": "Create VNet", "operationId": "PostVNet", @@ -7649,7 +7650,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Network management" + "[Infra Resource] Network Management" ], "summary": "Delete all VNets", "operationId": "DelAllVNet", @@ -7696,7 +7697,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Network management" + "[Infra Resource] Network Management" ], "summary": "Get VNet", "operationId": "GetVNet", @@ -7747,7 +7748,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Network management" + "[Infra Resource] Network Management" ], "summary": "Delete VNet", "operationId": "DelVNet", @@ -7794,7 +7795,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Network management" + "[Infra Resource] Network Management" ], "summary": "Create Subnet", "operationId": "PostSubnet", @@ -7856,7 +7857,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Network management" + "[Infra Resource] Network Management" ], "summary": "Delete Subnet", "operationId": "DelSubnet", @@ -7910,7 +7911,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Infra resource] MCIR Common" + "[Infra Resource] Common Utility" ], "summary": "Delete all Default Resource Objects in the given namespace", "operationId": "DelAllSharedResources", @@ -7950,7 +7951,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "Get value of an object", "operationId": "GetObject", @@ -7993,7 +7994,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "Delete an object", "operationId": "DeleteObject", @@ -8038,7 +8039,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "List all objects for a given key", "operationId": "GetObjects", @@ -8081,7 +8082,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "Delete child objects along with the given object", "operationId": "DeleteObjects", @@ -8126,7 +8127,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] Multi-Cloud environment configuration" + "[Admin] Multi-Cloud Information" ], "summary": "List all registered Providers", "operationId": "GetProviderList", @@ -8162,7 +8163,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] Multi-Cloud environment configuration" + "[Admin] Multi-Cloud Information" ], "summary": "Get registered region info", "operationId": "GetRegion", @@ -8214,7 +8215,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "Check Tumblebug is ready", "operationId": "GetReadyz", @@ -8244,7 +8245,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] Multi-Cloud environment configuration" + "[Admin] Multi-Cloud Information" ], "summary": "List all registered regions", "operationId": "GetRegionList", @@ -8280,7 +8281,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "Register CSP Native Resources (vNet, securityGroup, sshKey, vm) to CB-Tumblebug", "operationId": "RegisterCspNativeResources", @@ -8348,7 +8349,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "Register CSP Native Resources (vNet, securityGroup, sshKey, vm) from all Clouds to CB-Tumblebug", "operationId": "RegisterCspNativeResourcesAll", @@ -8416,7 +8417,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] Request tracking" + "[Admin] API Request Management" ], "summary": "Get request details", "operationId": "GetRequest", @@ -8459,7 +8460,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] Request tracking" + "[Admin] API Request Management" ], "summary": "Delete a specific request's details", "operationId": "DeleteRequest", @@ -8492,7 +8493,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] Request tracking" + "[Admin] API Request Management" ], "summary": "Get all requests", "operationId": "GetAllRequests", @@ -8552,7 +8553,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Admin] Request tracking" + "[Admin] API Request Management" ], "summary": "Delete all requests' details", "operationId": "DeleteAllRequests", @@ -8576,7 +8577,7 @@ const docTemplate = `{ "application/x-json-stream" ], "tags": [ - "[VPN] Site-to-site VPN (under development)" + "[Infra Resource] Site-to-site VPN Management (under development)" ], "summary": "(To be provided) Update a site-to-site VPN", "operationId": "PutSiteToSiteVpn", @@ -8651,7 +8652,7 @@ const docTemplate = `{ "application/x-json-stream" ], "tags": [ - "[VPN] Site-to-site VPN (under development)" + "[Infra Resource] Site-to-site VPN Management (under development)" ], "summary": "Create a site-to-site VPN (Currently, GCP-AWS is supported)", "operationId": "PostSiteToSiteVpn", @@ -8726,7 +8727,7 @@ const docTemplate = `{ "application/x-json-stream" ], "tags": [ - "[VPN] Site-to-site VPN (under development)" + "[Infra Resource] Site-to-site VPN Management (under development)" ], "summary": "Delete a site-to-site VPN (Currently, GCP-AWS is supported)", "operationId": "DeleteSiteToSiteVpn", @@ -8794,7 +8795,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Create System MCI Dynamically for Special Purpose in NS:system", "operationId": "PostSystemMci", @@ -8841,7 +8842,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Utility] Multi-cloud network design" + "[Infra Resource] Network Management" ], "summary": "Design a multi-cloud network configuration", "operationId": "PostUtilToDesignNetwork", @@ -8888,7 +8889,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "[Utility] Multi-cloud network design" + "[Infra Resource] Network Management" ], "summary": "Validate a multi-cloud network configuration", "operationId": "PostUtilToValidateNetwork", diff --git a/src/api/rest/docs/swagger.json b/src/api/rest/docs/swagger.json index 45f9888ec..a7cf6c117 100644 --- a/src/api/rest/docs/swagger.json +++ b/src/api/rest/docs/swagger.json @@ -31,9 +31,10 @@ "application/json" ], "tags": [ - "[Auth] Test JWT authentication" + "[Admin] API Request Management" ], "summary": "Test JWT authentication", + "operationId": "TestJWTAuth", "responses": { "200": { "description": "Information of JWT authentication", @@ -60,7 +61,7 @@ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Get available kubernetes cluster node image", "operationId": "GetAvailableK8sClusterNodeImage", @@ -112,7 +113,7 @@ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Get available kubernetes cluster version", "operationId": "GetAvailableK8sClusterVersion", @@ -164,7 +165,7 @@ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Check whether nodegroups are required during the k8scluster creation", "operationId": "CheckNodeGroupsOnK8sCreation", @@ -209,7 +210,7 @@ "application/json" ], "tags": [ - "[Admin] Multi-Cloud environment configuration" + "[Admin] Multi-Cloud Information" ], "summary": "Get cloud information", "operationId": "GetCloudInfo", @@ -245,7 +246,7 @@ "application/json" ], "tags": [ - "[Admin] System environment" + "[Admin] System Configuration" ], "summary": "List all configs", "operationId": "GetAllConfig", @@ -279,7 +280,7 @@ "application/json" ], "tags": [ - "[Admin] System environment" + "[Admin] System Configuration" ], "summary": "Create or Update config", "operationId": "PostConfig", @@ -324,7 +325,7 @@ "application/json" ], "tags": [ - "[Admin] System environment" + "[Admin] System Configuration" ], "summary": "Init all configs", "operationId": "InitAllConfig", @@ -354,7 +355,7 @@ "application/json" ], "tags": [ - "[Admin] System environment" + "[Admin] System Configuration" ], "summary": "Get config", "operationId": "GetConfig", @@ -397,7 +398,7 @@ "application/json" ], "tags": [ - "[Admin] System environment" + "[Admin] System Configuration" ], "summary": "Init config", "operationId": "InitConfig", @@ -631,7 +632,7 @@ "application/json" ], "tags": [ - "[Admin] System utility" + "[Admin] API Request Management" ], "summary": "Forward any (GET) request to CB-Spider", "operationId": "ForwardAnyReqToAny", @@ -674,7 +675,7 @@ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] API Request Management" ], "summary": "Check HTTP version of incoming request", "operationId": "CheckHTTPVersion", @@ -710,7 +711,7 @@ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "Inspect Resources (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug, CB-Spider, CSP", "operationId": "InspectResources", @@ -757,7 +758,7 @@ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "Inspect Resources Overview (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug and CSP for all connections", "operationId": "InspectResourcesOverview", @@ -793,7 +794,7 @@ "application/json" ], "tags": [ - "[Admin] Multi-Cloud environment configuration" + "[Kubernetes] Cluster Management" ], "summary": "Get kubernetes cluster information", "operationId": "GetK8sClusterInfo", @@ -829,7 +830,7 @@ "application/json" ], "tags": [ - "[Admin] Multi-Cloud environment configuration" + "[Admin] System Configuration" ], "summary": "Load Common Resources from internal asset files", "operationId": "LoadCommonResource", @@ -859,7 +860,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Common" + "[Infra Resource] Image Management" ], "summary": "Lookup image", "operationId": "LookupImage", @@ -906,7 +907,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Common" + "[Infra Resource] Image Management" ], "summary": "Lookup image list", "operationId": "LookupImageList", @@ -953,7 +954,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Common" + "[Infra Resource] Spec Management" ], "summary": "Lookup spec", "operationId": "LookupSpec", @@ -1000,7 +1001,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Common" + "[Infra Resource] Spec Management" ], "summary": "Lookup spec list", "operationId": "LookupSpecList", @@ -1047,7 +1048,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Check available ConnectionConfig list for creating MCI Dynamically", "operationId": "PostMciDynamicCheckRequest", @@ -1094,7 +1095,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Recommend MCI plan (filter and priority)", "operationId": "RecommendVm", @@ -1143,7 +1144,7 @@ "application/json" ], "tags": [ - "[Namespace] Namespace management" + "[Admin] System Configuration" ], "summary": "List all namespaces or namespaces' ID", "operationId": "GetAllNs", @@ -1203,7 +1204,7 @@ "application/json" ], "tags": [ - "[Namespace] Namespace management" + "[Admin] System Configuration" ], "summary": "Create namespace", "operationId": "PostNs", @@ -1248,7 +1249,7 @@ "application/json" ], "tags": [ - "[Namespace] Namespace management" + "[Admin] System Configuration" ], "summary": "Delete all namespaces", "operationId": "DelAllNs", @@ -1278,7 +1279,7 @@ "application/json" ], "tags": [ - "[Namespace] Namespace management" + "[Admin] System Configuration" ], "summary": "Get namespace", "operationId": "GetNs", @@ -1322,7 +1323,7 @@ "application/json" ], "tags": [ - "[Namespace] Namespace management" + "[Admin] System Configuration" ], "summary": "Update namespace", "operationId": "PutNs", @@ -1375,7 +1376,7 @@ "application/json" ], "tags": [ - "[Namespace] Namespace management" + "[Admin] System Configuration" ], "summary": "Delete namespace", "operationId": "DelNs", @@ -1415,7 +1416,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Performance benchmarking (WIP)" + "[MC-Infra] MCI Performance Benchmarking (WIP)" ], "summary": "Run MCI benchmark for a single performance metric and return results", "operationId": "GetBenchmark", @@ -1500,7 +1501,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Performance benchmarking (WIP)" + "[MC-Infra] MCI Performance Benchmarking (WIP)" ], "summary": "Run MCI benchmark for all performance metrics and return results", "operationId": "GetAllBenchmark", @@ -1563,7 +1564,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Performance benchmarking (WIP)" + "[MC-Infra] MCI Performance Benchmarking (WIP)" ], "summary": "Run MCI benchmark for network latency", "operationId": "GetLatencyBenchmark", @@ -1617,7 +1618,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Common" + "[Infra Resource] Common Utility" ], "summary": "Check resources' existence", "operationId": "CheckResource", @@ -1671,7 +1672,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Remote command" + "[MC-Infra] MCI Remote Command" ], "summary": "Send a command to specified MCI", "operationId": "PostCmdMci", @@ -1754,7 +1755,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Control lifecycle" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Control the lifecycle of MCI (refine, suspend, resume, reboot, terminate)", "operationId": "GetControlMci", @@ -1834,7 +1835,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Control lifecycle" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Control the lifecycle of VM (suspend, resume, reboot, terminate)", "operationId": "GetControlMciVm", @@ -1919,7 +1920,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Performance benchmarking (WIP)" + "[MC-Infra] MCI Performance Benchmarking (WIP)" ], "summary": "Install the benchmark agent to specified MCI", "operationId": "PostInstallBenchmarkAgentToMci", @@ -1991,7 +1992,7 @@ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "List all K8sClusters or K8sClusters' ID", "operationId": "GetAllK8sCluster", @@ -2071,7 +2072,7 @@ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Create K8sCluster", "operationId": "PostK8sCluster", @@ -2133,7 +2134,7 @@ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Delete all K8sClusters", "operationId": "DeleteAllK8sCluster", @@ -2180,7 +2181,7 @@ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Get K8sCluster", "operationId": "GetK8sCluster", @@ -2232,7 +2233,7 @@ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Delete K8sCluster", "operationId": "DeleteK8sCluster", @@ -2280,7 +2281,7 @@ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Add a K8sNodeGroup", "operationId": "PostK8sNodeGroup", @@ -2343,7 +2344,7 @@ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Remove a K8sNodeGroup", "operationId": "DeleteK8sNodeGroup", @@ -2399,7 +2400,7 @@ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Change a K8sNodeGroup's Autoscale Size", "operationId": "PutChangeK8sNodeGroupAutoscaleSize", @@ -2470,7 +2471,7 @@ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Set a K8sNodeGroup's Autoscaling On/Off", "operationId": "PutSetK8sNodeGroupAutoscaling", @@ -2541,7 +2542,7 @@ "application/json" ], "tags": [ - "[Infra resource] K8sCluster management" + "[Kubernetes] Cluster Management" ], "summary": "Upgrade a K8sCluster's version", "operationId": "PutUpgradeK8sCluster", @@ -2604,7 +2605,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Common" + "[Infra Resource] Common Utility" ], "summary": "Load Default Resource from internal asset file", "operationId": "LoadSharedResource", @@ -2664,7 +2665,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "List all MCIs or MCIs' ID", "operationId": "GetAllMci", @@ -2740,7 +2741,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Create MCI", "operationId": "PostMci", @@ -2793,7 +2794,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Delete all MCIs", "operationId": "DelAllMci", @@ -2842,7 +2843,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Get MCI object (option: status, accessInfo, vmId)", "operationId": "GetMci", @@ -2945,7 +2946,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Delete MCI", "operationId": "DelMci", @@ -3003,7 +3004,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Remote command" + "[MC-Infra] MCI Remote Command" ], "summary": "Remove a bastion VM from all vNets", "operationId": "RemoveBastionNodes", @@ -3065,7 +3066,7 @@ "application/json" ], "tags": [ - "[Infra resource] NLB management" + "[Infra Resource] NLB Management" ], "summary": "Create a special purpose MCI for NLB and depoly and setting SW NLB", "operationId": "PostMcNLB", @@ -3128,7 +3129,7 @@ "application/json" ], "tags": [ - "[Infra resource] NLB management" + "[Infra Resource] NLB Management" ], "summary": "List all NLBs or NLBs' ID", "operationId": "GetAllNLB", @@ -3216,7 +3217,7 @@ "application/json" ], "tags": [ - "[Infra resource] NLB management" + "[Infra Resource] NLB Management" ], "summary": "Create NLB", "operationId": "PostNLB", @@ -3286,7 +3287,7 @@ "application/json" ], "tags": [ - "[Infra resource] NLB management" + "[Infra Resource] NLB Management" ], "summary": "Delete all NLBs", "operationId": "DelAllNLB", @@ -3341,7 +3342,7 @@ "application/json" ], "tags": [ - "[Infra resource] NLB management" + "[Infra Resource] NLB Management" ], "summary": "Get NLB", "operationId": "GetNLB", @@ -3401,7 +3402,7 @@ "application/json" ], "tags": [ - "[Infra resource] NLB management" + "[Infra Resource] NLB Management" ], "summary": "Delete NLB", "operationId": "DelNLB", @@ -3456,7 +3457,7 @@ "application/json" ], "tags": [ - "[Infra resource] NLB management" + "[Infra Resource] NLB Management" ], "summary": "Get NLB Health", "operationId": "GetNLBHealth", @@ -3518,7 +3519,7 @@ "application/json" ], "tags": [ - "[Infra resource] NLB management (for developer)" + "[Infra Resource] NLB Management (for developer)" ], "summary": "Add VMs to NLB", "operationId": "AddNLBVMs", @@ -3587,7 +3588,7 @@ "application/json" ], "tags": [ - "[Infra resource] NLB management (for developer)" + "[Infra Resource] NLB Management (for developer)" ], "summary": "Delete VMs from NLB", "operationId": "RemoveNLBVMs", @@ -3652,7 +3653,7 @@ "application/json" ], "tags": [ - "[VPN] Sites in MCI" + "[Infra Resource] Network Management" ], "summary": "Get sites in MCI", "operationId": "GetSitesInMci", @@ -3712,7 +3713,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "List SubGroup IDs in a specified MCI", "operationId": "GetMciGroupIds", @@ -3766,7 +3767,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "List VMs with a SubGroup label in a specified MCI", "operationId": "GetMciGroupVms", @@ -3835,7 +3836,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "ScaleOut subGroup in specified MCI", "operationId": "PostMciSubGroupScaleOut", @@ -3906,7 +3907,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Create and add homogeneous VMs(subGroup) to a specified MCI (Set subGroupSize for multiple VMs)", "operationId": "PostMciVm", @@ -3969,7 +3970,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Remote command" + "[MC-Infra] MCI Remote Command" ], "summary": "Get bastion nodes for a VM", "operationId": "GetBastionNodes", @@ -4034,7 +4035,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Remote command" + "[MC-Infra] MCI Remote Command" ], "summary": "Set bastion nodes for a VM", "operationId": "SetBastionNodes", @@ -4104,7 +4105,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Get VM in specified MCI", "operationId": "GetMciVm", @@ -4193,7 +4194,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Delete VM in specified MCI", "operationId": "DelMciVm", @@ -4258,7 +4259,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "Get available dataDisks for a VM", "operationId": "GetVmDataDisk", @@ -4333,7 +4334,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "Attach/Detach available dataDisk", "operationId": "PutVmDataDisk", @@ -4422,7 +4423,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "Provisioning (Create and attach) dataDisk", "operationId": "PostVmDataDisk", @@ -4487,7 +4488,7 @@ "application/json" ], "tags": [ - "[Infra resource] Snapshot and Custom Image Management" + "[Infra Resource] Image Management" ], "summary": "Snapshot VM and create a Custom Image Object using the Snapshot", "operationId": "PostMciVmSnapshot", @@ -4558,7 +4559,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Create VM Dynamically and add it to MCI", "operationId": "PostMciVmDynamic", @@ -4621,7 +4622,7 @@ "application/json" ], "tags": [ - "[VPN] Site-to-site VPN (under development)" + "[Infra Resource] Site-to-site VPN Management (under development)" ], "summary": "Get resource info of a site-to-site VPN (Currently, GCP-AWS is supported)", "operationId": "GetSiteToSiteVpn", @@ -4696,7 +4697,7 @@ "application/json" ], "tags": [ - "[VPN] Site-to-site VPN (under development)" + "[Infra Resource] Site-to-site VPN Management (under development)" ], "summary": "Check the status of a specific request by its ID", "operationId": "GetRequestStatusOfSiteToSiteVpn", @@ -4771,7 +4772,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Create MCI Dynamically", "operationId": "PostMciDynamic", @@ -4841,7 +4842,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Resource monitor (for developer)" + "[MC-Infra] MCI Resource Monitor (for developer)" ], "summary": "Install monitoring agent (CB-Dragonfly agent) to MCI", "operationId": "PostInstallMonitorAgentToMci", @@ -4904,7 +4905,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Resource monitor (for developer)" + "[MC-Infra] MCI Resource Monitor (for developer)" ], "summary": "Get monitoring data of specified MCI for specified monitoring metric (cpu, memory, disk, network)", "operationId": "GetMonitorData", @@ -4965,7 +4966,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Resource monitor (for developer)" + "[MC-Infra] MCI Resource Monitor (for developer)" ], "summary": "Set monitoring agent (CB-Dragonfly agent) installation status installed (for Windows VM only)", "operationId": "PutMonitorAgentStatusInstalled", @@ -5027,7 +5028,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Auto control policy management (WIP)" + "[MC-Infra] MCI Orchestration Management (WIP)" ], "summary": "List all MCI policies", "operationId": "GetAllMciPolicy", @@ -5071,7 +5072,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Auto control policy management (WIP)" + "[MC-Infra] MCI Orchestration Management (WIP)" ], "summary": "Delete all MCI policies", "operationId": "DelAllMciPolicy", @@ -5111,7 +5112,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Auto control policy management (WIP)" + "[MC-Infra] MCI Orchestration Management (WIP)" ], "summary": "Get MCI Policy", "operationId": "GetMciPolicy", @@ -5163,7 +5164,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Auto control policy management (WIP)" + "[MC-Infra] MCI Orchestration Management (WIP)" ], "summary": "Create MCI Automation policy", "operationId": "PostMciPolicy", @@ -5224,7 +5225,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Auto control policy management (WIP)" + "[MC-Infra] MCI Orchestration Management (WIP)" ], "summary": "Delete MCI Policy", "operationId": "DelMciPolicy", @@ -5272,7 +5273,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Register existing VM in a CSP to Cloud-Barista MCI", "operationId": "PostRegisterCSPNativeVM", @@ -5327,7 +5328,7 @@ "application/json" ], "tags": [ - "[Infra resource] Snapshot and Custom Image Management" + "[Infra Resource] Image Management" ], "summary": "List all customImages or customImages' ID", "operationId": "GetAllCustomImage", @@ -5407,7 +5408,7 @@ "application/json" ], "tags": [ - "[Infra resource] Snapshot and Custom Image Management" + "[Infra Resource] Image Management" ], "summary": "Register existing Custom Image in a CSP", "operationId": "PostCustomImage", @@ -5470,7 +5471,7 @@ "application/json" ], "tags": [ - "[Infra resource] Snapshot and Custom Image Management" + "[Infra Resource] Image Management" ], "summary": "Delete all customImages", "operationId": "DelAllCustomImage", @@ -5517,7 +5518,7 @@ "application/json" ], "tags": [ - "[Infra resource] Snapshot and Custom Image Management" + "[Infra Resource] Image Management" ], "summary": "Get customImage", "operationId": "GetCustomImage", @@ -5568,7 +5569,7 @@ "application/json" ], "tags": [ - "[Infra resource] Snapshot and Custom Image Management" + "[Infra Resource] Image Management" ], "summary": "Delete customImage", "operationId": "DelCustomImage", @@ -5615,7 +5616,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "List all Data Disks or Data Disks' ID", "operationId": "GetAllDataDisk", @@ -5695,7 +5696,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "Create Data Disk", "operationId": "PostDataDisk", @@ -5757,7 +5758,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "Delete all Data Disks", "operationId": "DelAllDataDisk", @@ -5804,7 +5805,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "Get Data Disk", "operationId": "GetDataDisk", @@ -5855,7 +5856,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "Upsize Data Disk", "operationId": "PutDataDisk", @@ -5915,7 +5916,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Data Disk management" + "[Infra Resource] Data Disk Management" ], "summary": "Delete Data Disk", "operationId": "DelDataDisk", @@ -5962,7 +5963,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Image management" + "[Infra Resource] Image Management" ], "summary": "Fetch images", "operationId": "FetchImages", @@ -6008,7 +6009,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Spec management" + "[Infra Resource] Spec Management" ], "summary": "Fetch specs", "operationId": "FetchSpecs", @@ -6054,7 +6055,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Spec management" + "[Infra Resource] Spec Management" ], "summary": "Filter specs by range", "operationId": "FilterSpecsByRange", @@ -6108,7 +6109,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Image management" + "[Infra Resource] Image Management" ], "summary": "List all images or images' ID", "operationId": "GetAllImage", @@ -6188,7 +6189,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Image management" + "[Infra Resource] Image Management" ], "summary": "Register image", "operationId": "PostImage", @@ -6266,7 +6267,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Image management" + "[Infra Resource] Image Management" ], "summary": "Delete all images", "operationId": "DelAllImage", @@ -6313,7 +6314,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Image management" + "[Infra Resource] Image Management" ], "summary": "Get image", "operationId": "GetImage", @@ -6364,7 +6365,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Image management" + "[Infra Resource] Image Management" ], "summary": "Update image", "operationId": "PutImage", @@ -6424,7 +6425,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Image management" + "[Infra Resource] Image Management" ], "summary": "Delete image", "operationId": "DelImage", @@ -6471,7 +6472,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Image management" + "[Infra Resource] Image Management" ], "summary": "Search image", "operationId": "SearchImage", @@ -6526,7 +6527,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Security group management" + "[Infra Resource] Security Group Management" ], "summary": "List all Security Groups or Security Groups' ID", "operationId": "GetAllSecurityGroup", @@ -6606,7 +6607,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Security group management" + "[Infra Resource] Security Group Management" ], "summary": "Create Security Group", "operationId": "PostSecurityGroup", @@ -6668,7 +6669,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Security group management" + "[Infra Resource] Security Group Management" ], "summary": "Delete all Security Groups", "operationId": "DelAllSecurityGroup", @@ -6715,7 +6716,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Security group management" + "[Infra Resource] Security Group Management" ], "summary": "Get Security Group", "operationId": "GetSecurityGroup", @@ -6766,7 +6767,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Security group management" + "[Infra Resource] Security Group Management" ], "summary": "Delete Security Group", "operationId": "DelSecurityGroup", @@ -6813,7 +6814,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Security group management" + "[Infra Resource] Security Group Management" ], "summary": "Create FirewallRules", "operationId": "PostFirewallRules", @@ -6866,7 +6867,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Security group management" + "[Infra Resource] Security Group Management" ], "summary": "Delete FirewallRules", "operationId": "DelFirewallRules", @@ -6915,7 +6916,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Spec management" + "[Infra Resource] Spec Management" ], "summary": "Register spec", "operationId": "PostSpec", @@ -6995,7 +6996,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Spec management" + "[Infra Resource] Spec Management" ], "summary": "Get spec", "operationId": "GetSpec", @@ -7046,7 +7047,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Spec management" + "[Infra Resource] Spec Management" ], "summary": "Update spec", "operationId": "PutSpec", @@ -7106,7 +7107,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Spec management" + "[Infra Resource] Spec Management" ], "summary": "Delete spec", "operationId": "DelSpec", @@ -7153,7 +7154,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Access key management" + "[Infra Resource] Access Key Management" ], "summary": "List all SSH Keys or SSH Keys' ID", "operationId": "GetAllSshKey", @@ -7233,7 +7234,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Access key management" + "[Infra Resource] Access Key Management" ], "summary": "Create SSH Key", "operationId": "PostSshKey", @@ -7295,7 +7296,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Access key management" + "[Infra Resource] Access Key Management" ], "summary": "Delete all SSH Keys", "operationId": "DelAllSshKey", @@ -7342,7 +7343,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Access key management" + "[Infra Resource] Access Key Management" ], "summary": "Get SSH Key", "operationId": "GetSshKey", @@ -7393,7 +7394,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Access key management" + "[Infra Resource] Access Key Management" ], "summary": "Update SSH Key", "operationId": "PutSshKey", @@ -7453,7 +7454,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Access key management" + "[Infra Resource] Access Key Management" ], "summary": "Delete SSH Key", "operationId": "DelSshKey", @@ -7500,7 +7501,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Network management" + "[Infra Resource] Network Management" ], "summary": "List all VNets or VNets' ID", "operationId": "GetAllVNet", @@ -7580,7 +7581,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Network management" + "[Infra Resource] Network Management" ], "summary": "Create VNet", "operationId": "PostVNet", @@ -7642,7 +7643,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Network management" + "[Infra Resource] Network Management" ], "summary": "Delete all VNets", "operationId": "DelAllVNet", @@ -7689,7 +7690,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Network management" + "[Infra Resource] Network Management" ], "summary": "Get VNet", "operationId": "GetVNet", @@ -7740,7 +7741,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Network management" + "[Infra Resource] Network Management" ], "summary": "Delete VNet", "operationId": "DelVNet", @@ -7787,7 +7788,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Network management" + "[Infra Resource] Network Management" ], "summary": "Create Subnet", "operationId": "PostSubnet", @@ -7849,7 +7850,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Network management" + "[Infra Resource] Network Management" ], "summary": "Delete Subnet", "operationId": "DelSubnet", @@ -7903,7 +7904,7 @@ "application/json" ], "tags": [ - "[Infra resource] MCIR Common" + "[Infra Resource] Common Utility" ], "summary": "Delete all Default Resource Objects in the given namespace", "operationId": "DelAllSharedResources", @@ -7943,7 +7944,7 @@ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "Get value of an object", "operationId": "GetObject", @@ -7986,7 +7987,7 @@ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "Delete an object", "operationId": "DeleteObject", @@ -8031,7 +8032,7 @@ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "List all objects for a given key", "operationId": "GetObjects", @@ -8074,7 +8075,7 @@ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "Delete child objects along with the given object", "operationId": "DeleteObjects", @@ -8119,7 +8120,7 @@ "application/json" ], "tags": [ - "[Admin] Multi-Cloud environment configuration" + "[Admin] Multi-Cloud Information" ], "summary": "List all registered Providers", "operationId": "GetProviderList", @@ -8155,7 +8156,7 @@ "application/json" ], "tags": [ - "[Admin] Multi-Cloud environment configuration" + "[Admin] Multi-Cloud Information" ], "summary": "Get registered region info", "operationId": "GetRegion", @@ -8207,7 +8208,7 @@ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "Check Tumblebug is ready", "operationId": "GetReadyz", @@ -8237,7 +8238,7 @@ "application/json" ], "tags": [ - "[Admin] Multi-Cloud environment configuration" + "[Admin] Multi-Cloud Information" ], "summary": "List all registered regions", "operationId": "GetRegionList", @@ -8273,7 +8274,7 @@ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "Register CSP Native Resources (vNet, securityGroup, sshKey, vm) to CB-Tumblebug", "operationId": "RegisterCspNativeResources", @@ -8341,7 +8342,7 @@ "application/json" ], "tags": [ - "[Admin] System management" + "[Admin] System Management" ], "summary": "Register CSP Native Resources (vNet, securityGroup, sshKey, vm) from all Clouds to CB-Tumblebug", "operationId": "RegisterCspNativeResourcesAll", @@ -8409,7 +8410,7 @@ "application/json" ], "tags": [ - "[Admin] Request tracking" + "[Admin] API Request Management" ], "summary": "Get request details", "operationId": "GetRequest", @@ -8452,7 +8453,7 @@ "application/json" ], "tags": [ - "[Admin] Request tracking" + "[Admin] API Request Management" ], "summary": "Delete a specific request's details", "operationId": "DeleteRequest", @@ -8485,7 +8486,7 @@ "application/json" ], "tags": [ - "[Admin] Request tracking" + "[Admin] API Request Management" ], "summary": "Get all requests", "operationId": "GetAllRequests", @@ -8545,7 +8546,7 @@ "application/json" ], "tags": [ - "[Admin] Request tracking" + "[Admin] API Request Management" ], "summary": "Delete all requests' details", "operationId": "DeleteAllRequests", @@ -8569,7 +8570,7 @@ "application/x-json-stream" ], "tags": [ - "[VPN] Site-to-site VPN (under development)" + "[Infra Resource] Site-to-site VPN Management (under development)" ], "summary": "(To be provided) Update a site-to-site VPN", "operationId": "PutSiteToSiteVpn", @@ -8644,7 +8645,7 @@ "application/x-json-stream" ], "tags": [ - "[VPN] Site-to-site VPN (under development)" + "[Infra Resource] Site-to-site VPN Management (under development)" ], "summary": "Create a site-to-site VPN (Currently, GCP-AWS is supported)", "operationId": "PostSiteToSiteVpn", @@ -8719,7 +8720,7 @@ "application/x-json-stream" ], "tags": [ - "[VPN] Site-to-site VPN (under development)" + "[Infra Resource] Site-to-site VPN Management (under development)" ], "summary": "Delete a site-to-site VPN (Currently, GCP-AWS is supported)", "operationId": "DeleteSiteToSiteVpn", @@ -8787,7 +8788,7 @@ "application/json" ], "tags": [ - "[MC-Infra] MCI Provisioning management" + "[MC-Infra] MCI Provisioning and Management" ], "summary": "Create System MCI Dynamically for Special Purpose in NS:system", "operationId": "PostSystemMci", @@ -8834,7 +8835,7 @@ "application/json" ], "tags": [ - "[Utility] Multi-cloud network design" + "[Infra Resource] Network Management" ], "summary": "Design a multi-cloud network configuration", "operationId": "PostUtilToDesignNetwork", @@ -8881,7 +8882,7 @@ "application/json" ], "tags": [ - "[Utility] Multi-cloud network design" + "[Infra Resource] Network Management" ], "summary": "Validate a multi-cloud network configuration", "operationId": "PostUtilToValidateNetwork", diff --git a/src/api/rest/docs/swagger.yaml b/src/api/rest/docs/swagger.yaml index 20902eb81..20a8cfc1a 100644 --- a/src/api/rest/docs/swagger.yaml +++ b/src/api/rest/docs/swagger.yaml @@ -3235,6 +3235,7 @@ paths: consumes: - application/json description: Test JWT authentication + operationId: TestJWTAuth produces: - application/json responses: @@ -3250,7 +3251,7 @@ paths: - Bearer: [] summary: Test JWT authentication tags: - - '[Auth] Test JWT authentication' + - '[Admin] API Request Management' /availableK8sClusterNodeImage: get: consumes: @@ -3285,7 +3286,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get available kubernetes cluster node image tags: - - '[Infra resource] K8sCluster management' + - '[Kubernetes] Cluster Management' /availableK8sClusterVersion: get: consumes: @@ -3320,7 +3321,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get available kubernetes cluster version tags: - - '[Infra resource] K8sCluster management' + - '[Kubernetes] Cluster Management' /checkNodeGroupsOnK8sCreation: get: consumes: @@ -3350,7 +3351,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Check whether nodegroups are required during the k8scluster creation tags: - - '[Infra resource] K8sCluster management' + - '[Kubernetes] Cluster Management' /cloudInfo: get: consumes: @@ -3374,7 +3375,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get cloud information tags: - - '[Admin] Multi-Cloud environment configuration' + - '[Admin] Multi-Cloud Information' /config: delete: consumes: @@ -3394,7 +3395,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Init all configs tags: - - '[Admin] System environment' + - '[Admin] System Configuration' get: consumes: - application/json @@ -3417,7 +3418,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: List all configs tags: - - '[Admin] System environment' + - '[Admin] System Configuration' post: consumes: - application/json @@ -3448,7 +3449,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Create or Update config tags: - - '[Admin] System environment' + - '[Admin] System Configuration' /config/{configId}: delete: consumes: @@ -3478,7 +3479,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Init config tags: - - '[Admin] System environment' + - '[Admin] System Configuration' get: consumes: - application/json @@ -3507,7 +3508,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get config tags: - - '[Admin] System environment' + - '[Admin] System Configuration' /connConfig: get: consumes: @@ -3675,7 +3676,7 @@ paths: type: object summary: Forward any (GET) request to CB-Spider tags: - - '[Admin] System utility' + - '[Admin] API Request Management' /httpVersion: get: consumes: @@ -3700,7 +3701,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Check HTTP version of incoming request tags: - - '[Admin] System management' + - '[Admin] API Request Management' /inspectResources: post: consumes: @@ -3733,7 +3734,7 @@ paths: summary: Inspect Resources (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug, CB-Spider, CSP tags: - - '[Admin] System management' + - '[Admin] System Management' /inspectResourcesOverview: get: consumes: @@ -3759,7 +3760,7 @@ paths: summary: Inspect Resources Overview (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug and CSP for all connections tags: - - '[Admin] System management' + - '[Admin] System Management' /k8sClusterInfo: get: consumes: @@ -3783,7 +3784,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get kubernetes cluster information tags: - - '[Admin] Multi-Cloud environment configuration' + - '[Kubernetes] Cluster Management' /loadCommonResource: get: consumes: @@ -3803,7 +3804,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Load Common Resources from internal asset files tags: - - '[Admin] Multi-Cloud environment configuration' + - '[Admin] System Configuration' /lookupImage: post: consumes: @@ -3834,7 +3835,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Lookup image tags: - - '[Infra resource] MCIR Common' + - '[Infra Resource] Image Management' /lookupImages: post: consumes: @@ -3865,7 +3866,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Lookup image list tags: - - '[Infra resource] MCIR Common' + - '[Infra Resource] Image Management' /lookupSpec: post: consumes: @@ -3896,7 +3897,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Lookup spec tags: - - '[Infra resource] MCIR Common' + - '[Infra Resource] Spec Management' /lookupSpecs: post: consumes: @@ -3927,7 +3928,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Lookup spec list tags: - - '[Infra resource] MCIR Common' + - '[Infra Resource] Spec Management' /mciDynamicCheckRequest: post: consumes: @@ -3959,7 +3960,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Check available ConnectionConfig list for creating MCI Dynamically tags: - - '[MC-Infra] MCI Provisioning management' + - '[MC-Infra] MCI Provisioning and Management' /mciRecommendVm: post: consumes: @@ -3991,7 +3992,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Recommend MCI plan (filter and priority) tags: - - '[MC-Infra] MCI Provisioning management' + - '[MC-Infra] MCI Provisioning and Management' /ns: delete: consumes: @@ -4011,7 +4012,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete all namespaces tags: - - '[Namespace] Namespace management' + - '[Admin] System Configuration' get: consumes: - application/json @@ -4048,7 +4049,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: List all namespaces or namespaces' ID tags: - - '[Namespace] Namespace management' + - '[Admin] System Configuration' post: consumes: - application/json @@ -4078,7 +4079,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Create namespace tags: - - '[Namespace] Namespace management' + - '[Admin] System Configuration' /ns/{nsId}: delete: consumes: @@ -4105,7 +4106,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete namespace tags: - - '[Namespace] Namespace management' + - '[Admin] System Configuration' get: consumes: - application/json @@ -4135,7 +4136,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get namespace tags: - - '[Namespace] Namespace management' + - '[Admin] System Configuration' put: consumes: - application/json @@ -4171,7 +4172,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Update namespace tags: - - '[Namespace] Namespace management' + - '[Admin] System Configuration' /ns/{nsId}/benchmark/mci/{mciId}: post: consumes: @@ -4233,7 +4234,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Run MCI benchmark for a single performance metric and return results tags: - - '[MC-Infra] MCI Performance benchmarking (WIP)' + - '[MC-Infra] MCI Performance Benchmarking (WIP)' /ns/{nsId}/benchmarkAll/mci/{mciId}: post: consumes: @@ -4276,7 +4277,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Run MCI benchmark for all performance metrics and return results tags: - - '[MC-Infra] MCI Performance benchmarking (WIP)' + - '[MC-Infra] MCI Performance Benchmarking (WIP)' /ns/{nsId}/benchmarkLatency/mci/{mciId}: get: consumes: @@ -4313,7 +4314,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Run MCI benchmark for network latency tags: - - '[MC-Infra] MCI Performance benchmarking (WIP)' + - '[MC-Infra] MCI Performance Benchmarking (WIP)' /ns/{nsId}/checkResource/{resourceType}/{resourceId}: get: consumes: @@ -4350,7 +4351,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Check resources' existence tags: - - '[Infra resource] MCIR Common' + - '[Infra Resource] Common Utility' /ns/{nsId}/cmd/mci/{mciId}: post: consumes: @@ -4407,7 +4408,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Send a command to specified MCI tags: - - '[MC-Infra] MCI Remote command' + - '[MC-Infra] MCI Remote Command' /ns/{nsId}/control/mci/{mciId}: get: consumes: @@ -4465,7 +4466,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Control the lifecycle of MCI (refine, suspend, resume, reboot, terminate) tags: - - '[MC-Infra] MCI Control lifecycle' + - '[MC-Infra] MCI Provisioning and Management' /ns/{nsId}/control/mci/{mciId}/vm/{vmId}: get: consumes: @@ -4525,7 +4526,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Control the lifecycle of VM (suspend, resume, reboot, terminate) tags: - - '[MC-Infra] MCI Control lifecycle' + - '[MC-Infra] MCI Provisioning and Management' /ns/{nsId}/installBenchmarkAgent/mci/{mciId}: post: consumes: @@ -4574,7 +4575,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Install the benchmark agent to specified MCI tags: - - '[MC-Infra] MCI Performance benchmarking (WIP)' + - '[MC-Infra] MCI Performance Benchmarking (WIP)' /ns/{nsId}/k8scluster: delete: consumes: @@ -4606,7 +4607,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete all K8sClusters tags: - - '[Infra resource] K8sCluster management' + - '[Kubernetes] Cluster Management' get: consumes: - application/json @@ -4657,7 +4658,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: List all K8sClusters or K8sClusters' ID tags: - - '[Infra resource] K8sCluster management' + - '[Kubernetes] Cluster Management' post: consumes: - application/json @@ -4700,7 +4701,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Create K8sCluster tags: - - '[Infra resource] K8sCluster management' + - '[Kubernetes] Cluster Management' /ns/{nsId}/k8scluster/{k8sClusterId}: delete: consumes: @@ -4733,7 +4734,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete K8sCluster tags: - - '[Infra resource] K8sCluster management' + - '[Kubernetes] Cluster Management' get: consumes: - application/json @@ -4769,7 +4770,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get K8sCluster tags: - - '[Infra resource] K8sCluster management' + - '[Kubernetes] Cluster Management' /ns/{nsId}/k8scluster/{k8sClusterId}/k8snodegroup: post: consumes: @@ -4812,7 +4813,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Add a K8sNodeGroup tags: - - '[Infra resource] K8sCluster management' + - '[Kubernetes] Cluster Management' /ns/{nsId}/k8scluster/{k8sClusterId}/k8snodegroup/{k8sNodeGroupName}: delete: consumes: @@ -4851,7 +4852,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Remove a K8sNodeGroup tags: - - '[Infra resource] K8sCluster management' + - '[Kubernetes] Cluster Management' /ns/{nsId}/k8scluster/{k8sClusterId}/k8snodegroup/{k8sNodeGroupName}/autoscalesize: put: consumes: @@ -4900,7 +4901,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Change a K8sNodeGroup's Autoscale Size tags: - - '[Infra resource] K8sCluster management' + - '[Kubernetes] Cluster Management' /ns/{nsId}/k8scluster/{k8sClusterId}/k8snodegroup/{k8sNodeGroupName}/onautoscaling: put: consumes: @@ -4949,7 +4950,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Set a K8sNodeGroup's Autoscaling On/Off tags: - - '[Infra resource] K8sCluster management' + - '[Kubernetes] Cluster Management' /ns/{nsId}/k8scluster/{k8sClusterId}/upgrade: put: consumes: @@ -4992,7 +4993,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Upgrade a K8sCluster's version tags: - - '[Infra resource] K8sCluster management' + - '[Kubernetes] Cluster Management' /ns/{nsId}/loadSharedResource: get: consumes: @@ -5034,7 +5035,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Load Default Resource from internal asset file tags: - - '[Infra resource] MCIR Common' + - '[Infra Resource] Common Utility' /ns/{nsId}/mci: delete: consumes: @@ -5067,7 +5068,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete all MCIs tags: - - '[MC-Infra] MCI Provisioning management' + - '[MC-Infra] MCI Provisioning and Management' get: consumes: - application/json @@ -5116,7 +5117,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: List all MCIs or MCIs' ID tags: - - '[MC-Infra] MCI Provisioning management' + - '[MC-Infra] MCI Provisioning and Management' post: consumes: - application/json @@ -5152,7 +5153,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Create MCI tags: - - '[MC-Infra] MCI Provisioning management' + - '[MC-Infra] MCI Provisioning and Management' /ns/{nsId}/mci/{mciId}: delete: consumes: @@ -5192,7 +5193,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete MCI tags: - - '[MC-Infra] MCI Provisioning management' + - '[MC-Infra] MCI Provisioning and Management' get: consumes: - application/json @@ -5260,7 +5261,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: 'Get MCI object (option: status, accessInfo, vmId)' tags: - - '[MC-Infra] MCI Provisioning management' + - '[MC-Infra] MCI Provisioning and Management' /ns/{nsId}/mci/{mciId}/bastion/{bastionVmId}: delete: consumes: @@ -5303,7 +5304,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Remove a bastion VM from all vNets tags: - - '[MC-Infra] MCI Remote command' + - '[MC-Infra] MCI Remote Command' /ns/{nsId}/mci/{mciId}/mcSwNlb: post: consumes: @@ -5347,7 +5348,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Create a special purpose MCI for NLB and depoly and setting SW NLB tags: - - '[Infra resource] NLB management' + - '[Infra Resource] NLB Management' /ns/{nsId}/mci/{mciId}/nlb: delete: consumes: @@ -5385,7 +5386,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete all NLBs tags: - - '[Infra resource] NLB management' + - '[Infra Resource] NLB Management' get: consumes: - application/json @@ -5442,7 +5443,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: List all NLBs or NLBs' ID tags: - - '[Infra resource] NLB management' + - '[Infra Resource] NLB Management' post: consumes: - application/json @@ -5491,7 +5492,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Create NLB tags: - - '[Infra resource] NLB management' + - '[Infra Resource] NLB Management' /ns/{nsId}/mci/{mciId}/nlb/{nlbId}: delete: consumes: @@ -5529,7 +5530,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete NLB tags: - - '[Infra resource] NLB management' + - '[Infra Resource] NLB Management' get: consumes: - application/json @@ -5571,7 +5572,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get NLB tags: - - '[Infra resource] NLB management' + - '[Infra Resource] NLB Management' /ns/{nsId}/mci/{mciId}/nlb/{nlbId}/healthz: get: consumes: @@ -5614,7 +5615,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get NLB Health tags: - - '[Infra resource] NLB management' + - '[Infra Resource] NLB Management' /ns/{nsId}/mci/{mciId}/nlb/{nlbId}/vm: delete: consumes: @@ -5659,7 +5660,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete VMs from NLB tags: - - '[Infra resource] NLB management (for developer)' + - '[Infra Resource] NLB Management (for developer)' post: consumes: - application/json @@ -5707,7 +5708,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Add VMs to NLB tags: - - '[Infra resource] NLB management (for developer)' + - '[Infra Resource] NLB Management (for developer)' /ns/{nsId}/mci/{mciId}/site: get: consumes: @@ -5748,7 +5749,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get sites in MCI tags: - - '[VPN] Sites in MCI' + - '[Infra Resource] Network Management' /ns/{nsId}/mci/{mciId}/subgroup: get: consumes: @@ -5785,7 +5786,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: List SubGroup IDs in a specified MCI tags: - - '[MC-Infra] MCI Provisioning management' + - '[MC-Infra] MCI Provisioning and Management' /ns/{nsId}/mci/{mciId}/subgroup/{subgroupId}: get: consumes: @@ -5834,7 +5835,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: List VMs with a SubGroup label in a specified MCI tags: - - '[MC-Infra] MCI Provisioning management' + - '[MC-Infra] MCI Provisioning and Management' post: consumes: - application/json @@ -5882,7 +5883,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: ScaleOut subGroup in specified MCI tags: - - '[MC-Infra] MCI Provisioning management' + - '[MC-Infra] MCI Provisioning and Management' /ns/{nsId}/mci/{mciId}/vm: post: consumes: @@ -5927,7 +5928,7 @@ paths: summary: Create and add homogeneous VMs(subGroup) to a specified MCI (Set subGroupSize for multiple VMs) tags: - - '[MC-Infra] MCI Provisioning management' + - '[MC-Infra] MCI Provisioning and Management' /ns/{nsId}/mci/{mciId}/vm/{targetVmId}/bastion: get: consumes: @@ -5972,7 +5973,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get bastion nodes for a VM tags: - - '[MC-Infra] MCI Remote command' + - '[MC-Infra] MCI Remote Command' /ns/{nsId}/mci/{mciId}/vm/{targetVmId}/bastion/{bastionVmId}: put: consumes: @@ -6021,7 +6022,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Set bastion nodes for a VM tags: - - '[MC-Infra] MCI Remote command' + - '[MC-Infra] MCI Remote Command' /ns/{nsId}/mci/{mciId}/vm/{vmId}: delete: consumes: @@ -6066,7 +6067,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete VM in specified MCI tags: - - '[MC-Infra] MCI Provisioning management' + - '[MC-Infra] MCI Provisioning and Management' get: consumes: - application/json @@ -6125,7 +6126,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get VM in specified MCI tags: - - '[MC-Infra] MCI Provisioning management' + - '[MC-Infra] MCI Provisioning and Management' /ns/{nsId}/mci/{mciId}/vm/{vmId}/dataDisk: get: consumes: @@ -6175,7 +6176,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get available dataDisks for a VM tags: - - '[Infra resource] MCIR Data Disk management' + - '[Infra Resource] Data Disk Management' post: consumes: - application/json @@ -6219,7 +6220,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Provisioning (Create and attach) dataDisk tags: - - '[Infra resource] MCIR Data Disk management' + - '[Infra Resource] Data Disk Management' put: consumes: - application/json @@ -6281,7 +6282,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Attach/Detach available dataDisk tags: - - '[Infra resource] MCIR Data Disk management' + - '[Infra Resource] Data Disk Management' /ns/{nsId}/mci/{mciId}/vm/{vmId}/snapshot: post: consumes: @@ -6330,7 +6331,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Snapshot VM and create a Custom Image Object using the Snapshot tags: - - '[Infra resource] Snapshot and Custom Image Management' + - '[Infra Resource] Image Management' /ns/{nsId}/mci/{mciId}/vmDynamic: post: consumes: @@ -6373,7 +6374,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Create VM Dynamically and add it to MCI tags: - - '[MC-Infra] MCI Provisioning management' + - '[MC-Infra] MCI Provisioning and Management' /ns/{nsId}/mci/{mciId}/vpn/{vpnId}: get: consumes: @@ -6426,7 +6427,7 @@ paths: $ref: '#/definitions/model.Response' summary: Get resource info of a site-to-site VPN (Currently, GCP-AWS is supported) tags: - - '[VPN] Site-to-site VPN (under development)' + - '[Infra Resource] Site-to-site VPN Management (under development)' /ns/{nsId}/mci/{mciId}/vpn/{vpnId}/request/{requestId}: get: consumes: @@ -6478,7 +6479,7 @@ paths: $ref: '#/definitions/model.Response' summary: Check the status of a specific request by its ID tags: - - '[VPN] Site-to-site VPN (under development)' + - '[Infra Resource] Site-to-site VPN Management (under development)' /ns/{nsId}/mciDynamic: post: consumes: @@ -6529,7 +6530,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Create MCI Dynamically tags: - - '[MC-Infra] MCI Provisioning management' + - '[MC-Infra] MCI Provisioning and Management' /ns/{nsId}/monitoring/install/mci/{mciId}: post: consumes: @@ -6572,7 +6573,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Install monitoring agent (CB-Dragonfly agent) to MCI tags: - - '[MC-Infra] MCI Resource monitor (for developer)' + - '[MC-Infra] MCI Resource Monitor (for developer)' /ns/{nsId}/monitoring/mci/{mciId}/metric/{metric}: get: consumes: @@ -6616,7 +6617,7 @@ paths: summary: Get monitoring data of specified MCI for specified monitoring metric (cpu, memory, disk, network) tags: - - '[MC-Infra] MCI Resource monitor (for developer)' + - '[MC-Infra] MCI Resource Monitor (for developer)' /ns/{nsId}/monitoring/status/mci/{mciId}/vm/{vmId}: put: consumes: @@ -6661,7 +6662,7 @@ paths: summary: Set monitoring agent (CB-Dragonfly agent) installation status installed (for Windows VM only) tags: - - '[MC-Infra] MCI Resource monitor (for developer)' + - '[MC-Infra] MCI Resource Monitor (for developer)' /ns/{nsId}/policy/mci: delete: consumes: @@ -6688,7 +6689,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete all MCI policies tags: - - '[MC-Infra] MCI Auto control policy management (WIP)' + - '[MC-Infra] MCI Orchestration Management (WIP)' get: consumes: - application/json @@ -6718,7 +6719,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: List all MCI policies tags: - - '[MC-Infra] MCI Auto control policy management (WIP)' + - '[MC-Infra] MCI Orchestration Management (WIP)' /ns/{nsId}/policy/mci/{mciId}: delete: consumes: @@ -6751,7 +6752,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete MCI Policy tags: - - '[MC-Infra] MCI Auto control policy management (WIP)' + - '[MC-Infra] MCI Orchestration Management (WIP)' get: consumes: - application/json @@ -6787,7 +6788,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get MCI Policy tags: - - '[MC-Infra] MCI Auto control policy management (WIP)' + - '[MC-Infra] MCI Orchestration Management (WIP)' post: consumes: - application/json @@ -6829,7 +6830,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Create MCI Automation policy tags: - - '[MC-Infra] MCI Auto control policy management (WIP)' + - '[MC-Infra] MCI Orchestration Management (WIP)' /ns/{nsId}/registerCspVm: post: consumes: @@ -6866,7 +6867,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Register existing VM in a CSP to Cloud-Barista MCI tags: - - '[MC-Infra] MCI Provisioning management' + - '[MC-Infra] MCI Provisioning and Management' /ns/{nsId}/resources/customImage: delete: consumes: @@ -6898,7 +6899,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete all customImages tags: - - '[Infra resource] Snapshot and Custom Image Management' + - '[Infra Resource] Image Management' get: consumes: - application/json @@ -6949,7 +6950,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: List all customImages or customImages' ID tags: - - '[Infra resource] Snapshot and Custom Image Management' + - '[Infra Resource] Image Management' post: consumes: - application/json @@ -6992,7 +6993,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Register existing Custom Image in a CSP tags: - - '[Infra resource] Snapshot and Custom Image Management' + - '[Infra Resource] Image Management' /ns/{nsId}/resources/customImage/{customImageId}: delete: consumes: @@ -7024,7 +7025,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete customImage tags: - - '[Infra resource] Snapshot and Custom Image Management' + - '[Infra Resource] Image Management' get: consumes: - application/json @@ -7059,7 +7060,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get customImage tags: - - '[Infra resource] Snapshot and Custom Image Management' + - '[Infra Resource] Image Management' /ns/{nsId}/resources/dataDisk: delete: consumes: @@ -7091,7 +7092,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete all Data Disks tags: - - '[Infra resource] MCIR Data Disk management' + - '[Infra Resource] Data Disk Management' get: consumes: - application/json @@ -7142,7 +7143,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: List all Data Disks or Data Disks' ID tags: - - '[Infra resource] MCIR Data Disk management' + - '[Infra Resource] Data Disk Management' post: consumes: - application/json @@ -7184,7 +7185,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Create Data Disk tags: - - '[Infra resource] MCIR Data Disk management' + - '[Infra Resource] Data Disk Management' /ns/{nsId}/resources/dataDisk/{dataDiskId}: delete: consumes: @@ -7216,7 +7217,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete Data Disk tags: - - '[Infra resource] MCIR Data Disk management' + - '[Infra Resource] Data Disk Management' get: consumes: - application/json @@ -7251,7 +7252,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get Data Disk tags: - - '[Infra resource] MCIR Data Disk management' + - '[Infra Resource] Data Disk Management' put: consumes: - application/json @@ -7292,7 +7293,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Upsize Data Disk tags: - - '[Infra resource] MCIR Data Disk management' + - '[Infra Resource] Data Disk Management' /ns/{nsId}/resources/fetchImages: post: consumes: @@ -7323,7 +7324,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Fetch images tags: - - '[Infra resource] MCIR Image management' + - '[Infra Resource] Image Management' /ns/{nsId}/resources/fetchSpecs: post: consumes: @@ -7354,7 +7355,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Fetch specs tags: - - '[Infra resource] MCIR Spec management' + - '[Infra Resource] Spec Management' /ns/{nsId}/resources/filterSpecsByRange: post: consumes: @@ -7390,7 +7391,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Filter specs by range tags: - - '[Infra resource] MCIR Spec management' + - '[Infra Resource] Spec Management' /ns/{nsId}/resources/image: delete: consumes: @@ -7422,7 +7423,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete all images tags: - - '[Infra resource] MCIR Image management' + - '[Infra Resource] Image Management' get: consumes: - application/json @@ -7473,7 +7474,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: List all images or images' ID tags: - - '[Infra resource] MCIR Image management' + - '[Infra Resource] Image Management' post: consumes: - application/json @@ -7528,7 +7529,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Register image tags: - - '[Infra resource] MCIR Image management' + - '[Infra Resource] Image Management' /ns/{nsId}/resources/image/{imageId}: delete: consumes: @@ -7560,7 +7561,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete image tags: - - '[Infra resource] MCIR Image management' + - '[Infra Resource] Image Management' get: consumes: - application/json @@ -7595,7 +7596,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get image tags: - - '[Infra resource] MCIR Image management' + - '[Infra Resource] Image Management' put: consumes: - application/json @@ -7636,7 +7637,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Update image tags: - - '[Infra resource] MCIR Image management' + - '[Infra Resource] Image Management' /ns/{nsId}/resources/searchImage: post: consumes: @@ -7673,7 +7674,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Search image tags: - - '[Infra resource] MCIR Image management' + - '[Infra Resource] Image Management' /ns/{nsId}/resources/securityGroup: delete: consumes: @@ -7705,7 +7706,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete all Security Groups tags: - - '[Infra resource] MCIR Security group management' + - '[Infra Resource] Security Group Management' get: consumes: - application/json @@ -7756,7 +7757,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: List all Security Groups or Security Groups' ID tags: - - '[Infra resource] MCIR Security group management' + - '[Infra Resource] Security Group Management' post: consumes: - application/json @@ -7799,7 +7800,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Create Security Group tags: - - '[Infra resource] MCIR Security group management' + - '[Infra Resource] Security Group Management' /ns/{nsId}/resources/securityGroup/{securityGroupId}: delete: consumes: @@ -7831,7 +7832,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete Security Group tags: - - '[Infra resource] MCIR Security group management' + - '[Infra Resource] Security Group Management' get: consumes: - application/json @@ -7866,7 +7867,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get Security Group tags: - - '[Infra resource] MCIR Security group management' + - '[Infra Resource] Security Group Management' /ns/{nsId}/resources/securityGroup/{securityGroupId}/rules: delete: consumes: @@ -7899,7 +7900,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete FirewallRules tags: - - '[Infra resource] MCIR Security group management' + - '[Infra Resource] Security Group Management' post: consumes: - application/json @@ -7935,7 +7936,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Create FirewallRules tags: - - '[Infra resource] MCIR Security group management' + - '[Infra Resource] Security Group Management' /ns/{nsId}/resources/spec: post: consumes: @@ -7990,7 +7991,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Register spec tags: - - '[Infra resource] MCIR Spec management' + - '[Infra Resource] Spec Management' /ns/{nsId}/resources/spec/{specId}: delete: consumes: @@ -8022,7 +8023,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete spec tags: - - '[Infra resource] MCIR Spec management' + - '[Infra Resource] Spec Management' get: consumes: - application/json @@ -8057,7 +8058,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get spec tags: - - '[Infra resource] MCIR Spec management' + - '[Infra Resource] Spec Management' put: consumes: - application/json @@ -8098,7 +8099,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Update spec tags: - - '[Infra resource] MCIR Spec management' + - '[Infra Resource] Spec Management' /ns/{nsId}/resources/sshKey: delete: consumes: @@ -8130,7 +8131,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete all SSH Keys tags: - - '[Infra resource] MCIR Access key management' + - '[Infra Resource] Access Key Management' get: consumes: - application/json @@ -8181,7 +8182,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: List all SSH Keys or SSH Keys' ID tags: - - '[Infra resource] MCIR Access key management' + - '[Infra Resource] Access Key Management' post: consumes: - application/json @@ -8224,7 +8225,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Create SSH Key tags: - - '[Infra resource] MCIR Access key management' + - '[Infra Resource] Access Key Management' /ns/{nsId}/resources/sshKey/{sshKeyId}: delete: consumes: @@ -8256,7 +8257,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete SSH Key tags: - - '[Infra resource] MCIR Access key management' + - '[Infra Resource] Access Key Management' get: consumes: - application/json @@ -8291,7 +8292,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get SSH Key tags: - - '[Infra resource] MCIR Access key management' + - '[Infra Resource] Access Key Management' put: consumes: - application/json @@ -8332,7 +8333,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Update SSH Key tags: - - '[Infra resource] MCIR Access key management' + - '[Infra Resource] Access Key Management' /ns/{nsId}/resources/vNet: delete: consumes: @@ -8364,7 +8365,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete all VNets tags: - - '[Infra resource] MCIR Network management' + - '[Infra Resource] Network Management' get: consumes: - application/json @@ -8415,7 +8416,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: List all VNets or VNets' ID tags: - - '[Infra resource] MCIR Network management' + - '[Infra Resource] Network Management' post: consumes: - application/json @@ -8458,7 +8459,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Create VNet tags: - - '[Infra resource] MCIR Network management' + - '[Infra Resource] Network Management' /ns/{nsId}/resources/vNet/{vNetId}: delete: consumes: @@ -8490,7 +8491,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete VNet tags: - - '[Infra resource] MCIR Network management' + - '[Infra Resource] Network Management' get: consumes: - application/json @@ -8525,7 +8526,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get VNet tags: - - '[Infra resource] MCIR Network management' + - '[Infra Resource] Network Management' /ns/{nsId}/resources/vNet/{vNetId}/subnet: post: consumes: @@ -8567,7 +8568,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Create Subnet tags: - - '[Infra resource] MCIR Network management' + - '[Infra Resource] Network Management' /ns/{nsId}/resources/vNet/{vNetId}/subnet/{subnetId}: delete: consumes: @@ -8604,7 +8605,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete Subnet tags: - - '[Infra resource] MCIR Network management' + - '[Infra Resource] Network Management' /ns/{nsId}/sharedResources: delete: consumes: @@ -8631,7 +8632,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete all Default Resource Objects in the given namespace tags: - - '[Infra resource] MCIR Common' + - '[Infra Resource] Common Utility' /object: delete: consumes: @@ -8661,7 +8662,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete an object tags: - - '[Admin] System management' + - '[Admin] System Management' get: consumes: - application/json @@ -8690,7 +8691,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get value of an object tags: - - '[Admin] System management' + - '[Admin] System Management' /objects: delete: consumes: @@ -8720,7 +8721,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete child objects along with the given object tags: - - '[Admin] System management' + - '[Admin] System Management' get: consumes: - application/json @@ -8749,7 +8750,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: List all objects for a given key tags: - - '[Admin] System management' + - '[Admin] System Management' /provider: get: consumes: @@ -8773,7 +8774,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: List all registered Providers tags: - - '[Admin] Multi-Cloud environment configuration' + - '[Admin] Multi-Cloud Information' /provider/{providerName}/region/{regionName}: get: consumes: @@ -8808,7 +8809,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get registered region info tags: - - '[Admin] Multi-Cloud environment configuration' + - '[Admin] Multi-Cloud Information' /readyz: get: consumes: @@ -8828,7 +8829,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Check Tumblebug is ready tags: - - '[Admin] System management' + - '[Admin] System Management' /region: get: consumes: @@ -8852,7 +8853,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: List all registered regions tags: - - '[Admin] Multi-Cloud environment configuration' + - '[Admin] Multi-Cloud Information' /registerCspResources: post: consumes: @@ -8900,7 +8901,7 @@ paths: summary: Register CSP Native Resources (vNet, securityGroup, sshKey, vm) to CB-Tumblebug tags: - - '[Admin] System management' + - '[Admin] System Management' /registerCspResourcesAll: post: consumes: @@ -8948,7 +8949,7 @@ paths: summary: Register CSP Native Resources (vNet, securityGroup, sshKey, vm) from all Clouds to CB-Tumblebug tags: - - '[Admin] System management' + - '[Admin] System Management' /request/{reqId}: delete: consumes: @@ -8970,7 +8971,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete a specific request's details tags: - - '[Admin] Request tracking' + - '[Admin] API Request Management' get: consumes: - application/json @@ -8999,7 +9000,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Get request details tags: - - '[Admin] Request tracking' + - '[Admin] API Request Management' /requests: delete: consumes: @@ -9015,7 +9016,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete all requests' details tags: - - '[Admin] Request tracking' + - '[Admin] API Request Management' get: consumes: - application/json @@ -9055,7 +9056,7 @@ paths: type: object summary: Get all requests tags: - - '[Admin] Request tracking' + - '[Admin] API Request Management' /stream-response/ns/{nsId}/mci/{mciId}/vpn/{vpnId}: delete: consumes: @@ -9102,7 +9103,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Delete a site-to-site VPN (Currently, GCP-AWS is supported) tags: - - '[VPN] Site-to-site VPN (under development)' + - '[Infra Resource] Site-to-site VPN Management (under development)' post: consumes: - application/json @@ -9154,7 +9155,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Create a site-to-site VPN (Currently, GCP-AWS is supported) tags: - - '[VPN] Site-to-site VPN (under development)' + - '[Infra Resource] Site-to-site VPN Management (under development)' put: consumes: - application/json @@ -9206,7 +9207,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: (To be provided) Update a site-to-site VPN tags: - - '[VPN] Site-to-site VPN (under development)' + - '[Infra Resource] Site-to-site VPN Management (under development)' /systemMci: post: consumes: @@ -9237,7 +9238,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Create System MCI Dynamically for Special Purpose in NS:system tags: - - '[MC-Infra] MCI Provisioning management' + - '[MC-Infra] MCI Provisioning and Management' /util/net/design: post: consumes: @@ -9269,7 +9270,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Design a multi-cloud network configuration tags: - - '[Utility] Multi-cloud network design' + - '[Infra Resource] Network Management' /util/net/validate: post: consumes: @@ -9301,7 +9302,7 @@ paths: $ref: '#/definitions/common.SimpleMsg' summary: Validate a multi-cloud network configuration tags: - - '[Utility] Multi-cloud network design' + - '[Infra Resource] Network Management' securityDefinitions: BasicAuth: type: basic diff --git a/src/api/rest/server/auth/auth.go b/src/api/rest/server/auth/auth.go index 33cf9d9ae..4ee9a86c9 100644 --- a/src/api/rest/server/auth/auth.go +++ b/src/api/rest/server/auth/auth.go @@ -16,9 +16,10 @@ type AuthsInfo struct { } // TestJWTAuth godoc +// @ID TestJWTAuth // @Summary Test JWT authentication // @Description Test JWT authentication -// @Tags [Auth] Test JWT authentication +// @Tags [Admin] API Request Management // @Accept json // @Produce json // @Success 200 {object} AuthsInfo "Information of JWT authentication" diff --git a/src/api/rest/server/common/config.go b/src/api/rest/server/common/config.go index 8110cf217..cba800bdb 100644 --- a/src/api/rest/server/common/config.go +++ b/src/api/rest/server/common/config.go @@ -34,7 +34,7 @@ import ( // @ID InitConfig // @Summary Init config // @Description Init config -// @Tags [Admin] System environment +// @Tags [Admin] System Configuration // @Accept json // @Produce json // @Param configId path string true "Config ID" @@ -67,7 +67,7 @@ func RestInitConfig(c echo.Context) error { // @ID GetConfig // @Summary Get config // @Description Get config -// @Tags [Admin] System environment +// @Tags [Admin] System Configuration // @Accept json // @Produce json // @Param configId path string true "Config ID" @@ -104,7 +104,7 @@ type RestGetAllConfigResponse struct { // @ID GetAllConfig // @Summary List all configs // @Description List all configs -// @Tags [Admin] System environment +// @Tags [Admin] System Configuration // @Accept json // @Produce json // @Success 200 {object} RestGetAllConfigResponse @@ -127,7 +127,7 @@ func RestGetAllConfig(c echo.Context) error { // @ID PostConfig // @Summary Create or Update config // @Description Create or Update config (TB_SPIDER_REST_URL, TB_DRAGONFLY_REST_URL, ...) -// @Tags [Admin] System environment +// @Tags [Admin] System Configuration // @Accept json // @Produce json // @Param config body common.ConfigReq true "Key and Value for configuration" @@ -155,7 +155,7 @@ func RestPostConfig(c echo.Context) error { // @ID InitAllConfig // @Summary Init all configs // @Description Init all configs -// @Tags [Admin] System environment +// @Tags [Admin] System Configuration // @Accept json // @Produce json // @Success 200 {object} common.SimpleMsg @@ -176,7 +176,7 @@ func RestInitAllConfig(c echo.Context) error { // @ID GetRequest // @Summary Get request details // @Description Get details of a specific request -// @Tags [Admin] Request tracking +// @Tags [Admin] API Request Management // @Accept json // @Produce json // @Param reqId path string true "Request ID acquired from X-Request-ID header" @@ -198,7 +198,7 @@ func RestGetRequest(c echo.Context) error { // @ID GetAllRequests // @Summary Get all requests // @Description Get details of all requests with optional filters. -// @Tags [Admin] Request tracking +// @Tags [Admin] API Request Management // @Accept json // @Produce json // @Param status query string false "Filter by request status (Handling, Error, Success)" @@ -260,7 +260,7 @@ func RestGetAllRequests(c echo.Context) error { // @ID DeleteRequest // @Summary Delete a specific request's details // @Description Delete details of a specific request -// @Tags [Admin] Request tracking +// @Tags [Admin] API Request Management // @Accept json // @Produce json // @Param reqId path string true "Request ID to delete" @@ -281,7 +281,7 @@ func RestDeleteRequest(c echo.Context) error { // @ID DeleteAllRequests // @Summary Delete all requests' details // @Description Delete details of all requests -// @Tags [Admin] Request tracking +// @Tags [Admin] API Request Management // @Accept json // @Produce json // @Success 200 {object} SimpleMsg diff --git a/src/api/rest/server/common/namespace.go b/src/api/rest/server/common/namespace.go index 7961b2e27..429becf11 100644 --- a/src/api/rest/server/common/namespace.go +++ b/src/api/rest/server/common/namespace.go @@ -44,7 +44,7 @@ func RestCheckNs(c echo.Context) error { // @ID DelAllNs // @Summary Delete all namespaces // @Description Delete all namespaces -// @Tags [Namespace] Namespace management +// @Tags [Admin] System Configuration // @Accept json // @Produce json // @Success 200 {object} common.SimpleMsg @@ -64,7 +64,7 @@ func RestDelAllNs(c echo.Context) error { // @ID DelNs // @Summary Delete namespace // @Description Delete namespace -// @Tags [Namespace] Namespace management +// @Tags [Admin] System Configuration // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -102,7 +102,7 @@ type RestGetAllNsResponse struct { // @ID GetAllNs // @Summary List all namespaces or namespaces' ID // @Description List all namespaces or namespaces' ID -// @Tags [Namespace] Namespace management +// @Tags [Admin] System Configuration // @Accept json // @Produce json // @Param option query string false "Option" Enums(id) @@ -134,7 +134,7 @@ func RestGetAllNs(c echo.Context) error { // @ID GetNs // @Summary Get namespace // @Description Get namespace -// @Tags [Namespace] Namespace management +// @Tags [Admin] System Configuration // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -160,7 +160,7 @@ func RestGetNs(c echo.Context) error { // @ID PostNs // @Summary Create namespace // @Description Create namespace -// @Tags [Namespace] Namespace management +// @Tags [Admin] System Configuration // @Accept json // @Produce json // @Param nsReq body common.NsReq true "Details for a new namespace" @@ -187,7 +187,7 @@ func RestPostNs(c echo.Context) error { // @ID PutNs // @Summary Update namespace // @Description Update namespace -// @Tags [Namespace] Namespace management +// @Tags [Admin] System Configuration // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/common/utility.go b/src/api/rest/server/common/utility.go index 95af4c0d8..400e46ef7 100644 --- a/src/api/rest/server/common/utility.go +++ b/src/api/rest/server/common/utility.go @@ -76,7 +76,7 @@ func Validate(c echo.Context, params []string) error { // RestGetReadyz godoc // @Summary Check Tumblebug is ready // @Description Check Tumblebug is ready -// @Tags [Admin] System management +// @Tags [Admin] System Management // @Accept json // @Produce json // @Success 200 {object} common.SimpleMsg @@ -96,7 +96,7 @@ func RestGetReadyz(c echo.Context) error { // @ID CheckHTTPVersion // @Summary Check HTTP version of incoming request // @Description Checks and logs the HTTP version of the incoming request to the server console. -// @Tags [Admin] System management +// @Tags [Admin] API Request Management // @Accept json // @Produce json // @Success 200 {object} common.SimpleMsg @@ -229,7 +229,7 @@ func RestGetConnConfigList(c echo.Context) error { // @ID GetProviderList // @Summary List all registered Providers // @Description List all registered Providers -// @Tags [Admin] Multi-Cloud environment configuration +// @Tags [Admin] Multi-Cloud Information // @Accept json // @Produce json // @Success 200 {object} common.IdList @@ -251,7 +251,7 @@ func RestGetProviderList(c echo.Context) error { // @ID GetRegion // @Summary Get registered region info // @Description Get registered region info -// @Tags [Admin] Multi-Cloud environment configuration +// @Tags [Admin] Multi-Cloud Information // @Accept json // @Produce json // @Param providerName path string true "Name of the CSP to retrieve" @@ -278,7 +278,7 @@ func RestGetRegion(c echo.Context) error { // @ID GetRegionList // @Summary List all registered regions // @Description List all registered regions -// @Tags [Admin] Multi-Cloud environment configuration +// @Tags [Admin] Multi-Cloud Information // @Accept json // @Produce json // @Success 200 {object} common.RegionList @@ -300,7 +300,7 @@ func RestGetRegionList(c echo.Context) error { // @ID GetCloudInfo // @Summary Get cloud information // @Description Get cloud information -// @Tags [Admin] Multi-Cloud environment configuration +// @Tags [Admin] Multi-Cloud Information // @Accept json // @Produce json // @Success 200 {object} common.CloudInfo @@ -321,7 +321,7 @@ func RestGetCloudInfo(c echo.Context) error { // @ID GetK8sClusterInfo // @Summary Get kubernetes cluster information // @Description Get kubernetes cluster information -// @Tags [Admin] Multi-Cloud environment configuration +// @Tags [Kubernetes] Cluster Management // @Accept json // @Produce json // @Success 200 {object} common.K8sClusterInfo @@ -347,7 +347,7 @@ type ObjectList struct { // @ID GetObjects // @Summary List all objects for a given key // @Description List all objects for a given key -// @Tags [Admin] System management +// @Tags [Admin] System Management // @Accept json // @Produce json // @Param key query string true "retrieve objects by key" @@ -371,7 +371,7 @@ func RestGetObjects(c echo.Context) error { // @ID GetObject // @Summary Get value of an object // @Description Get value of an object -// @Tags [Admin] System management +// @Tags [Admin] System Management // @Accept json // @Produce json // @Param key query string true "get object value by key" @@ -399,7 +399,7 @@ func RestGetObject(c echo.Context) error { // @ID DeleteObject // @Summary Delete an object // @Description Delete an object -// @Tags [Admin] System management +// @Tags [Admin] System Management // @Accept json // @Produce json // @Param key query string true "delete object value by key" @@ -429,7 +429,7 @@ func RestDeleteObject(c echo.Context) error { // @ID DeleteObjects // @Summary Delete child objects along with the given object // @Description Delete child objects along with the given object -// @Tags [Admin] System management +// @Tags [Admin] System Management // @Accept json // @Produce json // @Param key query string true "Delete child objects based on the given key string" @@ -459,7 +459,7 @@ type RestInspectResourcesRequest struct { // @ID InspectResources // @Summary Inspect Resources (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug, CB-Spider, CSP // @Description Inspect Resources (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug, CB-Spider, CSP -// @Tags [Admin] System management +// @Tags [Admin] System Management // @Accept json // @Produce json // @Param connectionName body RestInspectResourcesRequest true "Specify connectionName and resource type" @@ -495,7 +495,7 @@ func RestInspectResources(c echo.Context) error { // @ID InspectResourcesOverview // @Summary Inspect Resources Overview (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug and CSP for all connections // @Description Inspect Resources Overview (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug and CSP for all connections -// @Tags [Admin] System management +// @Tags [Admin] System Management // @Accept json // @Produce json // @Success 200 {object} mci.InspectResourceAllResult @@ -522,7 +522,7 @@ type RestRegisterCspNativeResourcesRequest struct { // @ID RegisterCspNativeResources // @Summary Register CSP Native Resources (vNet, securityGroup, sshKey, vm) to CB-Tumblebug // @Description Register CSP Native Resources (vNet, securityGroup, sshKey, vm) to CB-Tumblebug -// @Tags [Admin] System management +// @Tags [Admin] System Management // @Accept json // @Produce json // @Param Request body RestRegisterCspNativeResourcesRequest true "Specify connectionName, NS Id, and MCI Name"" @@ -559,7 +559,7 @@ type RestRegisterCspNativeResourcesRequestAll struct { // @ID RegisterCspNativeResourcesAll // @Summary Register CSP Native Resources (vNet, securityGroup, sshKey, vm) from all Clouds to CB-Tumblebug // @Description Register CSP Native Resources (vNet, securityGroup, sshKey, vm) from all Clouds to CB-Tumblebug -// @Tags [Admin] System management +// @Tags [Admin] System Management // @Accept json // @Produce json // @Param Request body RestRegisterCspNativeResourcesRequestAll true "Specify NS Id and MCI Name" @@ -589,7 +589,7 @@ func RestRegisterCspNativeResourcesAll(c echo.Context) error { // @ID ForwardAnyReqToAny // @Summary Forward any (GET) request to CB-Spider // @Description Forward any (GET) request to CB-Spider -// @Tags [Admin] System utility +// @Tags [Admin] API Request Management // @Accept json // @Produce json // @Param path path string true "Internal call path to CB-Spider (path without /spider/ prefix) - see [https://documenter.getpostman.com/view/24786935/2s9Ykq8Lpf#231eec23-b0ab-4966-83ce-a0ef92ead7bc] for more details"" default(vmspec) diff --git a/src/api/rest/server/mci/benchmark.go b/src/api/rest/server/mci/benchmark.go index 3aa93e032..98b5eb176 100644 --- a/src/api/rest/server/mci/benchmark.go +++ b/src/api/rest/server/mci/benchmark.go @@ -26,7 +26,7 @@ import ( // @ID PostInstallBenchmarkAgentToMci // @Summary Install the benchmark agent to specified MCI // @Description Install the benchmark agent to specified MCI -// @Tags [MC-Infra] MCI Performance benchmarking (WIP) +// @Tags [MC-Infra] MCI Performance Benchmarking (WIP) // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -75,7 +75,7 @@ type RestGetAllBenchmarkRequest struct { // @ID GetAllBenchmark // @Summary Run MCI benchmark for all performance metrics and return results // @Description Run MCI benchmark for all performance metrics and return results -// @Tags [MC-Infra] MCI Performance benchmarking (WIP) +// @Tags [MC-Infra] MCI Performance Benchmarking (WIP) // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -107,7 +107,7 @@ func RestGetAllBenchmark(c echo.Context) error { // @ID GetLatencyBenchmark // @Summary Run MCI benchmark for network latency // @Description Run MCI benchmark for network latency -// @Tags [MC-Infra] MCI Performance benchmarking (WIP) +// @Tags [MC-Infra] MCI Performance Benchmarking (WIP) // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(system) @@ -136,7 +136,7 @@ type RestGetBenchmarkRequest struct { // @ID GetBenchmark // @Summary Run MCI benchmark for a single performance metric and return results // @Description Run MCI benchmark for a single performance metric and return results -// @Tags [MC-Infra] MCI Performance benchmarking (WIP) +// @Tags [MC-Infra] MCI Performance Benchmarking (WIP) // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mci/control.go b/src/api/rest/server/mci/control.go index 7ab478810..bd1477cdd 100644 --- a/src/api/rest/server/mci/control.go +++ b/src/api/rest/server/mci/control.go @@ -27,7 +27,7 @@ import ( // @ID GetControlMci // @Summary Control the lifecycle of MCI (refine, suspend, resume, reboot, terminate) // @Description Control the lifecycle of MCI (refine, suspend, resume, reboot, terminate) -// @Tags [MC-Infra] MCI Control lifecycle +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -73,7 +73,7 @@ func RestGetControlMci(c echo.Context) error { // @ID GetControlMciVm // @Summary Control the lifecycle of VM (suspend, resume, reboot, terminate) // @Description Control the lifecycle of VM (suspend, resume, reboot, terminate) -// @Tags [MC-Infra] MCI Control lifecycle +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -122,7 +122,7 @@ func RestGetControlMciVm(c echo.Context) error { // @ID PostMciVmSnapshot // @Summary Snapshot VM and create a Custom Image Object using the Snapshot // @Description Snapshot VM and create a Custom Image Object using the Snapshot -// @Tags [Infra resource] Snapshot and Custom Image Management +// @Tags [Infra Resource] Image Management // @Accept json // @Produce json // @Param vmSnapshotReq body mci.TbVmSnapshotReq true "Request body to create VM snapshot" diff --git a/src/api/rest/server/mci/k8scluster.go b/src/api/rest/server/mci/k8scluster.go index c73c00a78..c400cd4e0 100644 --- a/src/api/rest/server/mci/k8scluster.go +++ b/src/api/rest/server/mci/k8scluster.go @@ -28,7 +28,7 @@ import ( // @ID GetAvailableK8sClusterVersion // @Summary Get available kubernetes cluster version // @Description Get available kubernetes cluster version -// @Tags [Infra resource] K8sCluster management +// @Tags [Kubernetes] Cluster Management // @Accept json // @Produce json // @Param providerName query string true "Name of the CSP to retrieve" @@ -54,7 +54,7 @@ func RestGetAvailableK8sClusterVersion(c echo.Context) error { // @ID GetAvailableK8sClusterNodeImage // @Summary Get available kubernetes cluster node image // @Description Get available kubernetes cluster node image -// @Tags [Infra resource] K8sCluster management +// @Tags [Kubernetes] Cluster Management // @Accept json // @Produce json // @Param providerName query string true "Name of the CSP to retrieve" @@ -80,7 +80,7 @@ func RestGetAvailableK8sClusterNodeImage(c echo.Context) error { // @ID CheckNodeGroupsOnK8sCreation // @Summary Check whether nodegroups are required during the k8scluster creation // @Description Check whether nodegroups are required during the k8scluster creation -// @Tags [Infra resource] K8sCluster management +// @Tags [Kubernetes] Cluster Management // @Accept json // @Produce json // @Param providerName query string true "Name of the CSP to retrieve" @@ -104,7 +104,7 @@ func RestCheckNodeGroupsOnK8sCreation(c echo.Context) error { // @ID PostK8sCluster // @Summary Create K8sCluster // @Description Create K8sCluster
Find details from https://github.com/cloud-barista/cb-tumblebug/discussions/1614 -// @Tags [Infra resource] K8sCluster management +// @Tags [Kubernetes] Cluster Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -145,7 +145,7 @@ func RestPostK8sCluster(c echo.Context) error { // @ID PutK8sCluster // @Summary Update K8sCluster // @Description Update K8sCluster -// @Tags [Infra resource] K8sCluster management +// @Tags [Kubernetes] Cluster Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -167,7 +167,7 @@ func RestPutK8sCluster(c echo.Context) error { // @ID PostK8sNodeGroup // @Summary Add a K8sNodeGroup // @Description Add a K8sNodeGroup -// @Tags [Infra resource] K8sCluster management +// @Tags [Kubernetes] Cluster Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -205,7 +205,7 @@ func RestPostK8sNodeGroup(c echo.Context) error { // @ID DeleteK8sNodeGroup // @Summary Remove a K8sNodeGroup // @Description Remove a K8sNodeGroup -// @Tags [Infra resource] K8sCluster management +// @Tags [Kubernetes] Cluster Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -244,7 +244,7 @@ func RestDeleteK8sNodeGroup(c echo.Context) error { // @ID PutSetK8sNodeGroupAutoscaling // @Summary Set a K8sNodeGroup's Autoscaling On/Off // @Description Set a K8sNodeGroup's Autoscaling On/Off -// @Tags [Infra resource] K8sCluster management +// @Tags [Kubernetes] Cluster Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -284,7 +284,7 @@ func RestPutSetK8sNodeGroupAutoscaling(c echo.Context) error { // @ID PutChangeK8sNodeGroupAutoscaleSize // @Summary Change a K8sNodeGroup's Autoscale Size // @Description Change a K8sNodeGroup's Autoscale Size -// @Tags [Infra resource] K8sCluster management +// @Tags [Kubernetes] Cluster Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -324,7 +324,7 @@ func RestPutChangeK8sNodeGroupAutoscaleSize(c echo.Context) error { // @ID GetK8sCluster // @Summary Get K8sCluster // @Description Get K8sCluster -// @Tags [Infra resource] K8sCluster management +// @Tags [Kubernetes] Cluster Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -356,7 +356,7 @@ type RestGetAllK8sClusterResponse struct { // @ID GetAllK8sCluster // @Summary List all K8sClusters or K8sClusters' ID // @Description List all K8sClusters or K8sClusters' ID -// @Tags [Infra resource] K8sCluster management +// @Tags [Kubernetes] Cluster Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -407,7 +407,7 @@ func RestGetAllK8sCluster(c echo.Context) error { // @ID DeleteK8sCluster // @Summary Delete K8sCluster // @Description Delete K8sCluster -// @Tags [Infra resource] K8sCluster management +// @Tags [Kubernetes] Cluster Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -443,7 +443,7 @@ func RestDeleteK8sCluster(c echo.Context) error { // @ID DeleteAllK8sCluster // @Summary Delete all K8sClusters // @Description Delete all K8sClusters -// @Tags [Infra resource] K8sCluster management +// @Tags [Kubernetes] Cluster Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -473,7 +473,7 @@ func RestDeleteAllK8sCluster(c echo.Context) error { // @ID PutUpgradeK8sCluster // @Summary Upgrade a K8sCluster's version // @Description Upgrade a K8sCluster's version -// @Tags [Infra resource] K8sCluster management +// @Tags [Kubernetes] Cluster Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mci/manageInfo.go b/src/api/rest/server/mci/manageInfo.go index df31d5182..d17463ec2 100644 --- a/src/api/rest/server/mci/manageInfo.go +++ b/src/api/rest/server/mci/manageInfo.go @@ -38,7 +38,7 @@ type JSONResult struct { // @ID GetMci // @Summary Get MCI object (option: status, accessInfo, vmId) // @Description Get MCI object (option: status, accessInfo, vmId) -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -111,7 +111,7 @@ type RestGetAllMciStatusResponse struct { // @ID GetAllMci // @Summary List all MCIs or MCIs' ID // @Description List all MCIs or MCIs' ID -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -171,7 +171,7 @@ func RestGetAllMci(c echo.Context) error { // @ID PutMci // @Summary Update MCI // @Description Update MCI -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param mciInfo body TbMciInfo true "Details for an MCI object" @@ -188,7 +188,7 @@ func RestPutMci(c echo.Context) error { // @ID DelMci // @Summary Delete MCI // @Description Delete MCI -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -214,7 +214,7 @@ func RestDelMci(c echo.Context) error { // @ID DelAllMci // @Summary Delete all MCIs // @Description Delete all MCIs -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -241,7 +241,7 @@ func RestDelAllMci(c echo.Context) error { // @ID GetMciVm // @Summary Get VM in specified MCI // @Description Get VM in specified MCI -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -283,7 +283,7 @@ func RestGetMciVm(c echo.Context) error { // @ID PutSshKey // @Summary Update MCI // @Description Update MCI -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -303,7 +303,7 @@ func RestPutMciVm(c echo.Context) error { // @ID DelMciVm // @Summary Delete VM in specified MCI // @Description Delete VM in specified MCI -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -338,7 +338,7 @@ func RestDelMciVm(c echo.Context) error { // @ID GetMciGroupVms // @Summary List VMs with a SubGroup label in a specified MCI // @Description List VMs with a SubGroup label in a specified MCI -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -369,7 +369,7 @@ func RestGetMciGroupVms(c echo.Context) error { // @ID GetMciGroupIds // @Summary List SubGroup IDs in a specified MCI // @Description List SubGroup IDs in a specified MCI -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mci/monitoring.go b/src/api/rest/server/mci/monitoring.go index 610e75b48..10ed7b4ca 100644 --- a/src/api/rest/server/mci/monitoring.go +++ b/src/api/rest/server/mci/monitoring.go @@ -26,7 +26,7 @@ import ( // @ID PostInstallMonitorAgentToMci // @Summary Install monitoring agent (CB-Dragonfly agent) to MCI // @Description Install monitoring agent (CB-Dragonfly agent) to MCI -// @Tags [MC-Infra] MCI Resource monitor (for developer) +// @Tags [MC-Infra] MCI Resource Monitor (for developer) // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -57,7 +57,7 @@ func RestPostInstallMonitorAgentToMci(c echo.Context) error { // @ID PutMonitorAgentStatusInstalled // @Summary Set monitoring agent (CB-Dragonfly agent) installation status installed (for Windows VM only) // @Description Set monitoring agent (CB-Dragonfly agent) installation status installed (for Windows VM only) -// @Tags [MC-Infra] MCI Resource monitor (for developer) +// @Tags [MC-Infra] MCI Resource Monitor (for developer) // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -90,7 +90,7 @@ func RestPutMonitorAgentStatusInstalled(c echo.Context) error { // @ID GetMonitorData // @Summary Get monitoring data of specified MCI for specified monitoring metric (cpu, memory, disk, network) // @Description Get monitoring data of specified MCI for specified monitoring metric (cpu, memory, disk, network) -// @Tags [MC-Infra] MCI Resource monitor (for developer) +// @Tags [MC-Infra] MCI Resource Monitor (for developer) // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mci/network.go b/src/api/rest/server/mci/network.go index 195ec0419..06c115669 100644 --- a/src/api/rest/server/mci/network.go +++ b/src/api/rest/server/mci/network.go @@ -36,7 +36,7 @@ import ( // @ID GetSitesInMci // @Summary Get sites in MCI // @Description Get sites in MCI -// @Tags [VPN] Sites in MCI +// @Tags [Infra Resource] Network Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -211,7 +211,7 @@ func ExtractSitesInfoFromMciInfo(nsId, mciId string) (*model.SitesInfo, error) { // @ID PostSiteToSiteVpn // @Summary Create a site-to-site VPN (Currently, GCP-AWS is supported) // @Description Create a site-to-site VPN (Currently, GCP-AWS is supported) -// @Tags [VPN] Site-to-site VPN (under development) +// @Tags [Infra Resource] Site-to-site VPN Management (under development) // @Accept json // @Produce json-stream // @Param nsId path string true "Namespace ID" default(default) @@ -764,7 +764,7 @@ func whichCspSet(csp1, csp2 string) string { // @ID DeleteSiteToSiteVpn // @Summary Delete a site-to-site VPN (Currently, GCP-AWS is supported) // @Description Delete a site-to-site VPN (Currently, GCP-AWS is supported) -// @Tags [VPN] Site-to-site VPN (under development) +// @Tags [Infra Resource] Site-to-site VPN Management (under development) // @Accept json // @Produce json-stream // @Param nsId path string true "Namespace ID" default(default) @@ -1008,7 +1008,7 @@ func RestDeleteSiteToSiteVpn(c echo.Context) error { // @ID PutSiteToSiteVpn // @Summary (To be provided) Update a site-to-site VPN // @Description (To be provided) Update a site-to-site VPN -// @Tags [VPN] Site-to-site VPN (under development) +// @Tags [Infra Resource] Site-to-site VPN Management (under development) // @Accept json // @Produce json-stream // @Param nsId path string true "Namespace ID" default(default) @@ -1119,7 +1119,7 @@ func RestPutSiteToSiteVpn(c echo.Context) error { // @ID GetSiteToSiteVpn // @Summary Get resource info of a site-to-site VPN (Currently, GCP-AWS is supported) // @Description Get resource info of a site-to-site VPN (Currently, GCP-AWS is supported) -// @Tags [VPN] Site-to-site VPN (under development) +// @Tags [Infra Resource] Site-to-site VPN Management (under development) // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -1310,7 +1310,7 @@ func RestGetSiteToSiteVpn(c echo.Context) error { // @ID GetRequestStatusOfSiteToSiteVpn // @Summary Check the status of a specific request by its ID // @Description Check the status of a specific request by its ID -// @Tags [VPN] Site-to-site VPN (under development) +// @Tags [Infra Resource] Site-to-site VPN Management (under development) // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mci/nlb.go b/src/api/rest/server/mci/nlb.go index b0ccca9a5..c65bb6ae4 100644 --- a/src/api/rest/server/mci/nlb.go +++ b/src/api/rest/server/mci/nlb.go @@ -26,7 +26,7 @@ import ( // @ID PostNLB // @Summary Create NLB // @Description Create NLB -// @Tags [Infra resource] NLB management +// @Tags [Infra Resource] NLB Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -60,7 +60,7 @@ func RestPostNLB(c echo.Context) error { // @ID PostMcNLB // @Summary Create a special purpose MCI for NLB and depoly and setting SW NLB // @Description Create a special purpose MCI for NLB and depoly and setting SW NLB -// @Tags [Infra resource] NLB management +// @Tags [Infra Resource] NLB Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -94,7 +94,7 @@ func RestPostMcNLB(c echo.Context) error { // @ID PutNLB // @Summary Update NLB // @Description Update NLB -// @Tags [Infra resource] NLB management +// @Tags [Infra Resource] NLB Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -117,7 +117,7 @@ func RestPutNLB(c echo.Context) error { // @ID GetNLB // @Summary Get NLB // @Description Get NLB -// @Tags [Infra resource] NLB management +// @Tags [Infra Resource] NLB Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -149,7 +149,7 @@ type RestGetAllNLBResponse struct { // @ID GetAllNLB // @Summary List all NLBs or NLBs' ID // @Description List all NLBs or NLBs' ID -// @Tags [Infra resource] NLB management +// @Tags [Infra Resource] NLB Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -198,7 +198,7 @@ func RestGetAllNLB(c echo.Context) error { // @ID DelNLB // @Summary Delete NLB // @Description Delete NLB -// @Tags [Infra resource] NLB management +// @Tags [Infra Resource] NLB Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -227,7 +227,7 @@ func RestDelNLB(c echo.Context) error { // @ID DelAllNLB // @Summary Delete all NLBs // @Description Delete all NLBs -// @Tags [Infra resource] NLB management +// @Tags [Infra Resource] NLB Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -255,7 +255,7 @@ func RestDelAllNLB(c echo.Context) error { // @ID GetNLBHealth // @Summary Get NLB Health // @Description Get NLB Health -// @Tags [Infra resource] NLB management +// @Tags [Infra Resource] NLB Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -284,7 +284,7 @@ func RestGetNLBHealth(c echo.Context) error { // @ID AddNLBVMs // @Summary Add VMs to NLB // @Description Add VMs to NLB -// @Tags [Infra resource] NLB management (for developer) +// @Tags [Infra Resource] NLB Management (for developer) // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -316,7 +316,7 @@ func RestAddNLBVMs(c echo.Context) error { // @ID RemoveNLBVMs // @Summary Delete VMs from NLB // @Description Delete VMs from NLB -// @Tags [Infra resource] NLB management (for developer) +// @Tags [Infra Resource] NLB Management (for developer) // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mci/orchestration.go b/src/api/rest/server/mci/orchestration.go index 96ec0df45..c9f943977 100644 --- a/src/api/rest/server/mci/orchestration.go +++ b/src/api/rest/server/mci/orchestration.go @@ -28,7 +28,7 @@ import ( // @ID PostMciPolicy // @Summary Create MCI Automation policy // @Description Create MCI Automation policy -// @Tags [MC-Infra] MCI Auto control policy management (WIP) +// @Tags [MC-Infra] MCI Orchestration Management (WIP) // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -59,7 +59,7 @@ func RestPostMciPolicy(c echo.Context) error { // @ID GetMciPolicy // @Summary Get MCI Policy // @Description Get MCI Policy -// @Tags [MC-Infra] MCI Auto control policy management (WIP) +// @Tags [MC-Infra] MCI Orchestration Management (WIP) // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -99,7 +99,7 @@ type RestGetAllMciPolicyResponse struct { // @ID GetAllMciPolicy // @Summary List all MCI policies // @Description List all MCI policies -// @Tags [MC-Infra] MCI Auto control policy management (WIP) +// @Tags [MC-Infra] MCI Orchestration Management (WIP) // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -132,7 +132,7 @@ func RestGetAllMciPolicy(c echo.Context) error { // @ID PutMciPolicy // @Summary Update MCI Policy // @Description Update MCI Policy -// @Tags [MC-Infra] MCI Auto control policy management (WIP) +// @Tags [MC-Infra] MCI Orchestration Management (WIP) // @Accept json // @Produce json // @Param mciInfo body MciPolicyInfo true "Details for an MCI Policy object" @@ -149,7 +149,7 @@ func RestPutMciPolicy(c echo.Context) error { // @ID DelMciPolicy // @Summary Delete MCI Policy // @Description Delete MCI Policy -// @Tags [MC-Infra] MCI Auto control policy management (WIP) +// @Tags [MC-Infra] MCI Orchestration Management (WIP) // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -174,7 +174,7 @@ func RestDelMciPolicy(c echo.Context) error { // @ID DelAllMciPolicy // @Summary Delete all MCI policies // @Description Delete all MCI policies -// @Tags [MC-Infra] MCI Auto control policy management (WIP) +// @Tags [MC-Infra] MCI Orchestration Management (WIP) // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mci/provisioning.go b/src/api/rest/server/mci/provisioning.go index ceb9a89eb..b4863c94f 100644 --- a/src/api/rest/server/mci/provisioning.go +++ b/src/api/rest/server/mci/provisioning.go @@ -26,7 +26,7 @@ import ( // @ID PostMci // @Summary Create MCI // @Description Create MCI -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -56,7 +56,7 @@ func RestPostMci(c echo.Context) error { // @ID PostRegisterCSPNativeVM // @Summary Register existing VM in a CSP to Cloud-Barista MCI // @Description Register existing VM in a CSP to Cloud-Barista MCI -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -86,7 +86,7 @@ func RestPostRegisterCSPNativeVM(c echo.Context) error { // @ID PostSystemMci // @Summary Create System MCI Dynamically for Special Purpose in NS:system // @Description Create System MCI Dynamically for Special Purpose -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param option query string false "Option for the purpose of system MCI" Enums(probe) @@ -114,7 +114,7 @@ func RestPostSystemMci(c echo.Context) error { // @ID PostMciDynamic // @Summary Create MCI Dynamically // @Description Create MCI Dynamically from common spec and image -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -147,7 +147,7 @@ func RestPostMciDynamic(c echo.Context) error { // @ID PostMciVmDynamic // @Summary Create VM Dynamically and add it to MCI // @Description Create VM Dynamically and add it to MCI -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -178,7 +178,7 @@ func RestPostMciVmDynamic(c echo.Context) error { // @ID PostMciDynamicCheckRequest // @Summary Check available ConnectionConfig list for creating MCI Dynamically // @Description Check available ConnectionConfig list before create MCI Dynamically from common spec and image -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param mciReq body MciConnectionConfigCandidatesReq true "Details for MCI dynamic request information" @@ -204,7 +204,7 @@ func RestPostMciDynamicCheckRequest(c echo.Context) error { // @ID PostMciVm // @Summary Create and add homogeneous VMs(subGroup) to a specified MCI (Set subGroupSize for multiple VMs) // @Description Create and add homogeneous VMs(subGroup) to a specified MCI (Set subGroupSize for multiple VMs) -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -234,7 +234,7 @@ func RestPostMciVm(c echo.Context) error { // @ID PostMciSubGroupScaleOut // @Summary ScaleOut subGroup in specified MCI // @Description ScaleOut subGroup in specified MCI -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mci/recommendation.go b/src/api/rest/server/mci/recommendation.go index 35d11878e..c6663a442 100644 --- a/src/api/rest/server/mci/recommendation.go +++ b/src/api/rest/server/mci/recommendation.go @@ -26,7 +26,7 @@ import ( // @ID RecommendVm // @Summary Recommend MCI plan (filter and priority) // @Description Recommend MCI plan (filter and priority) Find details from https://github.com/cloud-barista/cb-tumblebug/discussions/1234 -// @Tags [MC-Infra] MCI Provisioning management +// @Tags [MC-Infra] MCI Provisioning and Management // @Accept json // @Produce json // @Param deploymentPlan body mci.DeploymentPlan false "Recommend MCI plan (filter and priority)" @@ -62,7 +62,7 @@ type RestPostMciRecommendResponse struct { // func RestPostMciRecommend(c echo.Context) error { // // @Summary Get MCI recommendation // // @Description Get MCI recommendation -// // @Tags [MC-Infra] MCI Provisioning management +// // @Tags [MC-Infra] MCI Provisioning and Management // // @Accept json // // @Produce json // // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mci/remoteCommand.go b/src/api/rest/server/mci/remoteCommand.go index fdcf9c8c3..7282df06a 100644 --- a/src/api/rest/server/mci/remoteCommand.go +++ b/src/api/rest/server/mci/remoteCommand.go @@ -26,7 +26,7 @@ import ( // @ID PostCmdMci // @Summary Send a command to specified MCI // @Description Send a command to specified MCI -// @Tags [MC-Infra] MCI Remote command +// @Tags [MC-Infra] MCI Remote Command // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -79,7 +79,7 @@ func RestPostCmdMci(c echo.Context) error { // @ID SetBastionNodes // @Summary Set bastion nodes for a VM // @Description Set bastion nodes for a VM -// @Tags [MC-Infra] MCI Remote command +// @Tags [MC-Infra] MCI Remote Command // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -108,7 +108,7 @@ func RestSetBastionNodes(c echo.Context) error { // @ID GetBastionNodes // @Summary Get bastion nodes for a VM // @Description Get bastion nodes for a VM -// @Tags [MC-Infra] MCI Remote command +// @Tags [MC-Infra] MCI Remote Command // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -135,7 +135,7 @@ func RestGetBastionNodes(c echo.Context) error { // @ID RemoveBastionNodes // @Summary Remove a bastion VM from all vNets // @Description Remove a bastion VM from all vNets -// @Tags [MC-Infra] MCI Remote command +// @Tags [MC-Infra] MCI Remote Command // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mcir/common.go b/src/api/rest/server/mcir/common.go index d91ecb650..65f32ad35 100644 --- a/src/api/rest/server/mcir/common.go +++ b/src/api/rest/server/mcir/common.go @@ -217,7 +217,7 @@ func RestGetResource(c echo.Context) error { // @ID CheckResource // @Summary Check resources' existence // @Description Check resources' existence -// @Tags [Infra resource] MCIR Common +// @Tags [Infra Resource] Common Utility // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -312,7 +312,7 @@ func RestTestGetAssociatedObjectCount(c echo.Context) error { // @ID LoadCommonResource // @Summary Load Common Resources from internal asset files // @Description Load Common Resources from internal asset files (Spec, Image) -// @Tags [Admin] Multi-Cloud environment configuration +// @Tags [Admin] System Configuration // @Accept json // @Produce json // @Success 200 {object} common.IdList @@ -331,7 +331,7 @@ func RestLoadCommonResource(c echo.Context) error { // @ID LoadSharedResource // @Summary Load Default Resource from internal asset file // @Description Load Default Resource from internal asset file -// @Tags [Infra resource] MCIR Common +// @Tags [Infra Resource] Common Utility // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -360,7 +360,7 @@ func RestLoadSharedResource(c echo.Context) error { // @ID DelAllSharedResources // @Summary Delete all Default Resource Objects in the given namespace // @Description Delete all Default Resource Objects in the given namespace -// @Tags [Infra resource] MCIR Common +// @Tags [Infra Resource] Common Utility // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mcir/customimage.go b/src/api/rest/server/mcir/customimage.go index e167355e2..0686151a9 100644 --- a/src/api/rest/server/mcir/customimage.go +++ b/src/api/rest/server/mcir/customimage.go @@ -27,7 +27,7 @@ import ( // @ID PostCustomImage // @Summary Register existing Custom Image in a CSP // @Description Register existing Custom Image in a CSP (option=register) -// @Tags [Infra resource] Snapshot and Custom Image Management +// @Tags [Infra Resource] Image Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -64,7 +64,7 @@ func RestPostCustomImage(c echo.Context) error { // @ID GetCustomImage // @Summary Get customImage // @Description Get customImage -// @Tags [Infra resource] Snapshot and Custom Image Management +// @Tags [Infra Resource] Image Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -87,7 +87,7 @@ type RestGetAllCustomImageResponse struct { // @ID GetAllCustomImage // @Summary List all customImages or customImages' ID // @Description List all customImages or customImages' ID -// @Tags [Infra resource] Snapshot and Custom Image Management +// @Tags [Infra Resource] Image Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -107,7 +107,7 @@ func RestGetAllCustomImage(c echo.Context) error { // @ID DelCustomImage // @Summary Delete customImage // @Description Delete customImage -// @Tags [Infra resource] Snapshot and Custom Image Management +// @Tags [Infra Resource] Image Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -124,7 +124,7 @@ func RestDelCustomImage(c echo.Context) error { // @ID DelAllCustomImage // @Summary Delete all customImages // @Description Delete all customImages -// @Tags [Infra resource] Snapshot and Custom Image Management +// @Tags [Infra Resource] Image Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mcir/dataDisk.go b/src/api/rest/server/mcir/dataDisk.go index 22763cc81..55273b391 100644 --- a/src/api/rest/server/mcir/dataDisk.go +++ b/src/api/rest/server/mcir/dataDisk.go @@ -29,7 +29,7 @@ import ( // @ID PostDataDisk // @Summary Create Data Disk // @Description Create Data Disk -// @Tags [Infra resource] MCIR Data Disk management +// @Tags [Infra Resource] Data Disk Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -62,7 +62,7 @@ func RestPostDataDisk(c echo.Context) error { // @ID PutDataDisk // @Summary Upsize Data Disk // @Description Upsize Data Disk -// @Tags [Infra resource] MCIR Data Disk management +// @Tags [Infra Resource] Data Disk Management // @Accept json // @Produce json // @Param dataDiskUpsizeReq body mcir.TbDataDiskUpsizeReq true "Request body to upsize the dataDisk" @@ -94,7 +94,7 @@ func RestPutDataDisk(c echo.Context) error { // @ID GetDataDisk // @Summary Get Data Disk // @Description Get Data Disk -// @Tags [Infra resource] MCIR Data Disk management +// @Tags [Infra Resource] Data Disk Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -117,7 +117,7 @@ type RestGetAllDataDiskResponse struct { // @ID GetAllDataDisk // @Summary List all Data Disks or Data Disks' ID // @Description List all Data Disks or Data Disks' ID -// @Tags [Infra resource] MCIR Data Disk management +// @Tags [Infra Resource] Data Disk Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -137,7 +137,7 @@ func RestGetAllDataDisk(c echo.Context) error { // @ID DelDataDisk // @Summary Delete Data Disk // @Description Delete Data Disk -// @Tags [Infra resource] MCIR Data Disk management +// @Tags [Infra Resource] Data Disk Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -154,7 +154,7 @@ func RestDelDataDisk(c echo.Context) error { // @ID DelAllDataDisk // @Summary Delete all Data Disks // @Description Delete all Data Disks -// @Tags [Infra resource] MCIR Data Disk management +// @Tags [Infra Resource] Data Disk Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -171,7 +171,7 @@ func RestDelAllDataDisk(c echo.Context) error { // @ID PutVmDataDisk // @Summary Attach/Detach available dataDisk // @Description Attach/Detach available dataDisk -// @Tags [Infra resource] MCIR Data Disk management +// @Tags [Infra Resource] Data Disk Management // @Accept json // @Produce json // @Param attachDetachDataDiskReq body mcir.TbAttachDetachDataDiskReq false "Request body to attach/detach dataDisk" @@ -226,7 +226,7 @@ func RestPutVmDataDisk(c echo.Context) error { // @ID PostVmDataDisk // @Summary Provisioning (Create and attach) dataDisk // @Description Provisioning (Create and attach) dataDisk -// @Tags [Infra resource] MCIR Data Disk management +// @Tags [Infra Resource] Data Disk Management // @Accept json // @Produce json // @Param dataDiskInfo body mcir.TbDataDiskVmReq true "Details for an Data Disk object" @@ -262,7 +262,7 @@ func RestPostVmDataDisk(c echo.Context) error { // @ID GetVmDataDisk // @Summary Get available dataDisks for a VM // @Description Get available dataDisks for a VM -// @Tags [Infra resource] MCIR Data Disk management +// @Tags [Infra Resource] Data Disk Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mcir/firewallrule.go b/src/api/rest/server/mcir/firewallrule.go index b276f8000..3ca342147 100644 --- a/src/api/rest/server/mcir/firewallrule.go +++ b/src/api/rest/server/mcir/firewallrule.go @@ -30,7 +30,7 @@ type TbFirewallRulesWrapper struct { // @ID PostFirewallRules // @Summary Create FirewallRules // @Description Create FirewallRules -// @Tags [Infra resource] MCIR Security group management +// @Tags [Infra Resource] Security Group Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -61,7 +61,7 @@ func RestPostFirewallRules(c echo.Context) error { // @ID PutFirewallRules // @Summary Update FirewallRules // @Description Update FirewallRules -// @Tags [Infra resource] MCIR Security group management +// @Tags [Infra Resource] Security Group Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -82,7 +82,7 @@ func RestPutFirewallRules(c echo.Context) error { // @ID GetFirewallRules // @Summary Get FirewallRules // @Description Get FirewallRules -// @Tags [Infra resource] MCIR Security group management +// @Tags [Infra Resource] Security Group Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -106,7 +106,7 @@ type RestGetAllFirewallRulesResponse struct { // @ID DelFirewallRules // @Summary Delete FirewallRules // @Description Delete FirewallRules -// @Tags [Infra resource] MCIR Security group management +// @Tags [Infra Resource] Security Group Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mcir/image.go b/src/api/rest/server/mcir/image.go index 0e5b15603..ce8c2ad68 100644 --- a/src/api/rest/server/mcir/image.go +++ b/src/api/rest/server/mcir/image.go @@ -30,7 +30,7 @@ import ( // @ID PostImage // @Summary Register image // @Description Register image -// @Tags [Infra resource] MCIR Image management +// @Tags [Infra Resource] Image Management // @Accept json // @Produce json // @Param action query string true "registeringMethod" Enums(registerWithInfo, registerWithId) @@ -91,7 +91,7 @@ func RestPostImage(c echo.Context) error { // @ID PutImage // @Summary Update image // @Description Update image -// @Tags [Infra resource] MCIR Image management +// @Tags [Infra Resource] Image Management // @Accept json // @Produce json // @Param imageInfo body mcir.TbImageInfo true "Details for an image object" @@ -130,7 +130,7 @@ type RestLookupImageRequest struct { // @ID LookupImage // @Summary Lookup image // @Description Lookup image -// @Tags [Infra resource] MCIR Common +// @Tags [Infra Resource] Image Management // @Accept json // @Produce json // @Param lookupImageReq body RestLookupImageRequest true "Specify connectionName & cspImageId" @@ -158,7 +158,7 @@ func RestLookupImage(c echo.Context) error { // @ID LookupImageList // @Summary Lookup image list // @Description Lookup image list -// @Tags [Infra resource] MCIR Common +// @Tags [Infra Resource] Image Management // @Accept json // @Produce json // @Param lookupImagesReq body common.TbConnectionName true "Specify connectionName" @@ -186,7 +186,7 @@ func RestLookupImageList(c echo.Context) error { // @ID FetchImages // @Summary Fetch images // @Description Fetch images -// @Tags [Infra resource] MCIR Image management +// @Tags [Infra Resource] Image Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -231,7 +231,7 @@ func RestFetchImages(c echo.Context) error { // @ID GetImage // @Summary Get image // @Description Get image -// @Tags [Infra resource] MCIR Image management +// @Tags [Infra Resource] Image Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -254,7 +254,7 @@ type RestGetAllImageResponse struct { // @ID GetAllImage // @Summary List all images or images' ID // @Description List all images or images' ID -// @Tags [Infra resource] MCIR Image management +// @Tags [Infra Resource] Image Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -274,7 +274,7 @@ func RestGetAllImage(c echo.Context) error { // @ID DelImage // @Summary Delete image // @Description Delete image -// @Tags [Infra resource] MCIR Image management +// @Tags [Infra Resource] Image Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -291,7 +291,7 @@ func RestDelImage(c echo.Context) error { // @ID DelAllImage // @Summary Delete all images // @Description Delete all images -// @Tags [Infra resource] MCIR Image management +// @Tags [Infra Resource] Image Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -313,7 +313,7 @@ type RestSearchImageRequest struct { // @ID SearchImage // @Summary Search image // @Description Search image -// @Tags [Infra resource] MCIR Image management +// @Tags [Infra Resource] Image Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mcir/securitygroup.go b/src/api/rest/server/mcir/securitygroup.go index 97ce08509..450e674b7 100644 --- a/src/api/rest/server/mcir/securitygroup.go +++ b/src/api/rest/server/mcir/securitygroup.go @@ -26,7 +26,7 @@ import ( // @ID PostSecurityGroup // @Summary Create Security Group // @Description Create Security Group -// @Tags [Infra resource] MCIR Security group management +// @Tags [Infra Resource] Security Group Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -61,7 +61,7 @@ func RestPostSecurityGroup(c echo.Context) error { // @ID PutSecurityGroup // @Summary Update Security Group // @Description Update Security Group -// @Tags [Infra resource] MCIR Security group management +// @Tags [Infra Resource] Security Group Management // @Accept json // @Produce json // @Param securityGroupInfo body mcir.TbSecurityGroupInfo true "Details for an securityGroup object" @@ -80,7 +80,7 @@ func RestPutSecurityGroup(c echo.Context) error { // @ID GetSecurityGroup // @Summary Get Security Group // @Description Get Security Group -// @Tags [Infra resource] MCIR Security group management +// @Tags [Infra Resource] Security Group Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -103,7 +103,7 @@ type RestGetAllSecurityGroupResponse struct { // @ID GetAllSecurityGroup // @Summary List all Security Groups or Security Groups' ID // @Description List all Security Groups or Security Groups' ID -// @Tags [Infra resource] MCIR Security group management +// @Tags [Infra Resource] Security Group Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -123,7 +123,7 @@ func RestGetAllSecurityGroup(c echo.Context) error { // @ID DelSecurityGroup // @Summary Delete Security Group // @Description Delete Security Group -// @Tags [Infra resource] MCIR Security group management +// @Tags [Infra Resource] Security Group Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -140,7 +140,7 @@ func RestDelSecurityGroup(c echo.Context) error { // @ID DelAllSecurityGroup // @Summary Delete all Security Groups // @Description Delete all Security Groups -// @Tags [Infra resource] MCIR Security group management +// @Tags [Infra Resource] Security Group Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mcir/spec.go b/src/api/rest/server/mcir/spec.go index d771ad661..7aaaad127 100644 --- a/src/api/rest/server/mcir/spec.go +++ b/src/api/rest/server/mcir/spec.go @@ -30,7 +30,7 @@ import ( // @ID PostSpec // @Summary Register spec // @Description Register spec -// @Tags [Infra resource] MCIR Spec management +// @Tags [Infra Resource] Spec Management // @Accept json // @Produce json // @Param action query string true "registeringMethod" Enums(registerWithInfo, registerWithCspSpecName) @@ -86,7 +86,7 @@ func RestPostSpec(c echo.Context) error { // @ID PutSpec // @Summary Update spec // @Description Update spec -// @Tags [Infra resource] MCIR Spec management +// @Tags [Infra Resource] Spec Management // @Accept json // @Produce json // @Param specInfo body mcir.TbSpecInfo true "Details for an spec object" @@ -125,7 +125,7 @@ type RestLookupSpecRequest struct { // @ID LookupSpec // @Summary Lookup spec // @Description Lookup spec -// @Tags [Infra resource] MCIR Common +// @Tags [Infra Resource] Spec Management // @Accept json // @Produce json // @Param lookupSpecReq body RestLookupSpecRequest true "Specify connectionName & cspSpecName" @@ -153,7 +153,7 @@ func RestLookupSpec(c echo.Context) error { // @ID LookupSpecList // @Summary Lookup spec list // @Description Lookup spec list -// @Tags [Infra resource] MCIR Common +// @Tags [Infra Resource] Spec Management // @Accept json // @Produce json // @Param lookupSpecsReq body common.TbConnectionName true "Specify connectionName" @@ -181,7 +181,7 @@ func RestLookupSpecList(c echo.Context) error { // @ID FetchSpecs // @Summary Fetch specs // @Description Fetch specs -// @Tags [Infra resource] MCIR Spec management +// @Tags [Infra Resource] Spec Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(system) @@ -231,7 +231,7 @@ type RestFilterSpecsResponse struct { // @ID FilterSpecsByRange // @Summary Filter specs by range // @Description Filter specs by range -// @Tags [Infra resource] MCIR Spec management +// @Tags [Infra Resource] Spec Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(system) @@ -263,7 +263,7 @@ func RestFilterSpecsByRange(c echo.Context) error { // @ID GetSpec // @Summary Get spec // @Description Get spec -// @Tags [Infra resource] MCIR Spec management +// @Tags [Infra Resource] Spec Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(system) @@ -292,7 +292,7 @@ func RestGetSpec(c echo.Context) error { // @ID DelSpec // @Summary Delete spec // @Description Delete spec -// @Tags [Infra resource] MCIR Spec management +// @Tags [Infra Resource] Spec Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(system) diff --git a/src/api/rest/server/mcir/sshkey.go b/src/api/rest/server/mcir/sshkey.go index 2137cffc4..3101cabc8 100644 --- a/src/api/rest/server/mcir/sshkey.go +++ b/src/api/rest/server/mcir/sshkey.go @@ -26,7 +26,7 @@ import ( // @ID PostSshKey // @Summary Create SSH Key // @Description Create SSH Key -// @Tags [Infra resource] MCIR Access key management +// @Tags [Infra Resource] Access Key Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -59,7 +59,7 @@ func RestPostSshKey(c echo.Context) error { // @ID PutSshKey // @Summary Update SSH Key // @Description Update SSH Key -// @Tags [Infra resource] MCIR Access key management +// @Tags [Infra Resource] Access Key Management // @Accept json // @Produce json // @Param sshKeyInfo body mcir.TbSshKeyInfo true "Details for an SSH Key object" @@ -90,7 +90,7 @@ func RestPutSshKey(c echo.Context) error { // @ID GetSshKey // @Summary Get SSH Key // @Description Get SSH Key -// @Tags [Infra resource] MCIR Access key management +// @Tags [Infra Resource] Access Key Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -113,7 +113,7 @@ type RestGetAllSshKeyResponse struct { // @ID GetAllSshKey // @Summary List all SSH Keys or SSH Keys' ID // @Description List all SSH Keys or SSH Keys' ID -// @Tags [Infra resource] MCIR Access key management +// @Tags [Infra Resource] Access Key Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -133,7 +133,7 @@ func RestGetAllSshKey(c echo.Context) error { // @ID DelSshKey // @Summary Delete SSH Key // @Description Delete SSH Key -// @Tags [Infra resource] MCIR Access key management +// @Tags [Infra Resource] Access Key Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -150,7 +150,7 @@ func RestDelSshKey(c echo.Context) error { // @ID DelAllSshKey // @Summary Delete all SSH Keys // @Description Delete all SSH Keys -// @Tags [Infra resource] MCIR Access key management +// @Tags [Infra Resource] Access Key Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mcir/subnet.go b/src/api/rest/server/mcir/subnet.go index 6923277a0..a4f9d560b 100644 --- a/src/api/rest/server/mcir/subnet.go +++ b/src/api/rest/server/mcir/subnet.go @@ -26,7 +26,7 @@ import ( // @ID PostSubnet // @Summary Create Subnet // @Description Create Subnet -// @Tags [Infra resource] MCIR Network management +// @Tags [Infra Resource] Network Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -58,7 +58,7 @@ func RestPostSubnet(c echo.Context) error { // @ID PutSubnet // @Summary Update Subnet // @Description Update Subnet -// @Tags [Infra resource] MCIR Network management +// @Tags [Infra Resource] Network Management // @Accept json // @Produce json // @Param subnetInfo body mcir.TbSubnetInfo true "Details for an Subnet object" @@ -78,7 +78,7 @@ func RestPutSubnet(c echo.Context) error { // @ID GetSubnet // @Summary Get Subnet // @Description Get Subnet -// @Tags [Infra resource] MCIR Network management +// @Tags [Infra Resource] Network Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -101,7 +101,7 @@ type RestGetAllSubnetResponse struct { // @ID GetAllSubnet // @Summary List all Subnets or Subnets' ID // @Description List all Subnets or Subnets' ID -// @Tags [Infra resource] MCIR Network management +// @Tags [Infra Resource] Network Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -120,7 +120,7 @@ func RestGetAllSubnet(c echo.Context) error { // @ID DelSubnet // @Summary Delete Subnet // @Description Delete Subnet -// @Tags [Infra resource] MCIR Network management +// @Tags [Infra Resource] Network Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -139,7 +139,7 @@ func RestDelSubnet(c echo.Context) error { // @ID DelAllSubnet // @Summary Delete all Subnets // @Description Delete all Subnets -// @Tags [Infra resource] MCIR Network management +// @Tags [Infra Resource] Network Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/mcir/vnet.go b/src/api/rest/server/mcir/vnet.go index 7fb1ac867..f6e83d715 100644 --- a/src/api/rest/server/mcir/vnet.go +++ b/src/api/rest/server/mcir/vnet.go @@ -26,7 +26,7 @@ import ( // @ID PostVNet // @Summary Create VNet // @Description Create VNet -// @Tags [Infra resource] MCIR Network management +// @Tags [Infra Resource] Network Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -58,7 +58,7 @@ func RestPostVNet(c echo.Context) error { // @ID PutVNet // @Summary Update VNet // @Description Update VNet -// @Tags [Infra resource] MCIR Network management +// @Tags [Infra Resource] Network Management // @Accept json // @Produce json // @Param vNetInfo body mcir.TbVNetInfo true "Details for an VNet object" @@ -77,7 +77,7 @@ func RestPutVNet(c echo.Context) error { // @ID GetVNet // @Summary Get VNet // @Description Get VNet -// @Tags [Infra resource] MCIR Network management +// @Tags [Infra Resource] Network Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -100,7 +100,7 @@ type RestGetAllVNetResponse struct { // @ID GetAllVNet // @Summary List all VNets or VNets' ID // @Description List all VNets or VNets' ID -// @Tags [Infra resource] MCIR Network management +// @Tags [Infra Resource] Network Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -120,7 +120,7 @@ func RestGetAllVNet(c echo.Context) error { // @ID DelVNet // @Summary Delete VNet // @Description Delete VNet -// @Tags [Infra resource] MCIR Network management +// @Tags [Infra Resource] Network Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) @@ -137,7 +137,7 @@ func RestDelVNet(c echo.Context) error { // @ID DelAllVNet // @Summary Delete all VNets // @Description Delete all VNets -// @Tags [Infra resource] MCIR Network management +// @Tags [Infra Resource] Network Management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(default) diff --git a/src/api/rest/server/server.go b/src/api/rest/server/server.go index 0ea8f91b8..c47e591e1 100644 --- a/src/api/rest/server/server.go +++ b/src/api/rest/server/server.go @@ -231,7 +231,7 @@ func RunServer(port string) { e.POST("/tumblebug/registerCspResources", rest_common.RestRegisterCspNativeResources) e.POST("/tumblebug/registerCspResourcesAll", rest_common.RestRegisterCspNativeResourcesAll) - // @Tags [Admin] System environment + // @Tags [Admin] System Configuration e.POST("/tumblebug/config", rest_common.RestPostConfig) e.GET("/tumblebug/config/:configId", rest_common.RestGetConfig) e.GET("/tumblebug/config", rest_common.RestGetAllConfig) diff --git a/src/api/rest/server/util/netuil.go b/src/api/rest/server/util/netuil.go index 814239b6a..b73d55ec7 100644 --- a/src/api/rest/server/util/netuil.go +++ b/src/api/rest/server/util/netuil.go @@ -20,7 +20,7 @@ type RestPostUtilToDesignNetworkReponse struct { // @ID PostUtilToDesignNetwork // @Summary Design a multi-cloud network configuration // @Description Design a hierarchical network configuration of a VPC network or multi-cloud network consisting of multiple VPC networks -// @Tags [Utility] Multi-cloud network design +// @Tags [Infra Resource] Network Management // @Accept json // @Produce json // @Param subnettingReq body RestPostUtilToDesignNetworkRequest true "A root/main network CIDR block and subnetting rules" @@ -59,7 +59,7 @@ type RestPostUtilToValidateNetworkRequest struct { // @ID PostUtilToValidateNetwork // @Summary Validate a multi-cloud network configuration // @Description Validate a hierarchical configuration of a VPC network or multi-cloud network consisting of multiple VPC networks -// @Tags [Utility] Multi-cloud network design +// @Tags [Infra Resource] Network Management // @Accept json // @Produce json // @Param subnettingReq body RestPostUtilToValidateNetworkRequest true "A hierarchical network configuration"