Skip to content

Commit 12f5561

Browse files
committed
chore: update sdk docs
1 parent ab690c2 commit 12f5561

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

docs/sdks/tigris/client-uploads.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import { upload } from "@tigrisdata/storage/client";
2525

2626
`upload` accepts the following parameters:
2727

28-
- `path`: (Required) A string specifying the path to the object
28+
- `name`: (Required) A string specifying the name of the object
2929
- `body`: (Required) A blob object as File or Blob
3030
- `options`: (Optional) A JSON object with the following optional parameters:
3131

@@ -49,7 +49,7 @@ contains the following properties:
4949
- `contentDisposition`: content disposition of the object
5050
- `contentType`: content type of the object
5151
- `modified`: Last modified date of the object
52-
- `path`: Path to the object
52+
- `name`: Name of the object
5353
- `size`: Size of the object
5454
- `url`: A presigned URL to the object
5555

docs/sdks/tigris/examples.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -169,12 +169,12 @@ import {
169169

170170
export async function POST(request: NextRequest) {
171171
try {
172-
const { path, operation, action, contentType, uploadId, parts, partIds } =
172+
const { name, operation, action, contentType, uploadId, parts, partIds } =
173173
await request.json();
174174

175175
switch (action) {
176176
case UploadAction.MultipartInit: {
177-
const result = await initMultipartUpload(path, {});
177+
const result = await initMultipartUpload(name, {});
178178
return NextResponse.json({ data: result.data });
179179
}
180180

@@ -185,7 +185,7 @@ export async function POST(request: NextRequest) {
185185
{ status: 400 },
186186
);
187187
}
188-
const result = await getPartsPresignedUrls(path, parts, uploadId, {});
188+
const result = await getPartsPresignedUrls(name, parts, uploadId, {});
189189
return NextResponse.json({ data: result.data });
190190
}
191191

@@ -197,7 +197,7 @@ export async function POST(request: NextRequest) {
197197
{ status: 400 },
198198
);
199199
}
200-
const result = await completeMultipartUpload(path, uploadId, partIds);
200+
const result = await completeMultipartUpload(name, uploadId, partIds);
201201
return NextResponse.json({ data: result.data });
202202
}
203203

docs/sdks/tigris/using-sdk.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -415,6 +415,8 @@ list(options?: ListOptions): Promise<TigrisStorageResponse<ListResponse, Error>>
415415

416416
| **Parameter** | **Required** | **Values** |
417417
| ----------------------------------------- | ------------ | ------------------------------------------------------------------------------- |
418+
| delimiter | No | A delimiter is a character that you use to group keys. |
419+
| prefix | No | Limits the items to keys that begin with the specified prefix. |
418420
| limit | No | The maximum number of objects to return. By default, returns up to 100 objects. |
419421
| paginationToken | No | The pagination token to continue listing objects from the previous request. |
420422
| config | No | A configuration object to override the |

0 commit comments

Comments
 (0)