|
29 | 29 |
|
30 | 30 | ## Phase 1: Add Watchers as Subscriptions |
31 | 31 |
|
32 | | -In addition to this, we'll expose Watchers as "Subscriptions". This is to |
33 | | -keep from clashing with the legacy endpoint. |
| 32 | +This phase exposes Watchers as "Subscriptions". This is to |
| 33 | +keep from clashing with the legacy endpoint. This phase will happen |
| 34 | +automatically and will not break your application until Phase 2 starts. |
34 | 35 |
|
35 | 36 | * `/repos/:owner/:repo/subscribers` - A list of users watching the repository. |
36 | 37 | * `/users/:user/subscriptions` - A list of repositories that a user is watching. |
|
47 | 48 | application/vnd.github.beta+json |
48 | 49 |
|
49 | 50 | If you care about your application not breaking, make sure all outgoing API |
50 | | -requests pass that value for the "Accept" header. |
| 51 | +requests pass that value for the "Accept" header. You should do this now, even |
| 52 | +before Phase 1 starts. |
51 | 53 |
|
52 | 54 | # Accesses a user's starred repositories. |
53 | 55 | curl https://api.github.com/user/watched \ |
54 | 56 | -H "Accept: application/vnd.github.beta+json" |
55 | 57 |
|
| 58 | +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 | +for API requests. |
| 61 | + |
56 | 62 | ## Phase 2: Switch `/watchers` API Endpoint |
57 | 63 |
|
58 | 64 | The "watch" endpoints will now be a copy of the "subscription" endpoints. You |
|
63 | 69 |
|
64 | 70 | application/vnd.github.v3+json |
65 | 71 |
|
66 | | -We will release this change in an experimental mode first, letting developers |
67 | | -gracefully upgrade their applications by specifying the new mime value for the |
68 | | -Accept header. |
| 72 | +This is a breaking change from Phase 1. We will release this change in an |
| 73 | +experimental mode first, letting developers gracefully upgrade their |
| 74 | +applications by specifying the new mime value for the Accept header. |
69 | 75 |
|
70 | 76 | # Accesses a user's watched repositories. |
71 | 77 | curl https://api.github.com/user/watched \ |
|
77 | 83 | point, you should be using the starring endpoints for starred repositories, and |
78 | 84 | the watch endpoints for watched repositories. |
79 | 85 |
|
80 | | -At this point, keep on passing the "v3" mimetype in your application, until the |
81 | | -API has another breaking change to make. |
| 86 | +Keep on passing the "v3" mimetype in your application, until the API has |
| 87 | +another breaking change to make. |
82 | 88 |
|
0 commit comments