Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion docs/actions/cancelWorkflowRun.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Cancels a workflow run using its `id`. Anyone with write access to the repositor
octokit.actions.cancelWorkflowRun({
owner,
repo,
run_id
run_id,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/createOrUpdateSecretForRepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem
octokit.actions.createOrUpdateSecretForRepo({
owner,
repo,
name
name,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/createRegistrationToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Configure your self-hosted runner, replacing TOKEN with the registration token p
```js
octokit.actions.createRegistrationToken({
owner,
repo
repo,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/createRemoveToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Remove your self-hosted runner from a repository, replacing TOKEN with the remov
```js
octokit.actions.createRemoveToken({
owner,
repo
repo,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/deleteArtifact.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Deletes an artifact for a workflow run. Anyone with write access to the reposito
octokit.actions.deleteArtifact({
owner,
repo,
artifact_id
artifact_id,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/deleteSecretFromRepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Deletes a secret in a repository using the secret name. Anyone with write access
octokit.actions.deleteSecretFromRepo({
owner,
repo,
name
name,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/downloadArtifact.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ octokit.actions.downloadArtifact({
owner,
repo,
artifact_id,
archive_format
archive_format,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/getArtifact.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Gets a specific artifact for a workflow run. Anyone with read access to the repo
octokit.actions.getArtifact({
owner,
repo,
artifact_id
artifact_id,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/getPublicKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Gets your public key, which you must store. You need your public key to use othe
```js
octokit.actions.getPublicKey({
owner,
repo
repo,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/getSecret.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Gets a single secret without revealing its encrypted value. Anyone with write ac
octokit.actions.getSecret({
owner,
repo,
name
name,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/getSelfHostedRunner.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Gets a specific self-hosted runner. Anyone with admin access to the repository c
octokit.actions.getSelfHostedRunner({
owner,
repo,
runner_id
runner_id,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/getWorkflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Gets a specific workflow. You can also replace `:workflow_id` with `:workflow_fi
octokit.actions.getWorkflow({
owner,
repo,
workflow_id
workflow_id,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/getWorkflowJob.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Gets a specific job in a workflow run. Anyone with read access to the repository
octokit.actions.getWorkflowJob({
owner,
repo,
job_id
job_id,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/getWorkflowRun.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Gets a specific workflow run. Anyone with read access to the repository can use
octokit.actions.getWorkflowRun({
owner,
repo,
run_id
run_id,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/listArtifactsForRepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Lists all artifacts for a repository. Anyone with read access to the repository
```js
octokit.actions.listArtifactsForRepo({
owner,
repo
repo,
});
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Lists binaries for the self-hosted runner application that you can download and
```js
octokit.actions.listDownloadsForSelfHostedRunnerApplication({
owner,
repo
repo,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/listJobsForWorkflowRun.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Lists jobs for a workflow run. Anyone with read access to the repository can use
octokit.actions.listJobsForWorkflowRun({
owner,
repo,
run_id
run_id,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/listRepoWorkflowRuns.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Anyone with read access to the repository can use this endpoint. GitHub Apps mus
```js
octokit.actions.listRepoWorkflowRuns({
owner,
repo
repo,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/listRepoWorkflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Lists the workflows in a repository. Anyone with read access to the repository c
```js
octokit.actions.listRepoWorkflows({
owner,
repo
repo,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/listSecretsForRepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Lists all secrets available in a repository without revealing their encrypted va
```js
octokit.actions.listSecretsForRepo({
owner,
repo
repo,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/listSelfHostedRunnersForRepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Lists all self-hosted runners for a repository. Anyone with admin access to the
```js
octokit.actions.listSelfHostedRunnersForRepo({
owner,
repo
repo,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/listWorkflowJobLogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Call this endpoint using the `-v` flag, which enables verbose output and allows
octokit.actions.listWorkflowJobLogs({
owner,
repo,
job_id
job_id,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/listWorkflowRunArtifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Lists artifacts for a workflow run. Anyone with read access to the repository ca
octokit.actions.listWorkflowRunArtifacts({
owner,
repo,
run_id
run_id,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/listWorkflowRunLogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Call this endpoint using the `-v` flag, which enables verbose output and allows
octokit.actions.listWorkflowRunLogs({
owner,
repo,
run_id
run_id,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/listWorkflowRuns.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Anyone with read access to the repository can use this endpoint.
octokit.actions.listWorkflowRuns({
owner,
repo,
workflow_id
workflow_id,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/reRunWorkflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Re-runs your workflow run using its `id`. Anyone with write access to the reposi
octokit.actions.reRunWorkflow({
owner,
repo,
run_id
run_id,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/actions/removeSelfHostedRunner.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Forces the removal of a self-hosted runner from a repository. You can use this e
octokit.actions.removeSelfHostedRunner({
owner,
repo,
runner_id
runner_id,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/activity/checkStarringRepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Requires for the user to be authenticated.
```js
octokit.activity.checkStarringRepo({
owner,
repo
repo,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/activity/deleteRepoSubscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This endpoint should only be used to stop watching a repository. To control whet
```js
octokit.activity.deleteRepoSubscription({
owner,
repo
repo,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/activity/deleteThreadSubscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Mutes all future notifications for a conversation until you comment on the threa

```js
octokit.activity.deleteThreadSubscription({
thread_id
thread_id,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/activity/getRepoSubscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
```js
octokit.activity.getRepoSubscription({
owner,
repo
repo,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/activity/getThread.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

```js
octokit.activity.getThread({
thread_id
thread_id,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/activity/getThreadSubscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Note that subscriptions are only generated if a user is participating in a conve

```js
octokit.activity.getThreadSubscription({
thread_id
thread_id,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/activity/listEventsForOrg.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This is the user's organization dashboard. You must be authenticated as the user
```js
octokit.activity.listEventsForOrg({
username,
org
org,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/activity/listEventsForUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ If you are authenticated as the given user, you will see your private events. Ot

```js
octokit.activity.listEventsForUser({
username
username,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/activity/listNotificationsForRepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ List all notifications for the current user.
```js
octokit.activity.listNotificationsForRepo({
owner,
repo
repo,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/activity/listPublicEventsForOrg.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

```js
octokit.activity.listPublicEventsForOrg({
org
org,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/activity/listPublicEventsForRepoNetwork.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
```js
octokit.activity.listPublicEventsForRepoNetwork({
owner,
repo
repo,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/activity/listPublicEventsForUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

```js
octokit.activity.listPublicEventsForUser({
username
username,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/activity/listReceivedEventsForUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ These are events that you've received by watching repos and following users. If

```js
octokit.activity.listReceivedEventsForUser({
username
username,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/activity/listReceivedPublicEventsForUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

```js
octokit.activity.listReceivedPublicEventsForUser({
username
username,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/activity/listRepoEvents.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
```js
octokit.activity.listRepoEvents({
owner,
repo
repo,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/activity/listReposStarredByUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ You can also find out _when_ stars were created by passing the following custom

```js
octokit.activity.listReposStarredByUser({
username
username,
});
```

Expand Down
2 changes: 1 addition & 1 deletion docs/activity/listReposWatchedByUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Lists repositories a user is watching.

```js
octokit.activity.listReposWatchedByUser({
username
username,
});
```

Expand Down
Loading