Skip to content

Commit 83950a5

Browse files
authored
Merge pull request #293 from openai/dev/willhang/uploads-docs-polish
Uploads docs polish
2 parents 60afe06 + 6e397e8 commit 83950a5

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

openapi.yaml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1777,7 +1777,7 @@ paths:
17771777
"expires_at": 1719127296
17781778
}
17791779

1780-
/uploads/{upload_id}/part:
1780+
/uploads/{upload_id}/parts:
17811781
post:
17821782
operationId: addUploadPart
17831783
tags:
@@ -1833,7 +1833,9 @@ paths:
18331833
tags:
18341834
- Uploads
18351835
summary: |
1836-
Completes the [Upload](/docs/api-reference/uploads/object) and returns a [File](/docs/api-reference/files/object) object that is ready to use in the rest of the platform.
1836+
Completes the [Upload](/docs/api-reference/uploads/object).
1837+
1838+
Within the returned Upload object, there is a nested [File](/docs/api-reference/files/object) object that is ready to use in the rest of the platform.
18371839

18381840
You can specify the order of the Parts by passing in an ordered list of the Part IDs.
18391841

@@ -8901,7 +8903,6 @@ components:
89018903
description: |
89028904
The name of the file to upload.
89038905
type: string
8904-
format: binary
89058906
purpose:
89068907
description: |
89078908
The intended purpose of the uploaded file.
@@ -8933,7 +8934,7 @@ components:
89338934
description: |
89348935
The chunk of bytes for this Part.
89358936
type: string
8936-
# format: binary
8937+
format: binary
89378938
required:
89388939
- data
89398940

@@ -9643,7 +9644,7 @@ components:
96439644
description: The object type, which is always "upload".
96449645
enum: [upload]
96459646
file:
9646-
type: object
9647+
$ref: "#/components/schemas/OpenAIFile"
96479648
nullable: true
96489649
description: The ready File object after the Upload is completed.
96499650
required:

0 commit comments

Comments
 (0)