Skip to content

Commit e0203a8

Browse files
committed
docs: correct parameter syntax
1 parent 389af2e commit e0203a8

File tree

582 files changed

+2467
-664
lines changed

Some content is hidden

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

582 files changed

+2467
-664
lines changed

docs/actions/cancelWorkflowRun.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
Cancels a workflow run using its `id`. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
44

55
```js
6-
octokit.actions.cancelWorkflowRun(owner, repo, run_id);
6+
octokit.actions.cancelWorkflowRun({
7+
owner,
8+
repo,
9+
run_id
10+
});
711
```
812

913
## Parameters

docs/actions/createOrUpdateSecretForRepo.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,11 @@ Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodiu
1111
Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
1212

1313
```js
14-
octokit.actions.createOrUpdateSecretForRepo(owner, repo, name);
14+
octokit.actions.createOrUpdateSecretForRepo({
15+
owner,
16+
repo,
17+
name
18+
});
1519
```
1620

1721
## Parameters

docs/actions/createRegistrationToken.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@ Returns a token that you can pass to the `config` script. The token expires afte
55
Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
66

77
```js
8-
octokit.actions.createRegistrationToken(owner, repo);
8+
octokit.actions.createRegistrationToken({
9+
owner,
10+
repo
11+
});
912
```
1013

1114
## Parameters

docs/actions/createRemoveToken.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@ Returns a token that you can pass to remove a self-hosted runner from a reposito
55
Remove your self-hosted runner from a repository, replacing TOKEN with the remove token provided by this endpoint.
66

77
```js
8-
octokit.actions.createRemoveToken(owner, repo);
8+
octokit.actions.createRemoveToken({
9+
owner,
10+
repo
11+
});
912
```
1013

1114
## Parameters

docs/actions/deleteArtifact.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
Deletes an artifact for a workflow run. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
44

55
```js
6-
octokit.actions.deleteArtifact(owner, repo, artifact_id);
6+
octokit.actions.deleteArtifact({
7+
owner,
8+
repo,
9+
artifact_id
10+
});
711
```
812

913
## Parameters

docs/actions/deleteSecretFromRepo.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
Deletes a secret in a repository using the secret name. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.
44

55
```js
6-
octokit.actions.deleteSecretFromRepo(owner, repo, name);
6+
octokit.actions.deleteSecretFromRepo({
7+
owner,
8+
repo,
9+
name
10+
});
711
```
812

913
## Parameters

docs/actions/downloadArtifact.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,12 @@ Gets a redirect URL to download an archive for a repository. This URL expires af
55
Call this endpoint using the `-v` flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the `-o` flag.
66

77
```js
8-
octokit.actions.downloadArtifact(owner, repo, artifact_id, archive_format);
8+
octokit.actions.downloadArtifact({
9+
owner,
10+
repo,
11+
artifact_id,
12+
archive_format
13+
});
914
```
1015

1116
## Parameters

docs/actions/getArtifact.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
44

55
```js
6-
octokit.actions.getArtifact(owner, repo, artifact_id);
6+
octokit.actions.getArtifact({
7+
owner,
8+
repo,
9+
artifact_id
10+
});
711
```
812

913
## Parameters

docs/actions/getPublicKey.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
Gets your public key, which you must store. You need your public key to use other secrets endpoints. Use the returned `key` to encrypt your secrets. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.
44

55
```js
6-
octokit.actions.getPublicKey(owner, repo);
6+
octokit.actions.getPublicKey({
7+
owner,
8+
repo
9+
});
710
```
811

912
## Parameters

docs/actions/getSecret.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
Gets a single secret without revealing its encrypted value. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.
44

55
```js
6-
octokit.actions.getSecret(owner, repo, name);
6+
octokit.actions.getSecret({
7+
owner,
8+
repo,
9+
name
10+
});
711
```
812

913
## Parameters

docs/actions/getSelfHostedRunner.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
Gets a specific self-hosted runner. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.
44

55
```js
6-
octokit.actions.getSelfHostedRunner(owner, repo, runner_id);
6+
octokit.actions.getSelfHostedRunner({
7+
owner,
8+
repo,
9+
runner_id
10+
});
711
```
812

913
## Parameters

docs/actions/getWorkflow.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
Gets a specific workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yml`. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
44

55
```js
6-
octokit.actions.getWorkflow(owner, repo, workflow_id);
6+
octokit.actions.getWorkflow({
7+
owner,
8+
repo,
9+
workflow_id
10+
});
711
```
812

913
## Parameters

docs/actions/getWorkflowJob.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
44

55
```js
6-
octokit.actions.getWorkflowJob(owner, repo, job_id);
6+
octokit.actions.getWorkflowJob({
7+
owner,
8+
repo,
9+
job_id
10+
});
711
```
812

913
## Parameters

docs/actions/getWorkflowRun.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
44

55
```js
6-
octokit.actions.getWorkflowRun(owner, repo, run_id);
6+
octokit.actions.getWorkflowRun({
7+
owner,
8+
repo,
9+
run_id
10+
});
711
```
812

913
## Parameters

docs/actions/listDownloadsForSelfHostedRunnerApplication.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
Lists binaries for the self-hosted runner application that you can download and run. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.
44

55
```js
6-
octokit.actions.listDownloadsForSelfHostedRunnerApplication(owner, repo);
6+
octokit.actions.listDownloadsForSelfHostedRunnerApplication({
7+
owner,
8+
repo
9+
});
710
```
811

912
## Parameters

docs/actions/listJobsForWorkflowRun.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
44

55
```js
6-
octokit.actions.listJobsForWorkflowRun(owner, repo, run_id);
6+
octokit.actions.listJobsForWorkflowRun({
7+
owner,
8+
repo,
9+
run_id
10+
});
711
```
812

913
## Parameters

docs/actions/listRepoWorkflowRuns.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@ Lists all workflow runs for a repository. You can use parameters to narrow the l
55
Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
66

77
```js
8-
octokit.actions.listRepoWorkflowRuns(owner, repo);
8+
octokit.actions.listRepoWorkflowRuns({
9+
owner,
10+
repo
11+
});
912
```
1013

1114
## Parameters

docs/actions/listRepoWorkflows.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
44

55
```js
6-
octokit.actions.listRepoWorkflows(owner, repo);
6+
octokit.actions.listRepoWorkflows({
7+
owner,
8+
repo
9+
});
710
```
811

912
## Parameters

docs/actions/listSecretsForRepo.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
Lists all secrets available in a repository without revealing their encrypted values. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.
44

55
```js
6-
octokit.actions.listSecretsForRepo(owner, repo);
6+
octokit.actions.listSecretsForRepo({
7+
owner,
8+
repo
9+
});
710
```
811

912
## Parameters

docs/actions/listSelfHostedRunnersForRepo.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
Lists all self-hosted runners for a repository. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.
44

55
```js
6-
octokit.actions.listSelfHostedRunnersForRepo(owner, repo);
6+
octokit.actions.listSelfHostedRunnersForRepo({
7+
owner,
8+
repo
9+
});
710
```
811

912
## Parameters

docs/actions/listWorkflowJobLogs.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ Gets a redirect URL to download a plain text file of logs for a workflow job. Th
55
Call this endpoint using the `-v` flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the `-o` flag.
66

77
```js
8-
octokit.actions.listWorkflowJobLogs(owner, repo, job_id);
8+
octokit.actions.listWorkflowJobLogs({
9+
owner,
10+
repo,
11+
job_id
12+
});
913
```
1014

1115
## Parameters

docs/actions/listWorkflowRunArtifacts.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
44

55
```js
6-
octokit.actions.listWorkflowRunArtifacts(owner, repo, run_id);
6+
octokit.actions.listWorkflowRunArtifacts({
7+
owner,
8+
repo,
9+
run_id
10+
});
711
```
812

913
## Parameters

docs/actions/listWorkflowRunLogs.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ Gets a redirect URL to download an archive of log files for a workflow run. This
55
Call this endpoint using the `-v` flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the `-o` flag.
66

77
```js
8-
octokit.actions.listWorkflowRunLogs(owner, repo, run_id);
8+
octokit.actions.listWorkflowRunLogs({
9+
owner,
10+
repo,
11+
run_id
12+
});
913
```
1014

1115
## Parameters

docs/actions/listWorkflowRuns.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ List all workflow runs for a workflow. You can also replace `:workflow_id` with
55
Anyone with read access to the repository can use this endpoint.
66

77
```js
8-
octokit.actions.listWorkflowRuns(owner, repo, workflow_id);
8+
octokit.actions.listWorkflowRuns({
9+
owner,
10+
repo,
11+
workflow_id
12+
});
913
```
1014

1115
## Parameters

docs/actions/reRunWorkflow.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
Re-runs your workflow run using its `id`. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.
44

55
```js
6-
octokit.actions.reRunWorkflow(owner, repo, run_id);
6+
octokit.actions.reRunWorkflow({
7+
owner,
8+
repo,
9+
run_id
10+
});
711
```
812

913
## Parameters

docs/actions/removeSelfHostedRunner.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.
44

55
```js
6-
octokit.actions.removeSelfHostedRunner(owner, repo, runner_id);
6+
octokit.actions.removeSelfHostedRunner({
7+
owner,
8+
repo,
9+
runner_id
10+
});
711
```
812

913
## Parameters

docs/activity/checkStarringRepo.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
Requires for the user to be authenticated.
44

55
```js
6-
octokit.activity.checkStarringRepo(owner, repo);
6+
octokit.activity.checkStarringRepo({
7+
owner,
8+
repo
9+
});
710
```
811

912
## Parameters

docs/activity/checkWatchingRepoLegacy.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
Requires for the user to be authenticated.
44

55
```js
6-
octokit.activity.checkWatchingRepoLegacy(owner, repo);
6+
octokit.activity.checkWatchingRepoLegacy({
7+
owner,
8+
repo
9+
});
710
```
811

912
## Parameters

docs/activity/deleteRepoSubscription.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://developer.github.com/v3/activity/watching/#set-a-repository-subscription).
44

55
```js
6-
octokit.activity.deleteRepoSubscription(owner, repo);
6+
octokit.activity.deleteRepoSubscription({
7+
owner,
8+
repo
9+
});
710
```
811

912
## Parameters

docs/activity/deleteThreadSubscription.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
Mutes all future notifications for a conversation until you comment on the thread or get **@mention**ed.
44

55
```js
6-
octokit.activity.deleteThreadSubscription(thread_id);
6+
octokit.activity.deleteThreadSubscription({
7+
thread_id
8+
});
79
```
810

911
## Parameters

docs/activity/getRepoSubscription.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Get a Repository Subscription
22

33
```js
4-
octokit.activity.getRepoSubscription(owner, repo);
4+
octokit.activity.getRepoSubscription({
5+
owner,
6+
repo
7+
});
58
```
69

710
## Parameters

0 commit comments

Comments
 (0)