Skip to content

Commit

Permalink
Merge pull request #293 from openai/dev/willhang/uploads-docs-polish
Browse files Browse the repository at this point in the history
Uploads docs polish
  • Loading branch information
will-hang authored Jul 18, 2024
2 parents 60afe06 + 6e397e8 commit 83950a5
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1777,7 +1777,7 @@ paths:
"expires_at": 1719127296
}

/uploads/{upload_id}/part:
/uploads/{upload_id}/parts:
post:
operationId: addUploadPart
tags:
Expand Down Expand Up @@ -1833,7 +1833,9 @@ paths:
tags:
- Uploads
summary: |
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.
Completes the [Upload](/docs/api-reference/uploads/object).

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.

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

Expand Down Expand Up @@ -8901,7 +8903,6 @@ components:
description: |
The name of the file to upload.
type: string
format: binary
purpose:
description: |
The intended purpose of the uploaded file.
Expand Down Expand Up @@ -8933,7 +8934,7 @@ components:
description: |
The chunk of bytes for this Part.
type: string
# format: binary
format: binary
required:
- data

Expand Down Expand Up @@ -9643,7 +9644,7 @@ components:
description: The object type, which is always "upload".
enum: [upload]
file:
type: object
$ref: "#/components/schemas/OpenAIFile"
nullable: true
description: The ready File object after the Upload is completed.
required:
Expand Down

0 comments on commit 83950a5

Please sign in to comment.