Skip to content

Commit 1ea8d5a

Browse files
committed
docs: updated to latest OpenAPI spec
1 parent f23adf4 commit 1ea8d5a

File tree

593 files changed

+3876
-1677
lines changed

Some content is hidden

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

593 files changed

+3876
-1677
lines changed

docs/actions/addSelectedRepoToOrgSecret.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ type: API method
88

99
# Add selected repository to an organization secret
1010

11-
Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://developer.github.com/v3/actions/secrets/#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.
11+
Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.
1212

1313
```js
1414
octokit.actions.addSelectedRepoToOrgSecret({
1515
org,
1616
secret_name,
17-
repository_id,
17+
repository_id
1818
});
1919
```
2020

@@ -34,11 +34,13 @@ octokit.actions.addSelectedRepoToOrgSecret({
3434
</td></tr>
3535
<tr><td>secret_name</td><td>yes</td><td>
3636

37+
secret_name parameter
38+
3739
</td></tr>
3840
<tr><td>repository_id</td><td>yes</td><td>
3941

4042
</td></tr>
4143
</tbody>
4244
</table>
4345

44-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/secrets/#add-selected-repository-to-an-organization-secret).
46+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#add-selected-repository-to-an-organization-secret).

docs/actions/cancelWorkflowRun.md

Lines changed: 2 additions & 2 deletions
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

@@ -41,4 +41,4 @@ octokit.actions.cancelWorkflowRun({
4141
</tbody>
4242
</table>
4343

44-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/workflow-runs/#cancel-a-workflow-run).
44+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#cancel-a-workflow-run).

docs/actions/createOrUpdateOrgSecret.md

Lines changed: 10 additions & 8 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

@@ -106,10 +106,12 @@ octokit.actions.createOrUpdateOrgSecret({
106106
</td></tr>
107107
<tr><td>secret_name</td><td>yes</td><td>
108108

109+
secret_name parameter
110+
109111
</td></tr>
110112
<tr><td>encrypted_value</td><td>no</td><td>
111113

112-
Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://developer.github.com/v3/actions/secrets/#get-an-organization-public-key) endpoint.
114+
Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint.
113115

114116
</td></tr>
115117
<tr><td>key_id</td><td>no</td><td>
@@ -119,18 +121,18 @@ ID of the key you used to encrypt the secret.
119121
</td></tr>
120122
<tr><td>visibility</td><td>no</td><td>
121123

122-
Configures the access that repositories have to the organization secret. Can be one of:
123-
\- `all` - All repositories in an organization can access the secret.
124-
\- `private` - Private repositories in an organization can access the secret.
124+
Configures the access that repositories have to the organization secret. Can be one of:
125+
\- `all` - All repositories in an organization can access the secret.
126+
\- `private` - Private repositories in an organization can access the secret.
125127
\- `selected` - Only specific repositories can access the secret.
126128

127129
</td></tr>
128130
<tr><td>selected_repository_ids</td><td>no</td><td>
129131

130-
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://developer.github.com/v3/actions/secrets/#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://developer.github.com/v3/actions/secrets/#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://developer.github.com/v3/actions/secrets/#remove-selected-repository-from-an-organization-secret) endpoints.
132+
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.
131133

132134
</td></tr>
133135
</tbody>
134136
</table>
135137

136-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/secrets/#create-or-update-an-organization-secret).
138+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret).

docs/actions/createOrUpdateRepoSecret.md

Lines changed: 6 additions & 4 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

@@ -110,10 +110,12 @@ octokit.actions.createOrUpdateRepoSecret({
110110
</td></tr>
111111
<tr><td>secret_name</td><td>yes</td><td>
112112

113+
secret_name parameter
114+
113115
</td></tr>
114116
<tr><td>encrypted_value</td><td>no</td><td>
115117

116-
Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://developer.github.com/v3/actions/secrets/#get-a-repository-public-key) endpoint.
118+
Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint.
117119

118120
</td></tr>
119121
<tr><td>key_id</td><td>no</td><td>
@@ -124,4 +126,4 @@ ID of the key you used to encrypt the secret.
124126
</tbody>
125127
</table>
126128

127-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/secrets/#create-or-update-a-repository-secret).
129+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#create-or-update-a-repository-secret).

docs/actions/createRegistrationTokenForOrg.md

Lines changed: 2 additions & 2 deletions
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

@@ -43,4 +43,4 @@ octokit.actions.createRegistrationTokenForOrg({
4343
</tbody>
4444
</table>
4545

46-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self-hosted-runners/#create-a-registration-token-for-an-organization).
46+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#create-a-registration-token-for-an-organization).

docs/actions/createRegistrationTokenForRepo.md

Lines changed: 2 additions & 2 deletions
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

@@ -46,4 +46,4 @@ octokit.actions.createRegistrationTokenForRepo({
4646
</tbody>
4747
</table>
4848

49-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self-hosted-runners/#create-a-registration-token-for-a-repository).
49+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#create-a-registration-token-for-a-repository).

docs/actions/createRemoveTokenForOrg.md

Lines changed: 2 additions & 2 deletions
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

@@ -44,4 +44,4 @@ octokit.actions.createRemoveTokenForOrg({
4444
</tbody>
4545
</table>
4646

47-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self-hosted-runners/#create-a-remove-token-for-an-organization).
47+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#create-a-remove-token-for-an-organization).

docs/actions/createRemoveTokenForRepo.md

Lines changed: 2 additions & 2 deletions
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

@@ -46,4 +46,4 @@ octokit.actions.createRemoveTokenForRepo({
4646
</tbody>
4747
</table>
4848

49-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/self-hosted-runners/#create-a-remove-token-for-a-repository).
49+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#create-a-remove-token-for-a-repository).

docs/actions/createWorkflowDispatch.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ type: API method
88

99
# Create a workflow dispatch event
1010

11-
You can use this endpoint to manually trigger a GitHub Actions workflow run. You can also replace `{workflow_id}` with the workflow file name. For example, you could use `main.yml`.
11+
You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
1212

1313
You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)."
1414

15-
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. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)."
15+
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. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)."
1616

1717
```js
1818
octokit.actions.createWorkflowDispatch({
1919
owner,
2020
repo,
2121
workflow_id,
22-
ref,
22+
ref
2323
});
2424
```
2525

@@ -42,15 +42,17 @@ octokit.actions.createWorkflowDispatch({
4242
</td></tr>
4343
<tr><td>workflow_id</td><td>yes</td><td>
4444

45+
The ID of the workflow. You can also pass the workflow file name as a string.
46+
4547
</td></tr>
4648
<tr><td>ref</td><td>yes</td><td>
4749

48-
The reference of the workflow run. The reference can be a branch, tag, or a commit SHA.
50+
The git reference for the workflow. The reference can be a branch or tag name.
4951

5052
</td></tr>
5153
<tr><td>inputs</td><td>no</td><td>
5254

53-
Input keys and values configured in the workflow file. The maximum number of properties is 10.
55+
Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.
5456

5557
</td></tr>
5658
<tr><td>inputs.*</td><td>no</td><td>
@@ -59,4 +61,4 @@ Input keys and values configured in the workflow file. The maximum number of pro
5961
</tbody>
6062
</table>
6163

62-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/workflows/#create-a-workflow-dispatch-event).
64+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#create-a-workflow-dispatch-event).

docs/actions/deleteArtifact.md

Lines changed: 4 additions & 2 deletions
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

@@ -37,8 +37,10 @@ octokit.actions.deleteArtifact({
3737
</td></tr>
3838
<tr><td>artifact_id</td><td>yes</td><td>
3939

40+
artifact_id parameter
41+
4042
</td></tr>
4143
</tbody>
4244
</table>
4345

44-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/actions/artifacts/#delete-an-artifact).
46+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#delete-an-artifact).

0 commit comments

Comments
 (0)