Merge pull request #13 from MZC-CSC/feature_20241030_update-perf-api

enhance estimate cost filtering feature etc
cloud-barista · Oct 30, 2024 · 05b44e6 · 05b44e6
2 parents 2eaaaa2 + 6358a9b
commit 05b44e6
Show file tree

Hide file tree

Showing 10 changed files with 465 additions and 105 deletions.
diff --git a/api/docs.go b/api/docs.go
diff --git a/api/swagger.json b/api/swagger.json
@@ -316,6 +316,53 @@
                 }
             }
         },
+        "/api/v1/cost/estimate/forecast/raw": {
+            "post": {
+                "description": "Update and retrieve raw forecasted cost estimates for specified cost resources and additional AWS information over the past 14 days.",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "[Cost Estimate]"
+                ],
+                "summary": "Update and Retrieve Raw Estimated Forecast Cost",
+                "operationId": "UpdateEstimateForecastCostRaw",
+                "parameters": [
+                    {
+                        "description": "Request body containing details for cost estimation forecast",
+                        "name": "body",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/app.UpdateEstimateForecastCostRawReq"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Successfully updated and retrieved raw estimated forecast cost information in raw data",
+                        "schema": {
+                            "$ref": "#/definitions/app.AntResponse-cost_UpdateEstimateForecastCostInfoResult"
+                        }
+                    },
+                    "400": {
+                        "description": "Migrated resource id list is required",
+                        "schema": {
+                            "$ref": "#/definitions/app.AntResponse-string"
+                        }
+                    },
+                    "500": {
+                        "description": "Error updating or retrieving forecast cost information",
+                        "schema": {
+                            "$ref": "#/definitions/app.AntResponse-string"
+                        }
+                    }
+                }
+            }
+        },
         "/api/v1/load/generators": {
             "get": {
                 "description": "Retrieve a list of all installed load generators with pagination support.",
@@ -1367,6 +1414,34 @@
                 }
             }
         },
+        "app.AwsAdditionalInfoReq": {
+            "type": "object",
+            "properties": {
+                "ownerId": {
+                    "type": "string"
+                },
+                "regions": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            }
+        },
+        "app.CostResourceReq": {
+            "type": "object",
+            "properties": {
+                "resourceIds": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "resourceType": {
+                    "$ref": "#/definitions/constant.ResourceType"
+                }
+            }
+        },
         "app.InstallLoadGeneratorReq": {
             "type": "object",
             "properties": {
@@ -1517,6 +1592,23 @@
                 }
             }
         },
+        "app.UpdateEstimateForecastCostRawReq": {
+            "type": "object",
+            "required": [
+                "costResources"
+            ],
+            "properties": {
+                "awsAdditionalInfo": {
+                    "$ref": "#/definitions/app.AwsAdditionalInfoReq"
+                },
+                "costResources": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/app.CostResourceReq"
+                    }
+                }
+            }
+        },
         "app.UpdateEstimateForecastCostReq": {
             "type": "object",
             "properties": {
@@ -1599,6 +1691,21 @@
                 "PerYear"
             ]
         },
+        "constant.ResourceType": {
+            "type": "string",
+            "enum": [
+                "VM",
+                "VNet",
+                "DataDisk",
+                "Etc"
+            ],
+            "x-enum-varnames": [
+                "VM",
+                "VNet",
+                "DataDisk",
+                "Etc"
+            ]
+        },
         "cost.EsimateCostSpecResults": {
             "type": "object",
             "properties": {
@@ -1701,17 +1808,11 @@
         "cost.EstimateCostResults": {
             "type": "object",
             "properties": {
-                "esimateForecastCostSpecResults": {
+                "esimateCostSpecResults": {
                     "type": "array",
                     "items": {
                         "$ref": "#/definitions/cost.EsimateCostSpecResults"
                     }
-                },
-                "totalMaxMonthlyPrice": {
-                    "type": "number"
-                },
-                "totalMinMonthlyPrice": {
-                    "type": "number"
                 }
             }
         },