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

0 commit comments

Comments
 (0)