Skip to content

Commit 0a5ed03

Browse files
committed
WIP octokit/openapi updated
1 parent c016ce3 commit 0a5ed03

File tree

66 files changed

+466
-1938
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+466
-1938
lines changed
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
name: Get billing usage report for a user
3+
example: octokit.rest.billing.getGithubBillingUsageReportUser({ username })
4+
route: GET /users/{username}/settings/billing/usage
5+
scope: billing
6+
type: API method
7+
---
8+
9+
# Get billing usage report for a user
10+
11+
Gets a report of the total usage for a user.
12+
13+
**Note:** This endpoint is only available to users with access to the enhanced billing platform.
14+
15+
```js
16+
octokit.rest.billing.getGithubBillingUsageReportUser({
17+
username,
18+
});
19+
```
20+
21+
## Parameters
22+
23+
<table>
24+
<thead>
25+
<tr>
26+
<th>name</th>
27+
<th>required</th>
28+
<th>description</th>
29+
</tr>
30+
</thead>
31+
<tbody>
32+
<tr><td>username</td><td>yes</td><td>
33+
34+
The handle for the GitHub user account.
35+
36+
</td></tr>
37+
<tr><td>year</td><td>no</td><td>
38+
39+
If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.
40+
41+
</td></tr>
42+
<tr><td>month</td><td>no</td><td>
43+
44+
If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.
45+
46+
</td></tr>
47+
<tr><td>day</td><td>no</td><td>
48+
49+
If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.
50+
51+
</td></tr>
52+
<tr><td>hour</td><td>no</td><td>
53+
54+
If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or `day` is specified, the default `year`, `month`, and `day` are used.
55+
56+
</td></tr>
57+
</tbody>
58+
</table>
59+
60+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user).

docs/checks/rerequestRun.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,10 @@ type: API method
88

99
# Rerequest a check run
1010

11-
Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
11+
Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired.
1212

1313
For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)".
1414

15-
OAuth apps and personal access tokens (classic) cannot use this endpoint.
16-
1715
```js
1816
octokit.rest.checks.rerequestRun({
1917
owner,

docs/checks/rerequestSuite.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ type: API method
1010

1111
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.
1212

13-
OAuth apps and personal access tokens (classic) cannot use this endpoint.
14-
1513
```js
1614
octokit.rest.checks.rerequestSuite({
1715
owner,

docs/codeSecurity/createConfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ A description of the code security configuration
5252
</td></tr>
5353
<tr><td>advanced_security</td><td>no</td><td>
5454

55-
The enablement status of GitHub Advanced Security
55+
The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.
5656

5757
</td></tr>
5858
<tr><td>dependency_graph</td><td>no</td><td>

docs/codeSecurity/createConfigurationForEnterprise.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ A description of the code security configuration
5050
</td></tr>
5151
<tr><td>advanced_security</td><td>no</td><td>
5252

53-
The enablement status of GitHub Advanced Security
53+
The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.
5454

5555
</td></tr>
5656
<tr><td>dependency_graph</td><td>no</td><td>

docs/codeSecurity/updateConfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ A description of the code security configuration
5656
</td></tr>
5757
<tr><td>advanced_security</td><td>no</td><td>
5858

59-
The enablement status of GitHub Advanced Security
59+
The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.
6060

6161
</td></tr>
6262
<tr><td>dependency_graph</td><td>no</td><td>

docs/codeSecurity/updateEnterpriseConfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ A description of the code security configuration
5454
</td></tr>
5555
<tr><td>advanced_security</td><td>no</td><td>
5656

57-
The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings.
57+
The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.
5858

5959
</td></tr>
6060
<tr><td>dependency_graph</td><td>no</td><td>

docs/copilot/usageMetricsForOrg.md

Lines changed: 0 additions & 71 deletions
This file was deleted.

docs/copilot/usageMetricsForTeam.md

Lines changed: 0 additions & 80 deletions
This file was deleted.

docs/credentials/revoke.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: Revoke a list of credentials
3+
example: octokit.rest.credentials.revoke({ credentials })
4+
route: POST /credentials/revoke
5+
scope: credentials
6+
type: API method
7+
---
8+
9+
# Revoke a list of credentials
10+
11+
Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation.
12+
13+
This endpoint currently accepts the following credential types:
14+
15+
- Personal access tokens (classic)
16+
- Fine-grained personal access tokens
17+
18+
Revoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users.
19+
GitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated.
20+
21+
To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request.
22+
23+
> [!NOTE]
24+
> Any authenticated requests will return a 403.
25+
26+
```js
27+
octokit.rest.credentials.revoke({
28+
credentials,
29+
});
30+
```
31+
32+
## Parameters
33+
34+
<table>
35+
<thead>
36+
<tr>
37+
<th>name</th>
38+
<th>required</th>
39+
<th>description</th>
40+
</tr>
41+
</thead>
42+
<tbody>
43+
<tr><td>credentials</td><td>yes</td><td>
44+
45+
A list of credentials to be revoked, up to 1000 per request.
46+
47+
</td></tr>
48+
</tbody>
49+
</table>
50+
51+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/credentials/revoke#revoke-a-list-of-credentials).

docs/dependabot/listAlertsForEnterprise.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,12 @@ CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:
7474

7575
Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.
7676

77+
</td></tr>
78+
<tr><td>has</td><td>no</td><td>
79+
80+
Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.
81+
Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported.
82+
7783
</td></tr>
7884
<tr><td>scope</td><td>no</td><td>
7985

docs/dependabot/listAlertsForOrg.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,12 @@ CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:
7272

7373
Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.
7474

75+
</td></tr>
76+
<tr><td>has</td><td>no</td><td>
77+
78+
Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.
79+
Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported.
80+
7581
</td></tr>
7682
<tr><td>scope</td><td>no</td><td>
7783

docs/dependabot/listAlertsForRepo.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,12 @@ CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:
7979

8080
Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.
8181

82+
</td></tr>
83+
<tr><td>has</td><td>no</td><td>
84+
85+
Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.
86+
Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported.
87+
8288
</td></tr>
8389
<tr><td>scope</td><td>no</td><td>
8490

docs/orgs/listMembers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The organization name. The name is not case sensitive.
3434
</td></tr>
3535
<tr><td>filter</td><td>no</td><td>
3636

37-
Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners.
37+
Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners.
3838

3939
</td></tr>
4040
<tr><td>role</td><td>no</td><td>

docs/orgs/listOutsideCollaborators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The organization name. The name is not case sensitive.
3434
</td></tr>
3535
<tr><td>filter</td><td>no</td><td>
3636

37-
Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned.
37+
Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned.
3838

3939
</td></tr>
4040
<tr><td>per_page</td><td>no</td><td>

docs/privateRegistries/createOrgPrivateRegistry.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ type: API method
88

99
# Create a private registry for an organization
1010

11-
> [!NOTE]
12-
> This endpoint is in public preview and is subject to change.
13-
1411
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
1512

1613
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.

0 commit comments

Comments
 (0)