diff --git a/docs/actions/deleteActionsCacheById.md b/docs/actions/deleteActionsCacheById.md new file mode 100644 index 000000000..6c254e2e8 --- /dev/null +++ b/docs/actions/deleteActionsCacheById.md @@ -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 + +
name | +required | +description | +
---|---|---|
owner | yes | + +The account owner of the repository. The name is not case sensitive. + + |
repo | yes | + +The name of the repository. The name is not case sensitive. + + |
cache_id | yes | + +The unique identifier of the GitHub Actions cache. + + |
name | +required | +description | +
---|---|---|
owner | yes | + +The account owner of the repository. The name is not case sensitive. + + |
repo | yes | + +The name of the repository. The name is not case sensitive. + + |
key | yes | + +A key for identifying the cache. + + |
ref | no |
+
+The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/ |
name | +required | +description | +
---|---|---|
owner | yes | + +The account owner of the repository. The name is not case sensitive. + + |
repo | yes | + +The name of the repository. The name is not case sensitive. + + |
per_page | no | + +The number of results per page (max 100). + + |
page | no | + +Page number of the results to fetch. + + |
ref | no |
+
+The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/ |
key | no | + +An explicit key or prefix for identifying the cache + + |
sort | no | + +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. + + |
direction | no | + +The direction to sort the results by. + + |
name | +required | +description | +
---|---|---|
enterprise | yes | + +The slug version of the enterprise name. You can also substitute this value with the enterprise id. + + |
include_enterprise_slug | no | + +Whether the enterprise customer requested a custom issuer URL. + + |
name | +required | +description | +
---|---|---|
org | yes | + +The organization name. The name is not case sensitive. + + |
username | yes | + +The handle for the GitHub user account. + + |
codespace_name | yes | + +The name of the codespace. + + |
name | +required | +description | +
---|---|---|
per_page | no | + +The number of results per page (max 100). + + |
page | no | + +Page number of the results to fetch. + + |
org_id | yes | + +The unique identifier of the organization. + + |
name | +required | +description | +
---|---|---|
org | yes | + +The organization name. The name is not case sensitive. + + |
username | yes | + +The handle for the GitHub user account. + + |
codespace_name | yes | + +The name of the codespace. + + |
name | +required | +description | +
---|---|---|
owner | yes | + +The account owner of the repository. The name is not case sensitive. + + |
repo | yes | + +The name of the repository. The name is not case sensitive. + + |
version | yes | + +The version of the repository snapshot submission. + + |
job | yes | + + |
job.id | yes | + +The external ID of the job. + + |
job.correlator | yes | + +Correlator provides a key that is used to group snapshots submitted over time. Only the "latest" submitted snapshot for a given combination of `job.correlator` and `detector.name` will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given "wave" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation. + + |
job.html_url | no | + +The url for the job. + + |
sha | yes | + +The commit SHA associated with this dependency snapshot. + + |
ref | yes | + +The repository branch that triggered this snapshot. + + |
detector | yes | + +A description of the detector used. + + |
detector.name | yes | + +The name of the detector used. + + |
detector.version | yes | + +The version of the detector used. + + |
detector.url | yes | + +The url of the detector used. + + |
metadata | no | + +User-defined metadata to store domain-specific information limited to 8 keys with scalar values. + + |
metadata.* | no | + + |
manifests | no | + +A collection of package manifests + + |
manifests.* | no | + +A collection of related dependencies declared in a file or representing a logical group of dependencies. + + |
manifests.*.name | yes | + +The name of the manifest. + + |
manifests.*.file | no | + + |
manifests.*.file.source_location | no | + +The path of the manifest file relative to the root of the Git repository. + + |
manifests.*.metadata | no | + +User-defined metadata to store domain-specific information limited to 8 keys with scalar values. + + |
manifests.*.metadata.* | no | + + |
manifests.*.resolved | no | + + |
scanned | yes | + +The time at which the snapshot was scanned. + + |