Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions docs/actions/deleteActionsCacheById.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
name: Delete a GitHub Actions cache for a repository (using a cache ID)
example: octokit.rest.actions.deleteActionsCacheById({ owner, repo, cache_id })
route: DELETE /repos/{owner}/{repo}/actions/caches/{cache_id}
scope: actions
type: API method
---

# Delete a GitHub Actions cache for a repository (using a cache ID)

Deletes a GitHub Actions cache for a repository, using a cache ID.

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.

```js
octokit.rest.actions.deleteActionsCacheById({
owner,
repo,
cache_id,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>owner</td><td>yes</td><td>

The account owner of the repository. The name is not case sensitive.

</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.

</td></tr>
<tr><td>cache_id</td><td>yes</td><td>

The unique identifier of the GitHub Actions cache.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id).
59 changes: 59 additions & 0 deletions docs/actions/deleteActionsCacheByKey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
name: Delete GitHub Actions caches for a repository (using a cache key)
example: octokit.rest.actions.deleteActionsCacheByKey({ owner, repo, key })
route: DELETE /repos/{owner}/{repo}/actions/caches{?key,ref}
scope: actions
type: API method
---

# Delete GitHub Actions caches for a repository (using a cache key)

Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

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.

```js
octokit.rest.actions.deleteActionsCacheByKey({
owner,
repo,
key,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>owner</td><td>yes</td><td>

The account owner of the repository. The name is not case sensitive.

</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.

</td></tr>
<tr><td>key</td><td>yes</td><td>

A key for identifying the cache.

</td></tr>
<tr><td>ref</td><td>no</td><td>

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`.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key).
76 changes: 76 additions & 0 deletions docs/actions/getActionsCacheList.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
name: List GitHub Actions caches for a repository
example: octokit.rest.actions.getActionsCacheList({ owner, repo })
route: GET /repos/{owner}/{repo}/actions/caches
scope: actions
type: API method
---

# List GitHub Actions caches for a repository

Lists the GitHub Actions caches for a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `actions:read` permission to use this endpoint.

```js
octokit.rest.actions.getActionsCacheList({
owner,
repo,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>owner</td><td>yes</td><td>

The account owner of the repository. The name is not case sensitive.

</td></tr>
<tr><td>repo</td><td>yes</td><td>

The name of the repository. The name is not case sensitive.

</td></tr>
<tr><td>per_page</td><td>no</td><td>

The number of results per page (max 100).

</td></tr>
<tr><td>page</td><td>no</td><td>

Page number of the results to fetch.

</td></tr>
<tr><td>ref</td><td>no</td><td>

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`.

</td></tr>
<tr><td>key</td><td>no</td><td>

An explicit key or prefix for identifying the cache

</td></tr>
<tr><td>sort</td><td>no</td><td>

The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes.

</td></tr>
<tr><td>direction</td><td>no</td><td>

The direction to sort the results by.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository).
45 changes: 45 additions & 0 deletions docs/actions/setActionsOidcCustomIssuerPolicyForEnterprise.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: Set the GitHub Actions OIDC custom issuer policy for an enterprise
example: octokit.rest.actions.setActionsOidcCustomIssuerPolicyForEnterprise({ enterprise })
route: PUT /enterprises/{enterprise}/actions/oidc/customization/issuer
scope: actions
type: API method
---

# Set the GitHub Actions OIDC custom issuer policy for an enterprise

Sets the GitHub Actions OpenID Connect (OIDC) custom issuer policy for an enterprise.
You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
GitHub Apps must have the `enterprise_administration:write` permission to use this endpoint.

```js
octokit.rest.actions.setActionsOidcCustomIssuerPolicyForEnterprise({
enterprise,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>enterprise</td><td>yes</td><td>

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

</td></tr>
<tr><td>include_enterprise_slug</td><td>no</td><td>

Whether the enterprise customer requested a custom issuer URL.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions/oidc#set-actions-oidc-custom-issuer-policy-for-enterprise).
5 changes: 5 additions & 0 deletions docs/codespaces/createForAuthenticatedUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,11 @@ Time in minutes before codespace stops from inactivity

Display name for this codespace

</td></tr>
<tr><td>retention_period_minutes</td><td>no</td><td>

Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).

</td></tr>
<tr><td>pull_request</td><td>yes</td><td>

Expand Down
5 changes: 5 additions & 0 deletions docs/codespaces/createWithPrForAuthenticatedUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,11 @@ Time in minutes before codespace stops from inactivity

Display name for this codespace

</td></tr>
<tr><td>retention_period_minutes</td><td>no</td><td>

Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).

</td></tr>
</tbody>
</table>
Expand Down
5 changes: 5 additions & 0 deletions docs/codespaces/createWithRepoForAuthenticatedUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,11 @@ Time in minutes before codespace stops from inactivity

Display name for this codespace

</td></tr>
<tr><td>retention_period_minutes</td><td>no</td><td>

Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).

</td></tr>
</tbody>
</table>
Expand Down
52 changes: 52 additions & 0 deletions docs/codespaces/deleteFromOrganization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
name: Delete a codespace from the organization
example: octokit.rest.codespaces.deleteFromOrganization({ org, username, codespace_name })
route: DELETE /orgs/{org}/members/{username}/codespaces/{codespace_name}
scope: codespaces
type: API method
---

# Delete a codespace from the organization

Deletes a user's codespace.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.

```js
octokit.rest.codespaces.deleteFromOrganization({
org,
username,
codespace_name,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>org</td><td>yes</td><td>

The organization name. The name is not case sensitive.

</td></tr>
<tr><td>username</td><td>yes</td><td>

The handle for the GitHub user account.

</td></tr>
<tr><td>codespace_name</td><td>yes</td><td>

The name of the codespace.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces).
50 changes: 50 additions & 0 deletions docs/codespaces/listInOrganization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
name: List codespaces for the organization
example: octokit.rest.codespaces.listInOrganization({ org_id })
route: GET /orgs/{org_id}/codespaces
scope: codespaces
type: API method
---

# List codespaces for the organization

Lists the codespaces associated to a specified organization.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.

```js
octokit.rest.codespaces.listInOrganization({
org_id,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>per_page</td><td>no</td><td>

The number of results per page (max 100).

</td></tr>
<tr><td>page</td><td>no</td><td>

Page number of the results to fetch.

</td></tr>
<tr><td>org_id</td><td>yes</td><td>

The unique identifier of the organization.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-in-organization).
Loading