Skip to content

Commit a9d727f

Browse files
markstuart-oaimarkstuart-oai
authored
chore(api): document files and uploads error responses (openai#3960)
## Summary Documents applicable request, missing-file, upload-state and storage errors for Files and Uploads. Python exceptions are unchanged. ## Changes - Describe Files lookup and validation failures. - Clarify expired-upload recovery and applicable request-rate limits. Co-authored-by: markstuart-oai <323302876+markstuart-oai@users.noreply.github.com>
1 parent 63099e7 commit a9d727f

2 files changed

Lines changed: 185 additions & 5 deletions

File tree

‎.castiron.stats.yml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
schema_version: 1
2-
generation_id: 609890e8-e394-414e-9f46-19228c660a02
3-
openapi_spec_hash: c391453ba13869e34306c479834d24a5
4-
openapi_transformed_spec_hash: 9ccfb60d276e7be95a2d78b81cbc2474
2+
generation_id: bbcf5fb4-a54f-48d7-9c24-772776477085
3+
openapi_spec_hash: 0e4e2f7dffefdf9af4ba091f557e3698
4+
openapi_transformed_spec_hash: 289efd507762e0572ba21c2b46935826
55
config_hash: 84cdcc959ee7140cc9a65e9b642c097b
6-
codegen_sha: cd0d2fbdca92c3722e2d8c89a3264360bb297fd5
6+
codegen_sha: 89568c51f375a47f1d3156069016495765eeb70f
77
codegen_hash: 67b5ab20d81c80689a8a857466838278fb0d428d48b3261d2479bab43396d589
8-
public_codegen_sha: a647954332e5cc4fad53f7841d3cb20f513caaa6
8+
public_codegen_sha: adc070c132abc2bdd81fd8ef5c4b75925ea0a02c

‎api_reference/openapi.transformed.yml‎

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6025,6 +6025,24 @@ paths:
60256025
application/json:
60266026
schema:
60276027
$ref: '#/components/schemas/ListFilesResponse'
6028+
'400':
6029+
description: The file listing parameters are invalid.
6030+
content:
6031+
application/json:
6032+
schema:
6033+
$ref: '#/components/schemas/ErrorResponse'
6034+
'404':
6035+
description: The file specified by the after cursor was not found.
6036+
content:
6037+
application/json:
6038+
schema:
6039+
$ref: '#/components/schemas/ErrorResponse'
6040+
'429':
6041+
description: Too many file requests. Reduce the request rate and try again later.
6042+
content:
6043+
application/json:
6044+
schema:
6045+
$ref: '#/components/schemas/ErrorResponse'
60286046
x-oaiMeta:
60296047
group: files
60306048
examples:
@@ -6122,6 +6140,24 @@ paths:
61226140
application/json:
61236141
schema:
61246142
$ref: '#/components/schemas/OpenAIFile'
6143+
'400':
6144+
description: The file upload request is invalid or exceeds a file size or storage quota limit.
6145+
content:
6146+
application/json:
6147+
schema:
6148+
$ref: '#/components/schemas/ErrorResponse'
6149+
'429':
6150+
description: Too many file requests. Reduce the request rate and try again later.
6151+
content:
6152+
application/json:
6153+
schema:
6154+
$ref: '#/components/schemas/ErrorResponse'
6155+
'500':
6156+
description: The file could not be uploaded because of a server error.
6157+
content:
6158+
application/json:
6159+
schema:
6160+
$ref: '#/components/schemas/ErrorResponse'
61256161
x-oaiMeta:
61266162
group: files
61276163
examples:
@@ -6196,6 +6232,18 @@ paths:
61966232
application/json:
61976233
schema:
61986234
$ref: '#/components/schemas/DeleteFileResponse'
6235+
'404':
6236+
description: The file was not found.
6237+
content:
6238+
application/json:
6239+
schema:
6240+
$ref: '#/components/schemas/ErrorResponse'
6241+
'429':
6242+
description: Too many file requests. Reduce the request rate and try again later.
6243+
content:
6244+
application/json:
6245+
schema:
6246+
$ref: '#/components/schemas/ErrorResponse'
61996247
x-oaiMeta:
62006248
group: files
62016249
examples:
@@ -6247,6 +6295,18 @@ paths:
62476295
application/json:
62486296
schema:
62496297
$ref: '#/components/schemas/OpenAIFile'
6298+
'404':
6299+
description: The file was not found.
6300+
content:
6301+
application/json:
6302+
schema:
6303+
$ref: '#/components/schemas/ErrorResponse'
6304+
'429':
6305+
description: Too many file requests. Reduce the request rate and try again later.
6306+
content:
6307+
application/json:
6308+
schema:
6309+
$ref: '#/components/schemas/ErrorResponse'
62506310
x-oaiMeta:
62516311
group: files
62526312
examples:
@@ -6302,6 +6362,30 @@ paths:
63026362
application/json:
63036363
schema:
63046364
type: string
6365+
'400':
6366+
description: The file cannot be downloaded for its purpose or the account does not have permission to download it.
6367+
content:
6368+
application/json:
6369+
schema:
6370+
$ref: '#/components/schemas/ErrorResponse'
6371+
'404':
6372+
description: The file was not found.
6373+
content:
6374+
application/json:
6375+
schema:
6376+
$ref: '#/components/schemas/ErrorResponse'
6377+
'429':
6378+
description: Too many file requests. Reduce the request rate and try again later.
6379+
content:
6380+
application/json:
6381+
schema:
6382+
$ref: '#/components/schemas/ErrorResponse'
6383+
'500':
6384+
description: The file could not be downloaded because of a server error.
6385+
content:
6386+
application/json:
6387+
schema:
6388+
$ref: '#/components/schemas/ErrorResponse'
63056389
x-oaiMeta:
63066390
group: files
63076391
examples:
@@ -20874,6 +20958,18 @@ paths:
2087420958
application/json:
2087520959
schema:
2087620960
$ref: '#/components/schemas/Upload'
20961+
'400':
20962+
description: The upload request is invalid or exceeds a file size or storage quota limit.
20963+
content:
20964+
application/json:
20965+
schema:
20966+
$ref: '#/components/schemas/ErrorResponse'
20967+
'429':
20968+
description: Too many upload requests. Reduce the request rate and try again later.
20969+
content:
20970+
application/json:
20971+
schema:
20972+
$ref: '#/components/schemas/ErrorResponse'
2087720973
x-oaiMeta:
2087820974
group: uploads
2087920975
examples:
@@ -20928,6 +21024,30 @@ paths:
2092821024
application/json:
2092921025
schema:
2093021026
$ref: '#/components/schemas/Upload'
21027+
'400':
21028+
description: The upload is no longer pending or is already being completed and cannot be cancelled.
21029+
content:
21030+
application/json:
21031+
schema:
21032+
$ref: '#/components/schemas/ErrorResponse'
21033+
'404':
21034+
description: The upload was not found.
21035+
content:
21036+
application/json:
21037+
schema:
21038+
$ref: '#/components/schemas/ErrorResponse'
21039+
'410':
21040+
description: The upload has expired. Create a new upload before adding parts or completing it.
21041+
content:
21042+
application/json:
21043+
schema:
21044+
$ref: '#/components/schemas/ErrorResponse'
21045+
'429':
21046+
description: Too many upload requests. Reduce the request rate and try again later.
21047+
content:
21048+
application/json:
21049+
schema:
21050+
$ref: '#/components/schemas/ErrorResponse'
2093121051
x-oaiMeta:
2093221052
group: uploads
2093321053
examples:
@@ -20982,6 +21102,36 @@ paths:
2098221102
application/json:
2098321103
schema:
2098421104
$ref: '#/components/schemas/Upload'
21105+
'400':
21106+
description: The upload cannot be completed in its current state, the parts are invalid, or the uploaded size does not match the specified size.
21107+
content:
21108+
application/json:
21109+
schema:
21110+
$ref: '#/components/schemas/ErrorResponse'
21111+
'404':
21112+
description: The upload was not found.
21113+
content:
21114+
application/json:
21115+
schema:
21116+
$ref: '#/components/schemas/ErrorResponse'
21117+
'410':
21118+
description: The upload has expired. Create a new upload before adding parts or completing it.
21119+
content:
21120+
application/json:
21121+
schema:
21122+
$ref: '#/components/schemas/ErrorResponse'
21123+
'429':
21124+
description: Too many upload requests. Reduce the request rate and try again later.
21125+
content:
21126+
application/json:
21127+
schema:
21128+
$ref: '#/components/schemas/ErrorResponse'
21129+
'500':
21130+
description: The upload could not be completed. Retry the same request, preserving the part order and MD5 value.
21131+
content:
21132+
application/json:
21133+
schema:
21134+
$ref: '#/components/schemas/ErrorResponse'
2098521135
x-oaiMeta:
2098621136
group: uploads
2098721137
examples:
@@ -21045,6 +21195,36 @@ paths:
2104521195
application/json:
2104621196
schema:
2104721197
$ref: '#/components/schemas/UploadPart'
21198+
'400':
21199+
description: The upload cannot accept more parts, or the part exceeds an upload size limit.
21200+
content:
21201+
application/json:
21202+
schema:
21203+
$ref: '#/components/schemas/ErrorResponse'
21204+
'404':
21205+
description: The upload was not found.
21206+
content:
21207+
application/json:
21208+
schema:
21209+
$ref: '#/components/schemas/ErrorResponse'
21210+
'410':
21211+
description: The upload has expired. Create a new upload before adding parts or completing it.
21212+
content:
21213+
application/json:
21214+
schema:
21215+
$ref: '#/components/schemas/ErrorResponse'
21216+
'429':
21217+
description: Too many upload requests. Reduce the request rate and try again later.
21218+
content:
21219+
application/json:
21220+
schema:
21221+
$ref: '#/components/schemas/ErrorResponse'
21222+
'500':
21223+
description: The part could not be uploaded. Try the request again.
21224+
content:
21225+
application/json:
21226+
schema:
21227+
$ref: '#/components/schemas/ErrorResponse'
2104821228
x-oaiMeta:
2104921229
group: uploads
2105021230
examples:

0 commit comments

Comments
 (0)