Skip to content

Commit c071e55

Browse files
octokitbotoctokitbot
committed
WIP octokit/openapi updated
1 parent 197d78d commit c071e55

File tree

54 files changed

+5803
-3029
lines changed

Some content is hidden

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

54 files changed

+5803
-3029
lines changed

‎docs/actions/getActionsCacheRetentionLimitForEnterprise.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Get GitHub Actions cache retention limit for an enterprise
3+
example: octokit.rest.actions.getActionsCacheRetentionLimitForEnterprise({ enterprise })
4+
route: GET /enterprises/{enterprise}/actions/cache/retention-limit
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Get GitHub Actions cache retention limit for an enterprise
10+
11+
Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this
12+
enterprise may not set a higher cache retention limit.
13+
14+
OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
15+
16+
```js
17+
octokit.rest.actions.getActionsCacheRetentionLimitForEnterprise({
18+
enterprise,
19+
});
20+
```
21+
22+
## Parameters
23+
24+
<table>
25+
<thead>
26+
<tr>
27+
<th>name</th>
28+
<th>required</th>
29+
<th>description</th>
30+
</tr>
31+
</thead>
32+
<tbody>
33+
<tr><td>enterprise</td><td>yes</td><td>
34+
35+
The slug version of the enterprise name.
36+
37+
</td></tr>
38+
</tbody>
39+
</table>
40+
41+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise).

‎docs/actions/getActionsCacheRetentionLimitForOrganization.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Get GitHub Actions cache retention limit for an organization
3+
example: octokit.rest.actions.getActionsCacheRetentionLimitForOrganization({ org })
4+
route: GET /organizations/{org}/actions/cache/retention-limit
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Get GitHub Actions cache retention limit for an organization
10+
11+
Gets GitHub Actions cache retention limit for an organization. All repositories under this
12+
organization may not set a higher cache retention limit.
13+
14+
OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.
15+
16+
```js
17+
octokit.rest.actions.getActionsCacheRetentionLimitForOrganization({
18+
org,
19+
});
20+
```
21+
22+
## Parameters
23+
24+
<table>
25+
<thead>
26+
<tr>
27+
<th>name</th>
28+
<th>required</th>
29+
<th>description</th>
30+
</tr>
31+
</thead>
32+
<tbody>
33+
<tr><td>org</td><td>yes</td><td>
34+
35+
The organization name. The name is not case sensitive.
36+
37+
</td></tr>
38+
</tbody>
39+
</table>
40+
41+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization).

‎docs/actions/getActionsCacheRetentionLimitForRepository.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: Get GitHub Actions cache retention limit for a repository
3+
example: octokit.rest.actions.getActionsCacheRetentionLimitForRepository({ owner, repo })
4+
route: GET /repos/{owner}/{repo}/actions/cache/retention-limit
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Get GitHub Actions cache retention limit for a repository
10+
11+
Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if
12+
not manually removed or evicted due to size constraints.
13+
14+
OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.
15+
16+
```js
17+
octokit.rest.actions.getActionsCacheRetentionLimitForRepository({
18+
owner,
19+
repo,
20+
});
21+
```
22+
23+
## Parameters
24+
25+
<table>
26+
<thead>
27+
<tr>
28+
<th>name</th>
29+
<th>required</th>
30+
<th>description</th>
31+
</tr>
32+
</thead>
33+
<tbody>
34+
<tr><td>owner</td><td>yes</td><td>
35+
36+
The account owner of the repository. The name is not case sensitive.
37+
38+
</td></tr>
39+
<tr><td>repo</td><td>yes</td><td>
40+
41+
The name of the repository without the `.git` extension. The name is not case sensitive.
42+
43+
</td></tr>
44+
</tbody>
45+
</table>
46+
47+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository).

‎docs/actions/getActionsCacheStorageLimitForEnterprise.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Get GitHub Actions cache storage limit for an enterprise
3+
example: octokit.rest.actions.getActionsCacheStorageLimitForEnterprise({ enterprise })
4+
route: GET /enterprises/{enterprise}/actions/cache/storage-limit
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Get GitHub Actions cache storage limit for an enterprise
10+
11+
Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this
12+
enterprise may not set a higher cache storage limit.
13+
14+
OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
15+
16+
```js
17+
octokit.rest.actions.getActionsCacheStorageLimitForEnterprise({
18+
enterprise,
19+
});
20+
```
21+
22+
## Parameters
23+
24+
<table>
25+
<thead>
26+
<tr>
27+
<th>name</th>
28+
<th>required</th>
29+
<th>description</th>
30+
</tr>
31+
</thead>
32+
<tbody>
33+
<tr><td>enterprise</td><td>yes</td><td>
34+
35+
The slug version of the enterprise name.
36+
37+
</td></tr>
38+
</tbody>
39+
</table>
40+
41+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise).

‎docs/actions/getActionsCacheStorageLimitForOrganization.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Get GitHub Actions cache storage limit for an organization
3+
example: octokit.rest.actions.getActionsCacheStorageLimitForOrganization({ org })
4+
route: GET /organizations/{org}/actions/cache/storage-limit
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Get GitHub Actions cache storage limit for an organization
10+
11+
Gets GitHub Actions cache storage limit for an organization. All repositories under this
12+
organization may not set a higher cache storage limit.
13+
14+
OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.
15+
16+
```js
17+
octokit.rest.actions.getActionsCacheStorageLimitForOrganization({
18+
org,
19+
});
20+
```
21+
22+
## Parameters
23+
24+
<table>
25+
<thead>
26+
<tr>
27+
<th>name</th>
28+
<th>required</th>
29+
<th>description</th>
30+
</tr>
31+
</thead>
32+
<tbody>
33+
<tr><td>org</td><td>yes</td><td>
34+
35+
The organization name. The name is not case sensitive.
36+
37+
</td></tr>
38+
</tbody>
39+
</table>
40+
41+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization).

‎docs/actions/getActionsCacheStorageLimitForRepository.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: Get GitHub Actions cache storage limit for a repository
3+
example: octokit.rest.actions.getActionsCacheStorageLimitForRepository({ owner, repo })
4+
route: GET /repos/{owner}/{repo}/actions/cache/storage-limit
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Get GitHub Actions cache storage limit for a repository
10+
11+
Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be
12+
stored before eviction occurs.
13+
14+
OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.
15+
16+
```js
17+
octokit.rest.actions.getActionsCacheStorageLimitForRepository({
18+
owner,
19+
repo,
20+
});
21+
```
22+
23+
## Parameters
24+
25+
<table>
26+
<thead>
27+
<tr>
28+
<th>name</th>
29+
<th>required</th>
30+
<th>description</th>
31+
</tr>
32+
</thead>
33+
<tbody>
34+
<tr><td>owner</td><td>yes</td><td>
35+
36+
The account owner of the repository. The name is not case sensitive.
37+
38+
</td></tr>
39+
<tr><td>repo</td><td>yes</td><td>
40+
41+
The name of the repository without the `.git` extension. The name is not case sensitive.
42+
43+
</td></tr>
44+
</tbody>
45+
</table>
46+
47+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository).

‎docs/actions/setActionsCacheRetentionLimitForEnterprise.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Set GitHub Actions cache retention limit for an enterprise
3+
example: octokit.rest.actions.setActionsCacheRetentionLimitForEnterprise({ enterprise })
4+
route: PUT /enterprises/{enterprise}/actions/cache/retention-limit
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Set GitHub Actions cache retention limit for an enterprise
10+
11+
Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this
12+
enterprise may not set a higher cache retention limit.
13+
14+
OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
15+
16+
```js
17+
octokit.rest.actions.setActionsCacheRetentionLimitForEnterprise({
18+
enterprise,
19+
});
20+
```
21+
22+
## Parameters
23+
24+
<table>
25+
<thead>
26+
<tr>
27+
<th>name</th>
28+
<th>required</th>
29+
<th>description</th>
30+
</tr>
31+
</thead>
32+
<tbody>
33+
<tr><td>enterprise</td><td>yes</td><td>
34+
35+
The slug version of the enterprise name.
36+
37+
</td></tr>
38+
<tr><td>max_cache_retention_days</td><td>no</td><td>
39+
40+
For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.
41+
42+
</td></tr>
43+
</tbody>
44+
</table>
45+
46+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise).

‎docs/actions/setActionsCacheRetentionLimitForOrganization.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Set GitHub Actions cache retention limit for an organization
3+
example: octokit.rest.actions.setActionsCacheRetentionLimitForOrganization({ org })
4+
route: PUT /organizations/{org}/actions/cache/retention-limit
5+
scope: actions
6+
type: API method
7+
---
8+
9+
# Set GitHub Actions cache retention limit for an organization
10+
11+
Sets GitHub Actions cache retention limit for an organization. All repositories under this
12+
organization may not set a higher cache retention limit.
13+
14+
OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.
15+
16+
```js
17+
octokit.rest.actions.setActionsCacheRetentionLimitForOrganization({
18+
org,
19+
});
20+
```
21+
22+
## Parameters
23+
24+
<table>
25+
<thead>
26+
<tr>
27+
<th>name</th>
28+
<th>required</th>
29+
<th>description</th>
30+
</tr>
31+
</thead>
32+
<tbody>
33+
<tr><td>org</td><td>yes</td><td>
34+
35+
The organization name. The name is not case sensitive.
36+
37+
</td></tr>
38+
<tr><td>max_cache_retention_days</td><td>no</td><td>
39+
40+
For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.
41+
42+
</td></tr>
43+
</tbody>
44+
</table>
45+
46+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization).

0 commit comments

Comments
 (0)