Update API spec to reflect updated RegionZone info

cloud-barista · Dec 2, 2024 · 5b4b0f1 · 5b4b0f1
1 parent a381749
commit 5b4b0f1
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 6 deletions.
diff --git a/api/docs.go b/api/docs.go
@@ -9152,13 +9152,18 @@ const docTemplate = `{
         "spider.RegionZoneInfo": {
             "type": "object",
             "required": [
+                "CSPDisplayName",
                 "DisplayName",
                 "Name"
             ],
             "properties": {
+                "CSPDisplayName": {
+                    "type": "string",
+                    "example": "US East (N. Virginia)"
+                },
                 "DisplayName": {
                     "type": "string",
-                    "example": "US East"
+                    "example": "United States, Ohio"
                 },
                 "KeyValueList": {
                     "type": "array",
@@ -9697,14 +9702,19 @@ const docTemplate = `{
         "spider.ZoneInfo": {
             "type": "object",
             "required": [
+                "CSPDisplayName",
                 "DisplayName",
                 "Name",
                 "Status"
             ],
             "properties": {
+                "CSPDisplayName": {
+                    "type": "string",
+                    "example": "US East (N. Virginia)"
+                },
                 "DisplayName": {
                     "type": "string",
-                    "example": "US East 1A"
+                    "example": "United States, Ohio"
                 },
                 "KeyValueList": {
                     "type": "array",

diff --git a/api/swagger.json b/api/swagger.json
@@ -9149,13 +9149,18 @@
         "spider.RegionZoneInfo": {
             "type": "object",
             "required": [
+                "CSPDisplayName",
                 "DisplayName",
                 "Name"
             ],
             "properties": {
+                "CSPDisplayName": {
+                    "type": "string",
+                    "example": "US East (N. Virginia)"
+                },
                 "DisplayName": {
                     "type": "string",
-                    "example": "US East"
+                    "example": "United States, Ohio"
                 },
                 "KeyValueList": {
                     "type": "array",
@@ -9694,14 +9699,19 @@
         "spider.ZoneInfo": {
             "type": "object",
             "required": [
+                "CSPDisplayName",
                 "DisplayName",
                 "Name",
                 "Status"
             ],
             "properties": {
+                "CSPDisplayName": {
+                    "type": "string",
+                    "example": "US East (N. Virginia)"
+                },
                 "DisplayName": {
                     "type": "string",
-                    "example": "US East 1A"
+                    "example": "United States, Ohio"
                 },
                 "KeyValueList": {
                     "type": "array",

diff --git a/api/swagger.yaml b/api/swagger.yaml
@@ -822,8 +822,11 @@ definitions:
     type: object
   spider.RegionZoneInfo:
     properties:
+      CSPDisplayName:
+        example: US East (N. Virginia)
+        type: string
       DisplayName:
-        example: US East
+        example: United States, Ohio
         type: string
       KeyValueList:
         items:
@@ -837,6 +840,7 @@ definitions:
           $ref: '#/definitions/spider.ZoneInfo'
         type: array
     required:
+    - CSPDisplayName
     - DisplayName
     - Name
     type: object
@@ -1203,8 +1207,11 @@ definitions:
     type: object
   spider.ZoneInfo:
     properties:
+      CSPDisplayName:
+        example: US East (N. Virginia)
+        type: string
       DisplayName:
-        example: US East 1A
+        example: United States, Ohio
         type: string
       KeyValueList:
         items:
@@ -1218,6 +1225,7 @@ definitions:
         - $ref: '#/definitions/spider.ZoneStatus'
         example: Available
     required:
+    - CSPDisplayName
     - DisplayName
     - Name
     - Status