Skip to content

Commit e710fd6

Browse files
committed
docs: new endpoints and deprecations coming from restructuring in GitHubs REST API docs
1 parent 43fa538 commit e710fd6

File tree

65 files changed

+739
-61
lines changed

Some content is hidden

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

65 files changed

+739
-61
lines changed

docs/actions/listJobsForWorkflowRun.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# List jobs for a workflow run
22

3-
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.
3+
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. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters).
44

55
```js
66
octokit.actions.listJobsForWorkflowRun({
@@ -35,6 +35,13 @@ repo parameter
3535

3636
run_id parameter
3737

38+
</td></tr>
39+
<tr><td>filter</td><td>no</td><td>
40+
41+
Filters jobs by their `completed_at` timestamp. Can be one of:
42+
\* `latest`: Returns jobs from the most recent execution of the workflow run.
43+
\* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run.
44+
3845
</td></tr>
3946
<tr><td>per_page</td><td>no</td><td>
4047

docs/activity/deleteRepoSubscription.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Delete a Repository Subscription
1+
# Delete a repository subscription
22

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

docs/activity/getRepoSubscription.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Get a Repository Subscription
1+
# Get a repository subscription
22

33
```js
44
octokit.activity.getRepoSubscription({

docs/activity/listReposStarredByAuthenticatedUser.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# List repositories being starred by the authenticated user
1+
# List repositories starred by the authenticated user
2+
3+
Lists repositories the authenticated user has starred.
24

35
You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header:
46

docs/activity/listReposStarredByUser.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# List repositories being starred by a user
1+
# List repositories starred by a user
2+
3+
Lists repositories a user has starred.
24

35
You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header:
46

docs/activity/listReposWatchedByUser.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# List repositories being watched by a user
1+
# List repositories watched by a user
2+
3+
Lists repositories a user is watching.
24

35
```js
46
octokit.activity.listReposWatchedByUser({

docs/activity/listWatchedReposForAuthenticatedUser.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# List repositories being watched by the authenticated user
1+
# List repositories watched by the authenticated user
2+
3+
Lists repositories the authenticated user is watching.
24

35
```js
46
octokit.activity.listWatchedReposForAuthenticatedUser();

docs/activity/listWatchersForRepo.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# List watchers
22

3+
Lists the people watching the specified repository.
4+
35
```js
46
octokit.activity.listWatchersForRepo({
57
owner,

docs/activity/setRepoSubscription.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Set a Repository Subscription
1+
# Set a repository subscription
22

33
If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://developer.github.com/v3/activity/watching/#delete-a-repository-subscription) completely.
44

docs/apps/checkAccountIsAssociatedWithAny.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Check if a GitHub account is associated with any Marketplace listing
1+
# Get a subscription plan for an account
2+
3+
**Deprecated:** This method has been renamed to apps.getSubscriptionPlanForAccount
24

35
Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
46

0 commit comments

Comments
 (0)