Update Swagger Definition

cloud-barista · Dec 17, 2024 · 302adfb · 302adfb
1 parent 8888ed2
commit 302adfb
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 18 deletions.
diff --git a/api/docs.go b/api/docs.go
@@ -8340,22 +8340,22 @@ const docTemplate = `{
             ],
             "properties": {
                 "Count": {
-                    "description": "Number of GPUs",
+                    "description": "Number of GPUs, NA when not applicable",
                     "type": "string",
                     "example": "1"
                 },
                 "Mem": {
-                    "description": "Memory size of the GPU in MB",
+                    "description": "Memory size of the GPU in MB, NA when not applicable",
                     "type": "string",
                     "example": "8192"
                 },
                 "Mfr": {
-                    "description": "Manufacturer of the GPU",
+                    "description": "Manufacturer of the GPU, NA when not applicable",
                     "type": "string",
                     "example": "NVIDIA"
                 },
                 "Model": {
-                    "description": "Model of the GPU",
+                    "description": "Model of the GPU, NA when not applicable",
                     "type": "string",
                     "example": "Tesla K80"
                 }
@@ -9308,12 +9308,12 @@ const docTemplate = `{
             ],
             "properties": {
                 "Clock": {
-                    "description": "Clock speed in GHz",
+                    "description": "Clock speed in GHz, NA when not applicable",
                     "type": "string",
                     "example": "2.5"
                 },
                 "Count": {
-                    "description": "Number of CPU cores",
+                    "description": "Number of CPU cores, NA when not applicable",
                     "type": "string",
                     "example": "2"
                 }
@@ -9553,12 +9553,18 @@ const docTemplate = `{
         "spider.VMSpecInfo": {
             "type": "object",
             "required": [
+                "Disk",
                 "Mem",
                 "Name",
                 "Region",
                 "VCpu"
             ],
             "properties": {
+                "Disk": {
+                    "description": "Disk size in GB, NA when not applicable",
+                    "type": "string",
+                    "example": "8"
+                },
                 "Gpu": {
                     "description": "GPU details if available",
                     "type": "array",

diff --git a/api/swagger.json b/api/swagger.json
@@ -8337,22 +8337,22 @@
             ],
             "properties": {
                 "Count": {
-                    "description": "Number of GPUs",
+                    "description": "Number of GPUs, NA when not applicable",
                     "type": "string",
                     "example": "1"
                 },
                 "Mem": {
-                    "description": "Memory size of the GPU in MB",
+                    "description": "Memory size of the GPU in MB, NA when not applicable",
                     "type": "string",
                     "example": "8192"
                 },
                 "Mfr": {
-                    "description": "Manufacturer of the GPU",
+                    "description": "Manufacturer of the GPU, NA when not applicable",
                     "type": "string",
                     "example": "NVIDIA"
                 },
                 "Model": {
-                    "description": "Model of the GPU",
+                    "description": "Model of the GPU, NA when not applicable",
                     "type": "string",
                     "example": "Tesla K80"
                 }
@@ -9305,12 +9305,12 @@
             ],
             "properties": {
                 "Clock": {
-                    "description": "Clock speed in GHz",
+                    "description": "Clock speed in GHz, NA when not applicable",
                     "type": "string",
                     "example": "2.5"
                 },
                 "Count": {
-                    "description": "Number of CPU cores",
+                    "description": "Number of CPU cores, NA when not applicable",
                     "type": "string",
                     "example": "2"
                 }
@@ -9550,12 +9550,18 @@
         "spider.VMSpecInfo": {
             "type": "object",
             "required": [
+                "Disk",
                 "Mem",
                 "Name",
                 "Region",
                 "VCpu"
             ],
             "properties": {
+                "Disk": {
+                    "description": "Disk size in GB, NA when not applicable",
+                    "type": "string",
+                    "example": "8"
+                },
                 "Gpu": {
                     "description": "GPU details if available",
                     "type": "array",

diff --git a/api/swagger.yaml b/api/swagger.yaml
@@ -235,19 +235,19 @@ definitions:
   spider.GpuInfo:
     properties:
       Count:
-        description: Number of GPUs
+        description: Number of GPUs, NA when not applicable
         example: "1"
         type: string
       Mem:
-        description: Memory size of the GPU in MB
+        description: Memory size of the GPU in MB, NA when not applicable
         example: "8192"
         type: string
       Mfr:
-        description: Manufacturer of the GPU
+        description: Manufacturer of the GPU, NA when not applicable
         example: NVIDIA
         type: string
       Model:
-        description: Model of the GPU
+        description: Model of the GPU, NA when not applicable
         example: Tesla K80
         type: string
     required:
@@ -927,11 +927,11 @@ definitions:
   spider.VCpuInfo:
     properties:
       Clock:
-        description: Clock speed in GHz
+        description: Clock speed in GHz, NA when not applicable
         example: "2.5"
         type: string
       Count:
-        description: Number of CPU cores
+        description: Number of CPU cores, NA when not applicable
         example: "2"
         type: string
     required:
@@ -1101,6 +1101,10 @@ definitions:
     type: object
   spider.VMSpecInfo:
     properties:
+      Disk:
+        description: Disk size in GB, NA when not applicable
+        example: "8"
+        type: string
       Gpu:
         description: GPU details if available
         items:
@@ -1128,6 +1132,7 @@ definitions:
         - $ref: '#/definitions/spider.VCpuInfo'
         description: CPU details of the VM spec
     required:
+    - Disk
     - Mem
     - Name
     - Region