Skip to content

Commit 0960906

Browse files
dsotirho-ucscdsotirho-ucsc
committed
[a] Fix: OpenAPI spec does not document 429 responses (#7469)
1 parent ed2afb2 commit 0960906

File tree

5 files changed

+182
-51
lines changed

5 files changed

+182
-51
lines changed

‎lambdas/indexer/app.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
# changes and reset the minor version to zero. Otherwise, increment only
5454
# the minor version for backwards compatible changes. A backwards
5555
# compatible change is one that does not require updates to clients.
56-
'version': '3.3',
56+
'version': '3.4',
5757
'description': fd('''
5858
This is the internal API for Azul's indexer component.
5959
''')

‎lambdas/indexer/openapi.json‎

Lines changed: 57 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"openapi": "3.0.1",
33
"info": {
44
"title": "azul-indexer-dev",
5-
"version": "3.3",
5+
"version": "3.4",
66
"description": "\nThis is the internal API for Azul's indexer component.\n\n\n## Contact us\n\nFor technical support please file an issue at\n[GitHub](https://github.com/DataBiosphere/azul/issues) or email\n`[email protected]`. To report a security concern or misconduct please email\n`[email protected]`.\n"
77
},
88
"paths": {
@@ -16,8 +16,11 @@
1616
"301": {
1717
"description": "A redirect to the Swagger UI"
1818
},
19+
"429": {
20+
"description": "Too many requests. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
21+
},
1922
"504": {
20-
"description": "\nRequest timed out. When handling this response, clients\nshould wait the number of seconds specified in the\n`Retry-After` header and then retry the request.\n"
23+
"description": "Request timed out. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
2124
}
2225
}
2326
}
@@ -32,8 +35,11 @@
3235
"200": {
3336
"description": "The response body is an HTML page containing the Swagger UI"
3437
},
38+
"429": {
39+
"description": "Too many requests. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
40+
},
3541
"504": {
36-
"description": "\nRequest timed out. When handling this response, clients\nshould wait the number of seconds specified in the\n`Retry-After` header and then retry the request.\n"
42+
"description": "Request timed out. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
3743
}
3844
}
3945
}
@@ -48,8 +54,11 @@
4854
"200": {
4955
"description": "The response body is JavaScript used internally by the Swagger UI"
5056
},
57+
"429": {
58+
"description": "Too many requests. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
59+
},
5160
"504": {
52-
"description": "\nRequest timed out. When handling this response, clients\nshould wait the number of seconds specified in the\n`Retry-After` header and then retry the request.\n"
61+
"description": "Request timed out. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
5362
}
5463
}
5564
}
@@ -78,8 +87,11 @@
7887
"404": {
7988
"description": "The requested file does not exist"
8089
},
90+
"429": {
91+
"description": "Too many requests. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
92+
},
8193
"504": {
82-
"description": "\nRequest timed out. When handling this response, clients\nshould wait the number of seconds specified in the\n`Retry-After` header and then retry the request.\n"
94+
"description": "Request timed out. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
8395
}
8496
}
8597
}
@@ -138,8 +150,11 @@
138150
}
139151
}
140152
},
153+
"429": {
154+
"description": "Too many requests. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
155+
},
141156
"504": {
142-
"description": "\nRequest timed out. When handling this response, clients\nshould wait the number of seconds specified in the\n`Retry-After` header and then retry the request.\n"
157+
"description": "Request timed out. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
143158
}
144159
},
145160
"tags": [
@@ -186,8 +201,11 @@
186201
}
187202
}
188203
},
204+
"429": {
205+
"description": "Too many requests. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
206+
},
189207
"504": {
190-
"description": "\nRequest timed out. When handling this response, clients\nshould wait the number of seconds specified in the\n`Retry-After` header and then retry the request.\n"
208+
"description": "Request timed out. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
191209
}
192210
}
193211
}
@@ -202,8 +220,11 @@
202220
"200": {
203221
"description": "\nThe robots.txt resource according to\n[RFC9309](https://datatracker.ietf.org/doc/html/rfc9309)\n"
204222
},
223+
"429": {
224+
"description": "Too many requests. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
225+
},
205226
"504": {
206-
"description": "\nRequest timed out. When handling this response, clients\nshould wait the number of seconds specified in the\n`Retry-After` header and then retry the request.\n"
227+
"description": "Request timed out. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
207228
}
208229
}
209230
}
@@ -301,8 +322,11 @@
301322
}
302323
}
303324
},
325+
"429": {
326+
"description": "Too many requests. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
327+
},
304328
"504": {
305-
"description": "\nRequest timed out. When handling this response, clients\nshould wait the number of seconds specified in the\n`Retry-After` header and then retry the request.\n"
329+
"description": "Request timed out. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
306330
}
307331
},
308332
"tags": [
@@ -393,8 +417,11 @@
393417
}
394418
}
395419
},
420+
"429": {
421+
"description": "Too many requests. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
422+
},
396423
"504": {
397-
"description": "\nRequest timed out. When handling this response, clients\nshould wait the number of seconds specified in the\n`Retry-After` header and then retry the request.\n"
424+
"description": "Request timed out. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
398425
}
399426
},
400427
"tags": [
@@ -491,8 +518,11 @@
491518
}
492519
}
493520
},
521+
"429": {
522+
"description": "Too many requests. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
523+
},
494524
"504": {
495-
"description": "\nRequest timed out. When handling this response, clients\nshould wait the number of seconds specified in the\n`Retry-After` header and then retry the request.\n"
525+
"description": "Request timed out. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
496526
}
497527
},
498528
"tags": [
@@ -589,8 +619,11 @@
589619
}
590620
}
591621
},
622+
"429": {
623+
"description": "Too many requests. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
624+
},
592625
"504": {
593-
"description": "\nRequest timed out. When handling this response, clients\nshould wait the number of seconds specified in the\n`Retry-After` header and then retry the request.\n"
626+
"description": "Request timed out. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
594627
}
595628
},
596629
"tags": [
@@ -712,8 +745,11 @@
712745
}
713746
}
714747
},
748+
"429": {
749+
"description": "Too many requests. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
750+
},
715751
"504": {
716-
"description": "\nRequest timed out. When handling this response, clients\nshould wait the number of seconds specified in the\n`Retry-After` header and then retry the request.\n"
752+
"description": "Request timed out. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
717753
}
718754
},
719755
"tags": [
@@ -824,8 +860,11 @@
824860
"401": {
825861
"description": "Request lacked a valid HMAC header"
826862
},
863+
"429": {
864+
"description": "Too many requests. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
865+
},
827866
"504": {
828-
"description": "\nRequest timed out. When handling this response, clients\nshould wait the number of seconds specified in the\n`Retry-After` header and then retry the request.\n"
867+
"description": "Request timed out. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
829868
}
830869
}
831870
}
@@ -892,8 +931,11 @@
892931
}
893932
}
894933
},
934+
"429": {
935+
"description": "Too many requests. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
936+
},
895937
"504": {
896-
"description": "\nRequest timed out. When handling this response, clients\nshould wait the number of seconds specified in the\n`Retry-After` header and then retry the request.\n"
938+
"description": "Request timed out. \nWhen handling this response, clients should wait the number of\nseconds specified in the `Retry-After` header and then retry the\nrequest.\n"
897939
}
898940
}
899941
}

0 commit comments

Comments
 (0)