Merge pull request #36 from G4brym/fix-bucket-pagination-api

Fix list object endpoint limit parameter
G4brym · Sep 17, 2023 · 848eca8 · 848eca8
2 parents c578c92 + da58628
commit 848eca8
Show file tree

Hide file tree

Showing 13 changed files with 40 additions and 19 deletions.
diff --git a/packages/dashboard/src/api.js b/packages/dashboard/src/api.js
@@ -119,6 +119,7 @@ const apiHandler = {
       params: {
         delimiter: '/',
         prefix: encodeKey(prefix)
+        // limit: 1000  TODO: only use this parameter on 1.0.3 or above
       }
     })
 

diff --git a/worker/package-lock.json b/worker/package-lock.json
diff --git a/worker/package.json b/worker/package.json
@@ -95,7 +95,7 @@
     "wrangler": "^3.6.0"
   },
   "dependencies": {
-    "@cloudflare/itty-router-openapi": "^1.0.1",
+    "@cloudflare/itty-router-openapi": "^1.0.3",
     "postal-mime": "^1.0.16"
   },
   "bin": {

diff --git a/worker/src/buckets/api/createFolder.ts b/worker/src/buckets/api/createFolder.ts
@@ -12,7 +12,7 @@ export class CreateFolder extends OpenAPIRoute {
       bucket: Path(String),
     },
     requestBody: {
-      key: z.string().optional().describe('base64 encoded file key'),
+      key: z.string().describe('base64 encoded file key'),
     }
   }
 

diff --git a/worker/src/buckets/api/deleteObject.ts b/worker/src/buckets/api/deleteObject.ts
@@ -12,7 +12,7 @@ export class DeleteObject extends OpenAPIRoute {
       bucket: Path(String),
     },
     requestBody: {
-      key: z.string().optional().describe('base64 encoded file key'),
+      key: z.string().describe('base64 encoded file key'),
     }
   }
 

diff --git a/worker/src/buckets/api/getObject.ts b/worker/src/buckets/api/getObject.ts
@@ -10,7 +10,7 @@ export class GetObject extends OpenAPIRoute {
     summary: 'Get Object',
     parameters: {
       bucket: Path(String),
-      key: Path(z.string().optional().describe('base64 encoded file key')),
+      key: Path(z.string().describe('base64 encoded file key')),
     },
     responses: {
       '200': {

diff --git a/worker/src/buckets/api/headObject.ts b/worker/src/buckets/api/headObject.ts
@@ -10,7 +10,7 @@ export class HeadObject extends OpenAPIRoute {
     summary: 'Get Object',
     parameters: {
       bucket: Path(String),
-      key: Query(z.string().optional().describe('base64 encoded file key')),
+      key: Query(z.string().describe('base64 encoded file key')),
     },
   }
 

diff --git a/worker/src/buckets/api/listObjects.ts b/worker/src/buckets/api/listObjects.ts
@@ -1,4 +1,4 @@
-import {OpenAPIRoute, Path, Query} from "@cloudflare/itty-router-openapi";
+import { OpenAPIRoute, Path, Query } from "@cloudflare/itty-router-openapi";
 import {Context} from "../../interfaces";
 import {OpenAPIRouteSchema} from "@cloudflare/itty-router-openapi/dist/src/types";
 import {z} from 'zod'
@@ -10,7 +10,7 @@ export class ListObjects extends OpenAPIRoute {
     summary: 'List objects',
     parameters: {
       bucket: Path(String),
-      limit: Query(z.number().optional()),
+      limit: Query(Number, {required: false}),
       prefix: Query(z.string().optional().describe('base64 encoded prefix'),),
       cursor: Query(z.string().optional()),
       delimiter: Query(z.string().optional()),

diff --git a/worker/src/buckets/api/moveObject.ts b/worker/src/buckets/api/moveObject.ts
@@ -12,8 +12,8 @@ export class MoveObject extends OpenAPIRoute {
       bucket: Path(String),
     },
     requestBody: {
-      oldKey: z.string().optional().describe('base64 encoded file key'),
-      newKey: z.string().optional().describe('base64 encoded file key'),
+      oldKey: z.string().describe('base64 encoded file key'),
+      newKey: z.string().describe('base64 encoded file key'),
     }
   }
 

diff --git a/worker/src/buckets/api/multipart/completeUpload.ts b/worker/src/buckets/api/multipart/completeUpload.ts
@@ -13,7 +13,7 @@ export class CompleteUpload extends OpenAPIRoute {
     },
     requestBody: {
       uploadId: String,
-      key: z.string().optional().describe('base64 encoded file key'),
+      key: z.string().describe('base64 encoded file key'),
       parts: [{
         etag: String,
         partNumber: Int

diff --git a/worker/src/buckets/api/multipart/createUpload.ts b/worker/src/buckets/api/multipart/createUpload.ts
@@ -10,7 +10,7 @@ export class CreateUpload extends OpenAPIRoute {
     summary: 'Create upload',
     parameters: {
       bucket: Path(String),
-      key: Query(z.string().optional().describe('base64 encoded file key')),
+      key: Query(z.string().describe('base64 encoded file key')),
       customMetadata: Query(z.string().optional().describe('base64 encoded json string')),
       httpMetadata: Query(z.string().optional().describe('base64 encoded json string')),
     }

diff --git a/worker/src/buckets/api/multipart/partUpload.ts b/worker/src/buckets/api/multipart/partUpload.ts
@@ -1,4 +1,4 @@
-import {Int, OpenAPIRoute, Path, Query} from "@cloudflare/itty-router-openapi";
+import { Int, OpenAPIRoute, Path, Query, RequestBody } from "@cloudflare/itty-router-openapi";
 import {Context} from "../../../interfaces";
 import {OpenAPIRouteSchema} from "@cloudflare/itty-router-openapi/dist/src/types";
 import {z} from "zod";
@@ -8,9 +8,19 @@ export class PartUpload extends OpenAPIRoute {
     operationId: 'post-multipart-part-upload',
     tags: ['Multipart'],
     summary: 'Part upload',
+    requestBody: new RequestBody({
+        content: {
+            'application/octet-stream': {
+                schema: {
+                    type: 'string',
+                    format: 'binary',
+                },
+            },
+        },
+    }),
     parameters: {
       bucket: Path(String),
-      key: Query(z.string().optional().describe('base64 encoded file key')),
+      key: Query(z.string().describe('base64 encoded file key')),
       uploadId: Query(String),
       partNumber: Query(Int),
     }

diff --git a/worker/src/buckets/api/putObject.ts b/worker/src/buckets/api/putObject.ts
@@ -1,4 +1,4 @@
-import {OpenAPIRoute, Path, Query} from "@cloudflare/itty-router-openapi";
+import { OpenAPIRoute, Path, Query, RequestBody } from "@cloudflare/itty-router-openapi";
 import {Context} from "../../interfaces";
 import {OpenAPIRouteSchema} from "@cloudflare/itty-router-openapi/dist/src/types";
 import {z} from 'zod'
@@ -8,9 +8,19 @@ export class PutObject extends OpenAPIRoute {
     operationId: 'post-bucket-upload-object',
     tags: ['Buckets'],
     summary: 'Upload object',
+    requestBody: new RequestBody({
+        content: {
+            'application/octet-stream': {
+                schema: {
+                    type: 'string',
+                    format: 'binary',
+                },
+            },
+        },
+    }),
     parameters: {
       bucket: Path(String),
-      key: Query(z.string().optional().describe('base64 encoded file key')),
+      key: Query(z.string().describe('base64 encoded file key')),
       customMetadata: Query(z.string().optional().describe('base64 encoded json string')),
       httpMetadata: Query(z.string().optional().describe('base64 encoded json string')),
     },