Skip to content

Commit 2a7fce7

Browse files
authored
feat: many new endpoints, and updates (#713)
new DELETE method for `/notifications/threads/{thread_id}` endpoint, new organization-roles endpoints, new `/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}`, `/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel` endpoints, new PATCH method for `/repos/{owner}/{repo}/properties/values`, new `/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks` endpoint
1 parent fd96c32 commit 2a7fce7

File tree

615 files changed

+8038
-3676
lines changed

Some content is hidden

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

615 files changed

+8038
-3676
lines changed

docs/actions/addCustomLabelsToSelfHostedRunnerForOrg.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,11 @@ type: API method
88

99
# Add custom labels to a self-hosted runner for an organization
1010

11-
Add custom labels to a self-hosted runner configured in an organization.
11+
Adds custom labels to a self-hosted runner configured in an organization.
1212

13-
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
14-
If the repository is private, you must use an access token with the `repo` scope.
15-
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
16-
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
13+
Authenticated users must have admin access to the organization to use this endpoint.
14+
15+
OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
1716

1817
```js
1918
octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForOrg({

docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ type: API method
88

99
# Add custom labels to a self-hosted runner for a repository
1010

11-
Add custom labels to a self-hosted runner configured in a repository.
11+
Adds custom labels to a self-hosted runner configured in a repository.
1212

13-
You must authenticate using an access token with the `repo` scope to use this endpoint.
14-
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
15-
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
13+
Authenticated users must have admin access to the organization to use this endpoint.
14+
15+
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
1616

1717
```js
1818
octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForRepo({

docs/actions/addSelectedRepoToOrgSecret.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,13 @@ type: API method
99
# Add selected repository to an organization secret
1010

1111
Adds a repository to an organization secret when the `visibility` for
12-
repository access is set to `selected`. The visibility is set when you [Create or
12+
repository access is set to `selected`. For more information about setting the visibility, see [Create or
1313
update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).
1414

15-
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
16-
If the repository is private, you must use an access token with the `repo` scope.
17-
GitHub Apps must have the `secrets` organization permission to use this endpoint.
1815
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
1916

17+
OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
18+
2019
```js
2120
octokit.rest.actions.addSelectedRepoToOrgSecret({
2221
org,

docs/actions/addSelectedRepoToOrgVariable.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ type: API method
1111
Adds a repository to an organization variable that is available to selected repositories.
1212
Organization variables that are available to selected repositories have their `visibility` field set to `selected`.
1313

14-
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
15-
If the repository is private, you must use an access token with the `repo` scope.
16-
GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
17-
Authenticated users must have collaborator access to a repository to create, update, or read variables.
14+
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
15+
16+
OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
1817

1918
```js
2019
octokit.rest.actions.addSelectedRepoToOrgVariable({

docs/actions/approveWorkflowRun.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ type: API method
1010

1111
Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."
1212

13-
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
13+
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
1414

1515
```js
1616
octokit.rest.actions.approveWorkflowRun({

docs/actions/cancelWorkflowRun.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ type: API method
1010

1111
Cancels a workflow run using its `id`.
1212

13-
You must authenticate using an access token with the `repo` scope to use this endpoint.
14-
GitHub Apps must have the `actions:write` permission to use this endpoint.
13+
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
1514

1615
```js
1716
octokit.rest.actions.cancelWorkflowRun({

docs/actions/createEnvironmentVariable.md

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

1111
Create an environment variable that you can reference in a GitHub Actions workflow.
1212

13-
You must authenticate using an access token with the `repo` scope to use this endpoint.
14-
GitHub Apps must have the `environment:write` repository permission to use this endpoint.
1513
Authenticated users must have collaborator access to a repository to create, update, or read variables.
1614

15+
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
16+
1717
```js
1818
octokit.rest.actions.createEnvironmentVariable({
1919
repository_id,
@@ -41,7 +41,7 @@ The unique identifier of the repository.
4141
</td></tr>
4242
<tr><td>environment_name</td><td>yes</td><td>
4343

44-
The name of the environment.
44+
The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
4545

4646
</td></tr>
4747
<tr><td>name</td><td>yes</td><td>

docs/actions/createOrUpdateEnvironmentSecret.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ type: API method
1111
Creates or updates an environment secret with an encrypted value. Encrypt your secret using
1212
[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)."
1313

14-
You must authenticate using an access token with the `repo` scope to use this endpoint.
15-
GitHub Apps must have the `secrets` repository permission to use this endpoint.
1614
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
1715

16+
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
17+
1818
```js
1919
octokit.rest.actions.createOrUpdateEnvironmentSecret({
2020
repository_id,
@@ -43,7 +43,7 @@ The unique identifier of the repository.
4343
</td></tr>
4444
<tr><td>environment_name</td><td>yes</td><td>
4545

46-
The name of the environment.
46+
The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
4747

4848
</td></tr>
4949
<tr><td>secret_name</td><td>yes</td><td>

docs/actions/createOrUpdateRepoSecret.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ type: API method
1111
Creates or updates a repository secret with an encrypted value. Encrypt your secret using
1212
[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)."
1313

14-
You must authenticate using an access token with the `repo` scope to use this endpoint.
15-
GitHub Apps must have the `secrets` repository permission to use this endpoint.
1614
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
1715

16+
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
17+
1818
```js
1919
octokit.rest.actions.createOrUpdateRepoSecret({
2020
owner,

docs/actions/createOrgVariable.md

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

1111
Creates an organization variable that you can reference in a GitHub Actions workflow.
1212

13-
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
14-
If the repository is private, you must use an access token with the `repo` scope.
15-
GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
1613
Authenticated users must have collaborator access to a repository to create, update, or read variables.
1714

15+
OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
16+
1817
```js
1918
octokit.rest.actions.createOrgVariable({
2019
org,

0 commit comments

Comments
 (0)