BoxesResponse: Fold names into top-level object (#4249)

algorand · Jul 12, 2022 · 34312c8 · 34312c8
1 parent 57c7058
commit 34312c8
Show file tree

Hide file tree

Showing 8 changed files with 452 additions and 382 deletions.
diff --git a/daemon/algod/api/algod.oas2.json b/daemon/algod/api/algod.oas2.json
@@ -2565,6 +2565,20 @@
         }
       }
     },
+    "BoxDescriptor": {
+      "description": "Box descriptor describes a Box.",
+      "type": "object",
+      "required": [
+        "name"
+      ],
+      "properties": {
+        "name": {
+          "description": "Base64 encoded box name",
+          "type": "string",
+          "format": "byte"
+        }
+      }
+    },
     "Version": {
       "description": "algod version information.",
       "type": "object",
@@ -3259,10 +3273,17 @@
     "BoxesResponse": {
       "description": "Box names of an application",
       "schema": {
-        "type": "array",
-        "items": {
-          "type": "string",
-          "format": "byte"
+        "type": "object",
+        "required": [
+          "boxes"
+        ],
+        "properties": {
+          "boxes": {
+            "type": "array",
+            "items": {
+              "$ref": "#/definitions/BoxDescriptor"
+            }
+          }
         }
       }
     },

diff --git a/daemon/algod/api/algod.oas3.yml b/daemon/algod/api/algod.oas3.yml
@@ -344,12 +344,18 @@
         "content": {
           "application/json": {
             "schema": {
-              "items": {
-                "format": "byte",
-                "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
-                "type": "string"
+              "properties": {
+                "boxes": {
+                  "items": {
+                    "$ref": "#/components/schemas/BoxDescriptor"
+                  },
+                  "type": "array"
+                }
               },
-              "type": "array"
+              "required": [
+                "boxes"
+              ],
+              "type": "object"
             }
           }
         },
@@ -1208,6 +1214,21 @@
         ],
         "type": "object"
       },
+      "BoxDescriptor": {
+        "description": "Box descriptor describes a Box.",
+        "properties": {
+          "name": {
+            "description": "Base64 encoded box name",
+            "format": "byte",
+            "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+            "type": "string"
+          }
+        },
+        "required": [
+          "name"
+        ],
+        "type": "object"
+      },
       "BuildVersion": {
         "properties": {
           "branch": {
@@ -2535,12 +2556,18 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "items": {
-                    "format": "byte",
-                    "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
-                    "type": "string"
+                  "properties": {
+                    "boxes": {
+                      "items": {
+                        "$ref": "#/components/schemas/BoxDescriptor"
+                      },
+                      "type": "array"
+                    }
                   },
-                  "type": "array"
+                  "required": [
+                    "boxes"
+                  ],
+                  "type": "object"
                 }
               }
             },

diff --git a/daemon/algod/api/server/v2/generated/private/routes.go b/daemon/algod/api/server/v2/generated/private/routes.go
diff --git a/daemon/algod/api/server/v2/generated/private/types.go b/daemon/algod/api/server/v2/generated/private/types.go
diff --git a/daemon/algod/api/server/v2/generated/routes.go b/daemon/algod/api/server/v2/generated/routes.go
diff --git a/daemon/algod/api/server/v2/generated/types.go b/daemon/algod/api/server/v2/generated/types.go
diff --git a/daemon/algod/api/server/v2/handlers.go b/daemon/algod/api/server/v2/handlers.go
@@ -1164,11 +1164,13 @@ func (v2 *Handlers) GetApplicationBoxes(ctx echo.Context, applicationID uint64,
 	}
 
 	prefixLen := len(keyPrefix)
-	responseBoxes := make([][]byte, len(boxKeys))
+	responseBoxes := make([]generated.BoxDescriptor, len(boxKeys))
 	for i, boxKey := range boxKeys {
-		responseBoxes[i] = []byte(boxKey[prefixLen:])
+		responseBoxes[i] = generated.BoxDescriptor{
+			Name: []byte(boxKey[prefixLen:]),
+		}
 	}
-	response := generated.BoxesResponse(responseBoxes)
+	response := generated.BoxesResponse{Boxes: responseBoxes}
 	return ctx.JSON(http.StatusOK, response)
 }
 

diff --git a/test/e2e-go/restAPI/restClient_test.go b/test/e2e-go/restAPI/restClient_test.go
@@ -1417,9 +1417,9 @@ end:
 		var resp generated.BoxesResponse
 		resp, err = testClient.ApplicationBoxes(uint64(createdAppID))
 		a.NoError(err)
-		a.Equal(createdBoxCount, uint64(len(resp)))
-		for _, byteName := range resp {
-			a.True(createdBoxName[string(byteName)])
+		a.Equal(createdBoxCount, uint64(len(resp.Boxes)))
+		for _, b := range resp.Boxes {
+			a.True(createdBoxName[string(b.Name)])
 		}
 	}
 
@@ -1463,7 +1463,7 @@ end:
 
 	resp, err := testClient.ApplicationBoxes(uint64(createdAppID))
 	a.NoError(err)
-	a.Empty(resp)
+	a.Empty(resp.Boxes)
 
 	for i := 0; i < len(testingBoxNames); i += 16 {
 		var strSliceTest []string
@@ -1489,7 +1489,7 @@ end:
 
 	resp, err = testClient.ApplicationBoxes(uint64(createdAppID))
 	a.NoError(err)
-	a.Empty(resp)
+	a.Empty(resp.Boxes)
 
 	// Get Box value from box name
 	encodeInt := func(n uint64) []byte {