update watching/starring api docs · fork-lib/developer.github.com@2e25329 · GitHub
Skip to content

Commit 2e25329

Browse files
committed
update watching/starring api docs
1 parent e789021 commit 2e25329

3 files changed

Lines changed: 125 additions & 24 deletions

File tree

content/v3/repos/starring.md

Lines changed: 98 additions & 0 deletions

content/v3/repos/watching.md

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,71 @@
11
---
2-
title: Repo Watching | GitHub API
2+
title: Repository Watching | GitHub API
33
---
44

5-
# Repo Watching API
5+
# Repository Watching API
6+
7+
Watching a Repository registers the user to receive notificactions on new
8+
discussions, as well as events in the user's activity feed. See [Repository
9+
Starring](/v3/repos/starring) for simple repository bookmarks.
610

711
We recently [changed the way watching
8-
works](https://github.com/blog/1204-notifications-stars) on GitHub. We hope to
9-
roll out many of these features in the API soon. Until then, the [Watchers
10-
method](#list-watchers) below will return "stargazers", and the [Watched
11-
methods](#list-repos-being-watched) return repositories that have been
12-
"starred."
12+
works](https://github.com/blog/1204-notifications-stars) on GitHub. Until 3rd
13+
party applications stop using the "watcher" endpoints for the current Starring
14+
API, the Watching API will use the below "subscription" endpoints.
1315

1416
## List watchers
1517

16-
GET /repos/:user/:repo/watchers
18+
GET /repos/:user/:repo/subscribers
1719

1820
### Response
1921

2022
<%= headers 200, :pagination => true %>
2123
<%= json(:user) { |h| [h] } %>
2224

23-
## List repos being watched
25+
## List repositories being watched
2426

25-
List repos being watched by a user
27+
List repositories being watched by a user.
2628

27-
GET /users/:user/watched
29+
GET /users/:user/subscriptions
2830

29-
List repos being watched by the authenticated user
31+
List repositories being watched by the authenticated user.
3032

31-
GET /user/watched
33+
GET /user/subscriptions
3234

3335
### Response
3436

3537
<%= headers 200, :pagination => true %>
3638
<%= json(:repo) { |h| [h] } %>
3739

38-
## Check if you are watching a repo
40+
## Check if you are watching a repository
3941

40-
Requires for the user to be authenticated
42+
Requires for the user to be authenticated.
4143

42-
GET /user/watched/:user/:repo
44+
GET /user/subscriptions/:user/:repo
4345

44-
### Response if this repo is watched by you
46+
### Response if this repository is watched by you
4547

4648
<%= headers 204 %>
4749

48-
### Response if this repo is not watched by you
50+
### Response if this repository is not watched by you
4951

5052
<%= headers 404 %>
5153

52-
## Watch a repo
54+
## Watch a repository
5355

54-
Requires for the user to be authenticated
56+
Requires for the user to be authenticated.
5557

56-
PUT /user/watched/:user/:repo
58+
PUT /user/subscriptions/:user/:repo
5759

5860
### Response
5961

6062
<%= headers 204 %>
6163

62-
## Stop watching a repo
64+
## Stop watching a repository
6365

64-
Requires for the user to be authenticated
66+
Requires for the user to be authenticated.
6567

66-
DELETE /user/watched/:user/:repo
68+
DELETE /user/subscriptions/:user/:repo
6769

6870
### Response
6971

layouts/default.html

Lines changed: 1 addition & 0 deletions

0 commit comments

Comments
 (0)