fix(storage): rename list request path to prefix (#11997)

fix(storage): list request would expose prefix instead of path Co-authored-by: Sridhar <[email protected]> Co-authored-by: Aaron S <[email protected]>
aws-amplify · Sep 11, 2023 · bc302ee · bc302ee
1 parent 54730e2
commit bc302ee
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/packages/storage/__tests__/providers/s3/apis/list.test.ts b/packages/storage/__tests__/providers/s3/apis/list.test.ts
@@ -125,7 +125,7 @@ describe('list API', () => {
 			expect.assertions(4);
 			const customPageSize = 5;
 			const response = await list({
-				path: 'listWithTokenResultsPath',
+				prefix: 'listWithTokenResultsPath',
 				options: {
 					accessLevel: 'guest',
 					pageSize: customPageSize,
@@ -148,7 +148,7 @@ describe('list API', () => {
 			mockListObjectsV2ApiWithPages(3);
 
 			const result = await list({
-				path: 'listALLResultsPath',
+				prefix: 'listALLResultsPath',
 				options: { accessLevel: 'guest', listAll: true },
 			});
 
@@ -185,7 +185,7 @@ describe('list API', () => {
 
 			expect.assertions(3);
 			let response = await list({
-				path: 'emptyListResultsPath',
+				prefix: 'emptyListResultsPath',
 				options: {
 					accessLevel: 'guest',
 				},

diff --git a/packages/storage/src/providers/s3/apis/internal/list.ts b/packages/storage/src/providers/s3/apis/internal/list.ts
@@ -34,7 +34,7 @@ export const list = async (
 		| StorageListRequest<StorageListAllOptions>
 		| StorageListRequest<StorageListPaginateOptions>
 ): Promise<S3ListAllResult | S3ListPaginateResult> => {
-	const { options = {}, path = '' } = listRequest ?? {};
+	const { options = {}, prefix: path = '' } = listRequest ?? {};
 	const {
 		s3Config,
 		bucket,

diff --git a/packages/storage/src/types/requests.ts b/packages/storage/src/types/requests.ts
@@ -18,7 +18,7 @@ export type StorageOperationRequest<Options extends StorageOptions> = {
 export type StorageListRequest<
 	Options extends StorageListAllOptions | StorageListPaginateOptions
 > = {
-	path?: string;
+	prefix?: string;
 	options?: Options;
 };