Skip to content

Commit b4d64a1

Browse files
committed
docs: update for latenst OpenAPI spec
1 parent 3228865 commit b4d64a1

File tree

533 files changed

+587
-538
lines changed

Some content is hidden

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

533 files changed

+587
-538
lines changed

docs/actions/addSelectedRepoToOrgSecret.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Adds a repository to an organization secret when the `visibility` for repository
1414
octokit.actions.addSelectedRepoToOrgSecret({
1515
org,
1616
secret_name,
17-
repository_id
17+
repository_id,
1818
});
1919
```
2020

docs/actions/cancelWorkflowRun.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Cancels a workflow run using its `id`. You must authenticate using an access tok
1414
octokit.actions.cancelWorkflowRun({
1515
owner,
1616
repo,
17-
run_id
17+
run_id,
1818
});
1919
```
2020

docs/actions/createOrUpdateOrgSecret.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ def encrypt(public_key: str, secret_value: str) -> str:
5252
return b64encode(encrypted).decode("utf-8")
5353
```
5454

55-
#### Example encrypting a secret using C
55+
#### Example encrypting a secret using C#
5656

5757
Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
5858

@@ -86,7 +86,7 @@ puts Base64.strict_encode64(encrypted_secret)
8686
```js
8787
octokit.actions.createOrUpdateOrgSecret({
8888
org,
89-
secret_name
89+
secret_name,
9090
});
9191
```
9292

docs/actions/createOrUpdateRepoSecret.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ def encrypt(public_key: str, secret_value: str) -> str:
5252
return b64encode(encrypted).decode("utf-8")
5353
```
5454

55-
#### Example encrypting a secret using C
55+
#### Example encrypting a secret using C#
5656

5757
Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
5858

@@ -87,7 +87,7 @@ puts Base64.strict_encode64(encrypted_secret)
8787
octokit.actions.createOrUpdateRepoSecret({
8888
owner,
8989
repo,
90-
secret_name
90+
secret_name,
9191
});
9292
```
9393

docs/actions/createRegistrationTokenForOrg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Configure your self-hosted runner, replacing `TOKEN` with the registration token
2222

2323
```js
2424
octokit.actions.createRegistrationTokenForOrg({
25-
org
25+
org,
2626
});
2727
```
2828

docs/actions/createRegistrationTokenForRepo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Configure your self-hosted runner, replacing `TOKEN` with the registration token
2222
```js
2323
octokit.actions.createRegistrationTokenForRepo({
2424
owner,
25-
repo
25+
repo,
2626
});
2727
```
2828

docs/actions/createRemoveTokenForOrg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ endpoint.
2323

2424
```js
2525
octokit.actions.createRemoveTokenForOrg({
26-
org
26+
org,
2727
});
2828
```
2929

docs/actions/createRemoveTokenForRepo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ To remove your self-hosted runner from a repository, replace TOKEN with the remo
2222
```js
2323
octokit.actions.createRemoveTokenForRepo({
2424
owner,
25-
repo
25+
repo,
2626
});
2727
```
2828

docs/actions/createWorkflowDispatch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ octokit.actions.createWorkflowDispatch({
1919
owner,
2020
repo,
2121
workflow_id,
22-
ref
22+
ref,
2323
});
2424
```
2525

docs/actions/deleteArtifact.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Deletes an artifact for a workflow run. You must authenticate using an access to
1414
octokit.actions.deleteArtifact({
1515
owner,
1616
repo,
17-
artifact_id
17+
artifact_id,
1818
});
1919
```
2020

docs/actions/deleteOrgSecret.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Deletes a secret in an organization using the secret name. You must authenticate
1313
```js
1414
octokit.actions.deleteOrgSecret({
1515
org,
16-
secret_name
16+
secret_name,
1717
});
1818
```
1919

docs/actions/deleteRepoSecret.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Deletes a secret in a repository using the secret name. You must authenticate us
1414
octokit.actions.deleteRepoSecret({
1515
owner,
1616
repo,
17-
secret_name
17+
secret_name,
1818
});
1919
```
2020

docs/actions/deleteSelfHostedRunnerFromOrg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You must authenticate using an access token with the `admin:org` scope to use th
1515
```js
1616
octokit.actions.deleteSelfHostedRunnerFromOrg({
1717
org,
18-
runner_id
18+
runner_id,
1919
});
2020
```
2121

docs/actions/deleteSelfHostedRunnerFromRepo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ scope to use this endpoint.
1717
octokit.actions.deleteSelfHostedRunnerFromRepo({
1818
owner,
1919
repo,
20-
runner_id
20+
runner_id,
2121
});
2222
```
2323

docs/actions/deleteWorkflowRun.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ this endpoint.
1616
octokit.actions.deleteWorkflowRun({
1717
owner,
1818
repo,
19-
run_id
19+
run_id,
2020
});
2121
```
2222

docs/actions/deleteWorkflowRunLogs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Deletes all logs for a workflow run. You must authenticate using an access token
1414
octokit.actions.deleteWorkflowRunLogs({
1515
owner,
1616
repo,
17-
run_id
17+
run_id,
1818
});
1919
```
2020

docs/actions/disableSelectedRepositoryGithubActionsOrganization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You must authenticate using an access token with the `admin:org` scope to use th
1515
```js
1616
octokit.actions.disableSelectedRepositoryGithubActionsOrganization({
1717
org,
18-
repository_id
18+
repository_id,
1919
});
2020
```
2121

docs/actions/disableWorkflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ You must authenticate using an access token with the `repo` scope to use this en
1616
octokit.actions.disableWorkflow({
1717
owner,
1818
repo,
19-
workflow_id
19+
workflow_id,
2020
});
2121
```
2222

docs/actions/downloadArtifact.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ octokit.actions.downloadArtifact({
1818
owner,
1919
repo,
2020
artifact_id,
21-
archive_format
21+
archive_format,
2222
});
2323
```
2424

docs/actions/downloadJobLogsForWorkflowRun.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ have the `actions:read` permission to use this endpoint.
1717
octokit.actions.downloadJobLogsForWorkflowRun({
1818
owner,
1919
repo,
20-
job_id
20+
job_id,
2121
});
2222
```
2323

docs/actions/downloadWorkflowRunLogs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ the `actions:read` permission to use this endpoint.
1717
octokit.actions.downloadWorkflowRunLogs({
1818
owner,
1919
repo,
20-
run_id
20+
run_id,
2121
});
2222
```
2323

docs/actions/enableSelectedRepositoryGithubActionsOrganization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You must authenticate using an access token with the `admin:org` scope to use th
1515
```js
1616
octokit.actions.enableSelectedRepositoryGithubActionsOrganization({
1717
org,
18-
repository_id
18+
repository_id,
1919
});
2020
```
2121

docs/actions/enableWorkflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ You must authenticate using an access token with the `repo` scope to use this en
1616
octokit.actions.enableWorkflow({
1717
owner,
1818
repo,
19-
workflow_id
19+
workflow_id,
2020
});
2121
```
2222

docs/actions/getAllowedActionsOrganization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ You must authenticate using an access token with the `admin:org` scope to use th
1414

1515
```js
1616
octokit.actions.getAllowedActionsOrganization({
17-
org
17+
org,
1818
});
1919
```
2020

docs/actions/getAllowedActionsRepository.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You must authenticate using an access token with the `repo` scope to use this en
1515
```js
1616
octokit.actions.getAllowedActionsRepository({
1717
owner,
18-
repo
18+
repo,
1919
});
2020
```
2121

docs/actions/getArtifact.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Gets a specific artifact for a workflow run. Anyone with read access to the repo
1414
octokit.actions.getArtifact({
1515
owner,
1616
repo,
17-
artifact_id
17+
artifact_id,
1818
});
1919
```
2020

docs/actions/getGithubActionsPermissionsOrganization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ You must authenticate using an access token with the `admin:org` scope to use th
1414

1515
```js
1616
octokit.actions.getGithubActionsPermissionsOrganization({
17-
org
17+
org,
1818
});
1919
```
2020

docs/actions/getGithubActionsPermissionsRepository.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ endpoint. GitHub Apps must have the `administration` repository permission to us
1616
```js
1717
octokit.actions.getGithubActionsPermissionsRepository({
1818
owner,
19-
repo
19+
repo,
2020
});
2121
```
2222

docs/actions/getJobForWorkflowRun.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Gets a specific job in a workflow run. Anyone with read access to the repository
1414
octokit.actions.getJobForWorkflowRun({
1515
owner,
1616
repo,
17-
job_id
17+
job_id,
1818
});
1919
```
2020

docs/actions/getOrgPublicKey.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Gets your public key, which you need to encrypt secrets. You need to encrypt a s
1212

1313
```js
1414
octokit.actions.getOrgPublicKey({
15-
org
15+
org,
1616
});
1717
```
1818

docs/actions/getOrgSecret.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Gets a single organization secret without revealing its encrypted value. You mus
1313
```js
1414
octokit.actions.getOrgSecret({
1515
org,
16-
secret_name
16+
secret_name,
1717
});
1818
```
1919

docs/actions/getRepoPermissions.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
---
2-
name: Get a repository's Actions permissions
2+
name: Get GitHub Actions permissions for a repository
33
example: octokit.actions.getRepoPermissions({ owner, repo })
44
route: GET /repos/{owner}/{repo}/actions/permissions
55
scope: actions
66
type: API method
77
---
88

9-
# Get a repository's Actions permissions
9+
# Get GitHub Actions permissions for a repository
1010

11-
Gets the repository's permissions for running GitHub Actions. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the full `repo` permission to use this endpoint.
11+
**Deprecated:** This method has been renamed to actions.getGithubActionsPermissionsRepository
12+
13+
Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.
14+
15+
You must authenticate using an access token with the `repo` scope to use this
16+
endpoint. GitHub Apps must have the `administration` repository permission to use this API.
1217

1318
```js
1419
octokit.actions.getRepoPermissions({
@@ -37,4 +42,4 @@ octokit.actions.getRepoPermissions({
3742
</tbody>
3843
</table>
3944

40-
See also: [GitHub Developer Guide documentation]().
45+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository).

docs/actions/getRepoPublicKey.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Gets your public key, which you need to encrypt secrets. You need to encrypt a s
1313
```js
1414
octokit.actions.getRepoPublicKey({
1515
owner,
16-
repo
16+
repo,
1717
});
1818
```
1919

docs/actions/getRepoSecret.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Gets a single repository secret without revealing its encrypted value. You must
1414
octokit.actions.getRepoSecret({
1515
owner,
1616
repo,
17-
secret_name
17+
secret_name,
1818
});
1919
```
2020

docs/actions/getSelfHostedRunnerForOrg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You must authenticate using an access token with the `admin:org` scope to use th
1515
```js
1616
octokit.actions.getSelfHostedRunnerForOrg({
1717
org,
18-
runner_id
18+
runner_id,
1919
});
2020
```
2121

docs/actions/getSelfHostedRunnerForRepo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ endpoint.
1717
octokit.actions.getSelfHostedRunnerForRepo({
1818
owner,
1919
repo,
20-
runner_id
20+
runner_id,
2121
});
2222
```
2323

docs/actions/getWorkflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Gets a specific workflow. You can replace `workflow_id` with the workflow file n
1414
octokit.actions.getWorkflow({
1515
owner,
1616
repo,
17-
workflow_id
17+
workflow_id,
1818
});
1919
```
2020

docs/actions/getWorkflowRun.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Gets a specific workflow run. Anyone with read access to the repository can use
1414
octokit.actions.getWorkflowRun({
1515
owner,
1616
repo,
17-
run_id
17+
run_id,
1818
});
1919
```
2020

docs/actions/getWorkflowRunUsage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Anyone with read access to the repository can use this endpoint. If the reposito
1818
octokit.actions.getWorkflowRunUsage({
1919
owner,
2020
repo,
21-
run_id
21+
run_id,
2222
});
2323
```
2424

docs/actions/getWorkflowUsage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You can replace `workflow_id` with the workflow file name. For example, you coul
1818
octokit.actions.getWorkflowUsage({
1919
owner,
2020
repo,
21-
workflow_id
21+
workflow_id,
2222
});
2323
```
2424

0 commit comments

Comments
 (0)