You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/openapi-typescript/examples/digital-ocean-api/description.yml
+22-4
Original file line number
Diff line number
Diff line change
@@ -205,6 +205,9 @@ introduction: |
205
205
* **ratelimit-limit**: The number of requests that can be made per hour.
206
206
* **ratelimit-remaining**: The number of requests that remain before you hit your request limit. See the information below for how the request limits expire.
207
207
* **ratelimit-reset**: This represents the time when the oldest request will expire. The value is given in [Unix epoch time](http://en.wikipedia.org/wiki/Unix_time). See below for more information about how request limits expire.
208
+
209
+
More rate limiting information is returned only within burst limit error response headers:
210
+
* **retry-after**: The number of seconds to wait before making another request when rate limited.
208
211
209
212
As long as the `ratelimit-remaining` count is above zero, you will be able
210
213
to make additional requests.
@@ -226,10 +229,14 @@ introduction: |
226
229
move an entire hour into the future.
227
230
228
231
If the `ratelimit-remaining` reaches zero, subsequent requests will receive
229
-
a 429 error code until the request reset has been reached. You can see the
230
-
format of the response in the examples. `ratelimit-remaining` reaching zero
231
-
can also indicate that the 250 requests per minute limit was met, even if
232
-
the 5,000 requests per hour limit was not.
232
+
a 429 error code until the request reset has been reached.
233
+
234
+
`ratelimit-remaining` reaching zero can also indicate that the "burst limit" of 250
235
+
requests per minute limit was met, even if the 5,000 requests per hour limit was not.
236
+
In this case, the 429 error response will include a retry-after header to indicate how
237
+
long to wait (in seconds) until the request may be retried.
238
+
239
+
You can see the format of the response in the examples.
233
240
234
241
**Note:** The following endpoints have special rate limit requirements that
235
242
are independent of the limits defined above.
@@ -251,6 +258,17 @@ introduction: |
251
258
. . .
252
259
```
253
260
261
+
### Sample Rate Limit Headers When Burst Limit is Reached:
Copy file name to clipboardExpand all lines: packages/openapi-typescript/examples/github-api.ts
+37-11
Original file line number
Diff line number
Diff line change
@@ -3610,7 +3610,7 @@ export interface paths {
3610
3610
* Rerequest a check suite
3611
3611
* @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
3612
3612
*
3613
-
* To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.
3613
+
* To rerequest a check suite, your GitHub App must have the `checks:write` permission on a private repository or pull access to a public repository.
3614
3614
*/
3615
3615
post: operations["checks/rerequest-suite"];
3616
3616
};
@@ -4348,7 +4348,7 @@ export interface paths {
4348
4348
get: operations["repos/get-content"];
4349
4349
/**
4350
4350
* Create or update file contents
4351
-
* @description Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.
4351
+
* @description Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope.
4352
4352
*
4353
4353
* **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
4354
4354
*/
@@ -4531,7 +4531,7 @@ export interface paths {
4531
4531
* * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
4532
4532
* * Mark the active deployment as inactive by adding any non-successful deployment status.
4533
4533
*
4534
-
* For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/deployment-statuses#create-a-deployment-status)."
4534
+
* For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)."
* @description Conditions for an organization ruleset
13205
+
* @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.
/** @description The unique identifier of the column. */
81574
81594
"column-id": number;
81595
+
/** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */
81596
+
"artifact-name"?: string;
81575
81597
/** @description The unique identifier of the artifact. */
81576
81598
"artifact-id": number;
81577
81599
/** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/<branch name>`. To reference a pull request use `refs/pull/<number>/merge`. */
* @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
94651
94673
*
94652
-
* To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.
94674
+
* To rerequest a check suite, your GitHub App must have the `checks:write` permission on a private repository or pull access to a public repository.
* @description Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.
96602
+
* @description Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope.
96579
96603
*
96580
96604
* **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
* * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
97264
97288
* * Mark the active deployment as inactive by adding any non-successful deployment status.
97265
97289
*
97266
-
* For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/deployment-statuses#create-a-deployment-status)."
97290
+
* For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)."
0 commit comments