Skip to content

Commit 835ab6b

Browse files
octokitbotoctokitbot
authored
feat: many new unreleased endpoints (#632)
* WIP octokit/openapi updated * WIP octokit/openapi updated * WIP octokit/openapi updated * WIP octokit/openapi updated * WIP octokit/openapi updated * WIP octokit/openapi updated * WIP octokit/openapi updated * WIP octokit/openapi updated * WIP octokit/openapi updated * WIP octokit/openapi updated * WIP octokit/openapi updated * WIP octokit/openapi updated * WIP octokit/openapi updated
1 parent 7da00f2 commit 835ab6b

File tree

168 files changed

+54147
-12920
lines changed

Some content is hidden

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

168 files changed

+54147
-12920
lines changed

‎docs/actions/deleteActionsCacheByKey.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ A key for identifying the cache.
5050
</td></tr>
5151
<tr><td>ref</td><td>no</td><td>
5252

53-
The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.
53+
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`.
5454

5555
</td></tr>
5656
</tbody>

‎docs/actions/deleteEnvironmentVariable.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Delete an environment variable
3-
example: octokit.rest.actions.deleteEnvironmentVariable({ repository_id, name })
3+
example: octokit.rest.actions.deleteEnvironmentVariable({ repository_id, name, environment_name })
44
route: DELETE /repositories/{repository_id}/environments/{environment_name}/variables/{name}
55
scope: actions
66
type: API method
@@ -16,6 +16,7 @@ GitHub Apps must have the `environment:write` repository permission to use this
1616
octokit.rest.actions.deleteEnvironmentVariable({
1717
repository_id,
1818
name,
19+
environment_name,
1920
});
2021
```
2122

@@ -39,6 +40,11 @@ The unique identifier of the repository.
3940

4041
The name of the variable.
4142

43+
</td></tr>
44+
<tr><td>environment_name</td><td>yes</td><td>
45+
46+
The name of the environment.
47+
4248
</td></tr>
4349
</tbody>
4450
</table>

‎docs/actions/getActionsCacheList.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Page number of the results to fetch.
5252
</td></tr>
5353
<tr><td>ref</td><td>no</td><td>
5454

55-
The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.
55+
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`.
5656

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

‎docs/actions/listRepoOrganizationSecrets.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
name: List repository organization secrets
3+
example: octokit.rest.actions.listRepoOrganizationSecrets({ owner, repo })
4+
route: GET /repos/{owner}/{repo}/actions/organization-secrets
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# List repository organization secrets
10+
11+
Lists all organization secrets shared with a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.
12+
13+
```js
14+
octokit.rest.actions.listRepoOrganizationSecrets({
15+
owner,
16+
repo,
17+
});
18+
```
19+
20+
## Parameters
21+
22+
<table>
23+
<thead>
24+
<tr>
25+
<th>name</th>
26+
<th>required</th>
27+
<th>description</th>
28+
</tr>
29+
</thead>
30+
<tbody>
31+
<tr><td>owner</td><td>yes</td><td>
32+
33+
The account owner of the repository. The name is not case sensitive.
34+
35+
</td></tr>
36+
<tr><td>repo</td><td>yes</td><td>
37+
38+
The name of the repository. The name is not case sensitive.
39+
40+
</td></tr>
41+
<tr><td>per_page</td><td>no</td><td>
42+
43+
The number of results per page (max 100).
44+
45+
</td></tr>
46+
<tr><td>page</td><td>no</td><td>
47+
48+
Page number of the results to fetch.
49+
50+
</td></tr>
51+
</tbody>
52+
</table>
53+
54+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets).

‎docs/actions/listRepoOrganizationVariables.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
name: List repository organization variables
3+
example: octokit.rest.actions.listRepoOrganizationVariables({ owner, repo })
4+
route: GET /repos/{owner}/{repo}/actions/organization-variables
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# List repository organization variables
10+
11+
Lists all organiation variables shared with a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
12+
13+
```js
14+
octokit.rest.actions.listRepoOrganizationVariables({
15+
owner,
16+
repo,
17+
});
18+
```
19+
20+
## Parameters
21+
22+
<table>
23+
<thead>
24+
<tr>
25+
<th>name</th>
26+
<th>required</th>
27+
<th>description</th>
28+
</tr>
29+
</thead>
30+
<tbody>
31+
<tr><td>owner</td><td>yes</td><td>
32+
33+
The account owner of the repository. The name is not case sensitive.
34+
35+
</td></tr>
36+
<tr><td>repo</td><td>yes</td><td>
37+
38+
The name of the repository. The name is not case sensitive.
39+
40+
</td></tr>
41+
<tr><td>per_page</td><td>no</td><td>
42+
43+
The number of results per page (max 30).
44+
45+
</td></tr>
46+
<tr><td>page</td><td>no</td><td>
47+
48+
Page number of the results to fetch.
49+
50+
</td></tr>
51+
</tbody>
52+
</table>
53+
54+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/variables#list-repository-organization-variables).

‎docs/actions/reviewCustomGatesForRun.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
name: Review custom deployment protection rules for a workflow run
3+
example: octokit.rest.actions.reviewCustomGatesForRun({ owner, repo, run_id })
4+
route: POST /repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Review custom deployment protection rules for a workflow run
10+
11+
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
12+
13+
**Note:** GitHub Apps can only review their own custom deployment protection rules.
14+
To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).
15+
16+
GitHub Apps must have read and write permission for **Deployments** to use this endpoint.
17+
18+
```js
19+
octokit.rest.actions.reviewCustomGatesForRun({
20+
owner,
21+
repo,
22+
run_id,
23+
});
24+
```
25+
26+
## Parameters
27+
28+
<table>
29+
<thead>
30+
<tr>
31+
<th>name</th>
32+
<th>required</th>
33+
<th>description</th>
34+
</tr>
35+
</thead>
36+
<tbody>
37+
<tr><td>owner</td><td>yes</td><td>
38+
39+
The account owner of the repository. The name is not case sensitive.
40+
41+
</td></tr>
42+
<tr><td>repo</td><td>yes</td><td>
43+
44+
The name of the repository. The name is not case sensitive.
45+
46+
</td></tr>
47+
<tr><td>run_id</td><td>yes</td><td>
48+
49+
The unique identifier of the workflow run.
50+
51+
</td></tr>
52+
</tbody>
53+
</table>
54+
55+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run).

‎docs/actions/setAllowedActionsOrganization.md‎

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

1111
Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
1212

13-
If the organization belongs to an enterprise that has `selected` actions and reusable workflows set at the enterprise level, then you cannot override any of the enterprise's allowed actions and reusable workflows settings.
14-
15-
To use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.
16-
1713
You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
1814

1915
```js
@@ -50,7 +46,9 @@ Whether actions from GitHub Marketplace verified creators are allowed. Set to `t
5046
</td></tr>
5147
<tr><td>patterns_allowed</td><td>no</td><td>
5248

53-
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`."
49+
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.
50+
51+
**Note**: The `patterns_allowed` setting only applies to public repositories.
5452

5553
</td></tr>
5654
</tbody>

‎docs/actions/setAllowedActionsRepository.md‎

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

1111
Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."
1212

13-
If the repository belongs to an organization or enterprise that has `selected` actions and reusable workflows set at the organization or enterprise levels, then you cannot override any of the allowed actions and reusable workflows settings.
14-
15-
To use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.
16-
1713
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
1814

1915
```js
@@ -56,7 +52,9 @@ Whether actions from GitHub Marketplace verified creators are allowed. Set to `t
5652
</td></tr>
5753
<tr><td>patterns_allowed</td><td>no</td><td>
5854

59-
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`."
55+
Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.
56+
57+
**Note**: The `patterns_allowed` setting only applies to public repositories.
6058

6159
</td></tr>
6260
</tbody>

‎docs/actions/setGithubActionsPermissionsOrganization.md‎

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

1111
Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
1212

13-
If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the organization.
14-
1513
You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
1614

1715
```js

‎docs/actions/setGithubActionsPermissionsRepository.md‎

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

1111
Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.
1212

13-
If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the repository.
14-
1513
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
1614

1715
```js

0 commit comments

Comments
 (0)