Skip to content

Commit ace2f0b

Browse files
technoweenietechnoweenie
committed
boom
1 parent 9f99aa6 commit ace2f0b

File tree

3 files changed

+6
-105
lines changed

3 files changed

+6
-105
lines changed

‎changes/2012-9-5-watcher-api/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ <h2 class="title">
4242
<a href="https://github.com/technoweenie">technoweenie</a>
4343
</span>
4444
<span class="published">
45-
September 5, 2012,
46-
Version: <a href="/changes/v3">v3</a>
45+
September 5, 2012
46+
4747
</span>
4848
</div>
4949
</div>

‎changes/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ <h2 class="title">
4343
<a href="https://github.com/technoweenie">technoweenie</a>
4444
</span>
4545
<span class="published">
46-
September 5, 2012,
47-
Version: <a href="/changes/v3">v3</a>
46+
September 5, 2012
47+
4848
</span>
4949
</div>
5050
</div>

‎changes/v3/index.html‎

Lines changed: 2 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -39,107 +39,8 @@ <h1 id="api-beta-to-v3">API <code>beta</code> to <code>v3</code>
3939
<dt>New Mime Type</dt>
4040
<dd>application/vnd.github.v3+json</dd>
4141

42-
</dl><div class="change" id="/changes/2012-9-5-watcher-api/">
43-
<h2 class="title">
44-
<a href="/changes/2012-9-5-watcher-api/">Upcoming Changes to Watcher and Star APIs</a>
45-
</h2>
46-
47-
<div class="meta">
48-
<div class="who_when">
49-
<img height="16" width="16" src="https://secure.gravatar.com/avatar/821395fe70906c8290df7f18ac4ac6cf?s=20&amp;d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png"><span class="author vcard fn">
50-
<a href="https://github.com/technoweenie">technoweenie</a>
51-
</span>
52-
<span class="published">
53-
September 5, 2012,
54-
Version: <a href="/changes/v3">v3</a>
55-
</span>
56-
</div>
57-
</div>
58-
59-
<p>We recently <a href="https://github.com/blog/1204-notifications-stars">changed the Watcher behavior</a> on GitHub. What
60-
used to be known as “Watching”, is now “Starring”. Starring is basically
61-
a way to bookmark interesting repositories. Watching is a way to indicate that
62-
you want to receive email or web notifications on a Repository.</p>
63-
64-
<p>This works well on GitHub.com, but poses a problem for the GitHub API. How do
65-
we change this in a way that developers can gracefully upgrade their
66-
applications? We’re currently looking at rolling out the changes in three
67-
phases over an extended period of time.</p>
68-
69-
<h2 id="current-status">Current Status</h2>
70-
71-
<p>The current <a href="http://developer.github.com/v3/repos/watching/">Repository Starring</a> methods look like this:</p>
72-
73-
<ul>
74-
<li>
75-
<code>/repos/:owner/:repo/watchers</code> - A list of users starring the repository.</li>
76-
<li>
77-
<code>/users/:user/watched</code> - A list of repositories that a user has starred.</li>
78-
<li>
79-
<code>/user/watched</code> - A list of repositories the current user has starred.</li>
80-
</ul>
81-
<h2 id="phase-1-add-watchers-as-subscriptions">Phase 1: Add Watchers as Subscriptions</h2>
82-
83-
<p>In addition to this, we’ll expose Watchers as “Subscriptions”. This is to
84-
keep from clashing with the legacy endpoint.</p>
85-
86-
<ul>
87-
<li>
88-
<code>/repos/:owner/:repo/subscribers</code> - A list of users watching the repository.</li>
89-
<li>
90-
<code>/users/:user/subscribed</code> - A list of repositories that a user has starred.</li>
91-
<li>
92-
<code>/user/subscriptions</code> - A list of repositories the current user is watching.</li>
93-
</ul>
94-
<p>We’ll also add a copy of the legacy Watchers API in the new endpoint:</p>
95-
96-
<ul>
97-
<li>
98-
<code>/repos/:owner/:repo/stargazers</code> - A list of users starring the repository.</li>
99-
<li>
100-
<code>/users/:user/starred</code> - A list of repositories that a user has starred.</li>
101-
<li>
102-
<code>/user/starred</code> - A list of repositories the current user has starred.</li>
103-
</ul>
104-
<p>This will be done with the current mime type for the API:</p>
105-
106-
<pre><code>application/vnd.github.beta+json
107-
</code></pre>
108-
109-
<p>If you care about your application not breaking, make sure all outgoing API
110-
requests pass that value for the “Accept” header.</p>
111-
112-
<pre><code># Accesses a user's starred repositories.
113-
curl https://api.github.com/user/watched \
114-
-H "Accept: application/vnd.github.beta+json"
115-
</code></pre>
116-
117-
<h2 id="phase-2-switch-watchers-api-endpoint">Phase 2: Switch <code>/watchers</code> API Endpoint</h2>
118-
119-
<p>The “watch” endpoints will now be a copy of the “subscription” endpoints. You
120-
will have to use <code>/user/starred</code> to get a user’s starred repositories, not
121-
<code>/user/watched</code>.</p>
122-
123-
<p>This requires a new mime type value:</p>
124-
125-
<pre><code>application/vnd.github.v3+json
126-
</code></pre>
127-
128-
<p>We will release this change in an experimental mode first, letting developers
129-
gracefully upgrade their applications by specifying the new mime value for the
130-
Accept header.</p>
131-
132-
<pre><code># Accesses a user's watched repositories.
133-
curl https://api.github.com/user/watched \
134-
-H "Accept: application/vnd.github.v3+json"
135-
</code></pre>
136-
137-
<h2 id="phase-3-remove-subscribers-api-endpoint">Phase 3: Remove <code>/subscribers</code> API Endpoint.</h2>
138-
139-
<p>This phase involves disabling the subscription endpoints completely. At this
140-
point, you should be using the starring endpoints for starred repositories, and
141-
the watch endpoints for watched repositories.</p>
142-
</div>
42+
</dl><p>This is the first major revision from API v3 since its initial launch. <strong>It is
43+
currently not available yet</strong>.</p>
14344
</div>
14445

14546
<div id="js-sidebar" class="sidebar-shell">

0 commit comments

Comments
 (0)