Skip to content

Commit 6c81655

Browse files
committed
act like the change blog is a thing now
1 parent e530346 commit 6c81655

File tree

3 files changed

+14
-10
lines changed

3 files changed

+14
-10
lines changed

content/changes/2012-9-5-watcher-api.html

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
* `/users/:user/watched` - A list of repositories that a user has starred.
2626
* `/user/watched` - A list of repositories the current user has starred.
2727

28-
[starring-api]: http://developer.github.com/v3/repos/watching/
28+
[starring-api]: http://developer.github.com/v3/repos/starring/
2929

3030
## Phase 1: Add Watchers as Subscriptions
3131

@@ -43,20 +43,21 @@
4343
* `/users/:user/starred` - A list of repositories that a user has starred.
4444
* `/user/starred` - A list of repositories the current user has starred.
4545

46-
This will be done with the current mime type for the API:
46+
This is in place _now_ with the current media type for the API:
4747

4848
application/vnd.github.beta+json
4949

5050
If you care about your application not breaking, make sure all outgoing API
51-
requests pass that value for the "Accept" header. You should do this now, even
52-
before Phase 1 starts.
51+
requests pass that value for the "Accept" header. You should do this now. This
52+
can be verified by checking the `X-GitHub-Media-Type` header on all API
53+
responses.
5354

5455
# Accesses a user's starred repositories.
5556
curl https://api.github.com/user/watched \
5657
-H "Accept: application/vnd.github.beta+json"
5758

5859
This Phase will be broken once Phase 3 starts. Phase 3 removes all support for
59-
the "beta" mime type, and makes the "v3" mime type the implicit default
60+
the "beta" media type, and makes the "v3" media type the implicit default
6061
for API requests.
6162

6263
## Phase 2: Switch `/watchers` API Endpoint
@@ -65,13 +66,13 @@
6566
will have to use `/user/starred` to get a user's starred repositories, not
6667
`/user/watched`.
6768

68-
This requires a new mime type value:
69+
This requires a new media type value:
6970

7071
application/vnd.github.v3+json
7172

7273
This is a breaking change from Phase 1. We will release this change in an
7374
experimental mode first, letting developers gracefully upgrade their
74-
applications by specifying the new mime value for the Accept header.
75+
applications by specifying the new media value for the Accept header.
7576

7677
# Accesses a user's watched repositories.
7778
curl https://api.github.com/user/watched \
@@ -83,6 +84,6 @@
8384
point, you should be using the starring endpoints for starred repositories, and
8485
the watch endpoints for watched repositories.
8586

86-
Keep on passing the "v3" mimetype in your application, until the API has
87+
Keep on passing the "v3" media type in your application, until the API has
8788
another breaking change to make.
8889

content/v3/repos/starring.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ We recently [changed the way watching
1616
works](https://github.com/blog/1204-notifications-stars) on GitHub. Many 3rd
1717
party applications may be using the "watcher" endpoints for accessing these.
1818
Starting today, you can start changing these to the new "star" endpoints. See
19-
below.
19+
below. Check the [Watcher API Change post](/changes/2012-9-5-watcher-api/) for
20+
more.
21+
2022

2123
## List Stargazers
2224

content/v3/repos/watching.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Starring](/v3/repos/starring) for simple repository bookmarks.
1414
We recently [changed the way watching
1515
works](https://github.com/blog/1204-notifications-stars) on GitHub. Until 3rd
1616
party applications stop using the "watcher" endpoints for the current Starring
17-
API, the Watching API will use the below "subscription" endpoints.
17+
API, the Watching API will use the below "subscription" endpoints. Check the
18+
[Watcher API Change post](/changes/2012-9-5-watcher-api/) for more.
1819

1920
## List watchers
2021

0 commit comments

Comments
 (0)