Skip to content

Commit 42c48fa

Browse files
technoweenietechnoweenie
committed
boom
1 parent 25b26aa commit 42c48fa

49 files changed

Lines changed: 317 additions & 48 deletions

File tree

Some content is hidden

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

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
<script src="/shared/js/documentation.js" type="text/javascript"></script>
1616
</head>
1717
<body class="api">
18-
1918
<div id="header-wrapper">
2019
<div id="header">
2120
<div>

‎changes/index.html‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
<script src="/shared/js/documentation.js" type="text/javascript"></script>
1616
</head>
1717
<body class="api">
18-
1918
<div id="header-wrapper">
2019
<div id="header">
2120
<div>

‎changes/v3/index.html‎

Lines changed: 317 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,317 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
5+
<meta http-equiv="Content-Language" content="en-us" />
6+
<meta http-equiv="imagetoolbar" content="false" />
7+
<meta name="MSSmartTagsPreventParsing" content="true" />
8+
<title>GitHub API v3</title>
9+
<link href="/css/reset.css" rel="stylesheet" type="text/css" />
10+
<link href="/css/960.css" rel="stylesheet" type="text/css" />
11+
<link href="/css/uv_active4d.css" rel="stylesheet" type="text/css" />
12+
<link href="/shared/css/documentation.css" media="screen" rel="stylesheet" type="text/css">
13+
<link href="/shared/css/pygments.css" media="screen" rel="stylesheet" type="text/css">
14+
<script src="/shared/js/jquery.js" type="text/javascript"></script>
15+
<script src="/shared/js/documentation.js" type="text/javascript"></script>
16+
</head>
17+
<body class="api">
18+
<div id="header-wrapper">
19+
<div id="header">
20+
<div>
21+
<a class="logo" href="/"><img src="/images/logo_developer.png" width="255" height="45" /></a>
22+
<ul class="nav">
23+
<li><a href="/v3/">API v3</a></li>
24+
<li><a
25+
href="http://support.github.com/discussions/api">Support</a></li>
26+
</ul>
27+
</div>
28+
</div><!-- #header -->
29+
</div><!-- #header-wrapper -->
30+
31+
<div id="wrapper">
32+
<div class="content">
33+
<h1 id="api-beta-to-v3">API <code>beta</code> to <code>v3</code>
34+
</h1>
35+
36+
<dl>
37+
<dt>Old Mime Type</dt>
38+
<dd>application/vnd.github.beta+json (Current, April 27, 2011)</dd>
39+
<dt>New Mime Type</dt>
40+
<dd>application/vnd.github.v3+json</dd>
41+
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+
</span>
55+
</div>
56+
</div>
57+
58+
<p>We recently <a href="https://github.com/blog/1204-notifications-stars">changed the Watcher behavior</a> on GitHub. What
59+
used to be known as “Watching”, is now “Starring”. Starring is basically
60+
a way to bookmark interesting repositories. Watching is a way to indicate that
61+
you want to receive email or web notifications on a Repository.</p>
62+
63+
<p>This works well on GitHub.com, but poses a problem for the GitHub API. How do
64+
we change this in a way that developers can gracefully upgrade their
65+
applications? We’re currently looking at rolling out the changes in three
66+
phases over an extended period of time.</p>
67+
68+
<h2 id="current-status">Current Status</h2>
69+
70+
<p>The current <a href="http://developer.github.com/v3/repos/watching/">Repository Starring</a> methods look like this:</p>
71+
72+
<ul>
73+
<li>
74+
<code>/repos/:owner/:repo/watchers</code> - A list of users starring the repository.</li>
75+
<li>
76+
<code>/users/:user/watched</code> - A list of repositories that a user has starred.</li>
77+
<li>
78+
<code>/user/watched</code> - A list of repositories the current user has starred.</li>
79+
</ul>
80+
<h2 id="phase-1-add-watchers-as-subscriptions">Phase 1: Add Watchers as Subscriptions</h2>
81+
82+
<p>In addition to this, we’ll expose Watchers as “Subscriptions”. This is to
83+
keep from clashing with the legacy endpoint.</p>
84+
85+
<ul>
86+
<li>
87+
<code>/repos/:owner/:repo/subscribers</code> - A list of users watching the repository.</li>
88+
<li>
89+
<code>/users/:user/subscribed</code> - A list of repositories that a user has starred.</li>
90+
<li>
91+
<code>/user/subscriptions</code> - A list of repositories the current user is watching.</li>
92+
</ul>
93+
<p>We’ll also add a copy of the legacy Watchers API in the new endpoint:</p>
94+
95+
<ul>
96+
<li>
97+
<code>/repos/:owner/:repo/stargazers</code> - A list of users starring the repository.</li>
98+
<li>
99+
<code>/users/:user/starred</code> - A list of repositories that a user has starred.</li>
100+
<li>
101+
<code>/user/starred</code> - A list of repositories the current user has starred.</li>
102+
</ul>
103+
<p>This will be done with the current mime type for the API:</p>
104+
105+
<pre><code>application/vnd.github.beta+json
106+
</code></pre>
107+
108+
<p>If you care about your application not breaking, make sure all outgoing API
109+
requests pass that value for the “Accept” header.</p>
110+
111+
<pre><code># Accesses a user's starred repositories.
112+
curl https://api.github.com/user/watched \
113+
-H "Accept: application/vnd.github.beta+json"
114+
</code></pre>
115+
116+
<h2 id="phase-2-switch-watchers-api-endpoint">Phase 2: Switch <code>/watchers</code> API Endpoint</h2>
117+
118+
<p>The “watch” endpoints will now be a copy of the “subscription” endpoints. You
119+
will have to use <code>/user/starred</code> to get a user’s starred repositories, not
120+
<code>/user/watched</code>.</p>
121+
122+
<p>This requires a new mime type value:</p>
123+
124+
<pre><code>application/vnd.github.v3+json
125+
</code></pre>
126+
127+
<p>We will release this change in an experimental mode first, letting developers
128+
gracefully upgrade their applications by specifying the new mime value for the
129+
Accept header.</p>
130+
131+
<pre><code># Accesses a user's watched repositories.
132+
curl https://api.github.com/user/watched \
133+
-H "Accept: application/vnd.github.v3+json"
134+
</code></pre>
135+
136+
<h2 id="phase-3-remove-subscribers-api-endpoint">Phase 3: Remove <code>/subscribers</code> API Endpoint.</h2>
137+
138+
<p>This phase involves disabling the subscription endpoints completely. At this
139+
point, you should be using the starring endpoints for starred repositories, and
140+
the watch endpoints for watched repositories.</p>
141+
</div>
142+
</div>
143+
144+
<div id="js-sidebar" class="sidebar-shell">
145+
<div class="js-toggle-list sidebar-module expandable">
146+
<ul>
147+
<li class="js-topic">
148+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/">Summary</a></h3>
149+
<ul class="js-guides">
150+
<li><a href="/v3/oauth/">OAuth</a></li>
151+
<li><a href="/v3/mime/">Mime Types</a></li>
152+
<li><a href="/v3/libraries/">Libraries</a></li>
153+
</ul>
154+
</li>
155+
<li class="js-topic">
156+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/gists/">Gists</a></h3>
157+
<ul class="js-guides">
158+
<li><a href="/v3/gists/comments/">Comments</a></li>
159+
</ul>
160+
</li>
161+
<li class="js-topic">
162+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/git/">Git Data</a></h3>
163+
<ul class="js-guides">
164+
<li><a href="/v3/git/blobs/">Blobs</a></li>
165+
<li><a href="/v3/git/commits/">Commits</a></li>
166+
<li><a href="/v3/git/refs/">References</a></li>
167+
<li><a href="/v3/git/tags/">Tags</a></li>
168+
<li><a href="/v3/git/trees/">Trees</a></li>
169+
</ul>
170+
</li>
171+
<li class="js-topic">
172+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/issues/">Issues</a></h3>
173+
<ul class="js-guides">
174+
<li><a href="/v3/issues/assignees/">Assignees</a></li>
175+
<li><a href="/v3/issues/comments/">Comments</a></li>
176+
<li><a href="/v3/issues/events/">Events</a></li>
177+
<li><a href="/v3/issues/labels/">Labels</a></li>
178+
<li><a href="/v3/issues/milestones/">Milestones</a></li>
179+
</ul>
180+
</li>
181+
<li class="js-topic">
182+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/orgs/">Orgs</a></h3>
183+
<ul class="js-guides">
184+
<li><a href="/v3/orgs/members/">Members</a></li>
185+
<li><a href="/v3/orgs/teams/">Teams</a></li>
186+
</ul>
187+
</li>
188+
<li class="js-topic">
189+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/pulls/">Pull Requests</a></h3>
190+
<ul class="js-guides">
191+
<li><a href="/v3/pulls/comments/">Review Comments</a></li>
192+
</ul>
193+
</li>
194+
<li class="js-topic">
195+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/repos/">Repos</a></h3>
196+
<ul class="js-guides">
197+
<li><a href="/v3/repos/collaborators/">Collaborators</a></li>
198+
<li><a href="/v3/repos/comments/">Comments</a></li>
199+
<li><a href="/v3/repos/commits/">Commits</a></li>
200+
<li><a href="/v3/repos/contents/">Contents</a></li>
201+
<li><a href="/v3/repos/downloads/">Downloads</a></li>
202+
<li><a href="/v3/repos/forks/">Forks</a></li>
203+
<li><a href="/v3/repos/keys/">Keys</a></li>
204+
<li><a href="/v3/repos/hooks/">Hooks</a></li>
205+
<li><a href="/v3/repos/merging/">Merging</a></li>
206+
<li><a href="/v3/repos/statuses/">Statuses</a></li>
207+
<li><a href="/v3/repos/watching/">Watching</a></li>
208+
</ul>
209+
</li>
210+
<li class="js-topic">
211+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/users/">Users</a></h3>
212+
<ul class="js-guides">
213+
<li><a href="/v3/users/emails/">Emails</a></li>
214+
<li><a href="/v3/users/followers/">Followers</a></li>
215+
<li><a href="/v3/users/keys/">Keys</a></li>
216+
</ul>
217+
</li>
218+
<li class="js-topic">
219+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/events/">Events</a></h3>
220+
<ul class="js-guides">
221+
<li><a href="/v3/events/types/">Types</a></li>
222+
</ul>
223+
</li>
224+
<li class="js-topic">
225+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/search/">Search</a></h3>
226+
<ul class="js-guides">
227+
<li><a href="/v3/search/#search-issues">Issues</a></li>
228+
<li><a href="/v3/search/#search-repositories">Repositories</a></li>
229+
<li><a href="/v3/search/#search-users">Users</a></li>
230+
<li><a href="/v3/search/#email-search">Email</a></li>
231+
</ul>
232+
</li>
233+
<li class="js-guides"><h3><a href="/v3/markdown/">Markdown</a></h3></li>
234+
</ul>
235+
</div> <!-- /sidebar-module -->
236+
<div class="sidebar-module">
237+
<p>This website is a <a href="https://github.com/github/developer.github.com" target="_blank">public GitHub repo</a>. Please help us by forking the project and adding to it.</p>
238+
</div>
239+
</div><!-- /sidebar-shell -->
240+
241+
</div><!-- #wrapper -->
242+
243+
<div id="footer" >
244+
<div class="upper_footer">
245+
<div class="footer_inner clearfix">
246+
247+
<!--[if IE]><h4 id="blacktocat_ie">GitHub Links</h4><![endif]-->
248+
<![if !IE]><h4 id="blacktocat">GitHub Links</h4><![endif]>
249+
250+
<ul class="footer_nav">
251+
<h4>GitHub</h4>
252+
<li><a href="https://github.com/about">About</a></li>
253+
<li><a href="https://github.com/blog">Blog</a></li>
254+
<li><a href="https://github.com/features">Features</a></li>
255+
<li><a href="https://github.com/contact">Contact &amp; Support</a></li>
256+
<li><a href="https://github.com/training">Training</a></li>
257+
<li><a href="http://status.github.com/">Site Status</a></li>
258+
</ul>
259+
260+
<ul class="footer_nav">
261+
<h4>Tools</h4>
262+
<li><a href="http://mac.github.com/">GitHub for Mac</a></li>
263+
<li><a href="http://mobile.github.com/">Issues for iPhone</a></li>
264+
<li><a href="https://gist.github.com">Gist: Code Snippets</a></li>
265+
<li><a href="http://enterprise.github.com/">GitHub Enterprise</a></li>
266+
<li><a href="http://jobs.github.com/">Job Board</a></li>
267+
</ul>
268+
269+
<ul class="footer_nav">
270+
<h4>Extras</h4>
271+
<li><a href="http://shop.github.com/">GitHub Shop</a></li>
272+
<li><a href="http://octodex.github.com/">The Octodex</a></li>
273+
</ul>
274+
275+
<ul class="footer_nav">
276+
<h4>Documentation</h4>
277+
<li><a href="http://help.github.com/">GitHub Help</a></li>
278+
<li><a href="http://developer.github.com/">Developer API</a></li>
279+
<li><a href="http://github.github.com/github-flavored-markdown/">GitHub Flavored Markdown</a></li>
280+
<li><a href="http://pages.github.com/">GitHub Pages</a></li>
281+
</ul>
282+
283+
</div><!-- /.site -->
284+
</div><!-- /.upper_footer -->
285+
286+
<div class="lower_footer">
287+
<div class="footer_inner clearfix">
288+
<div id="legal">
289+
<!--[if IE]><a class="home_ie" href="http://github.com">Home</a><![endif]-->
290+
<![if !IE]><a class="home" href="http://github.com">Home</a><![endif]>
291+
292+
<ul id="legal_links">
293+
<li><a href="http://help.github.com/terms-of-service/">Terms of Service</a></li>
294+
<li><a href="http://help.github.com/privacy-policy/">Privacy</a></li>
295+
<li><a href="http://help.github.com/security/">Security</a></li>
296+
</ul>
297+
298+
<p>&copy; <span id="year">year</span> GitHub Inc. All rights reserved.</p>
299+
</div><!-- /#legal or /#legal_ie-->
300+
</div><!-- /.site -->
301+
</div><!-- /.lower_footer -->
302+
</div><!-- /#footer -->
303+
<script type="text/javascript">
304+
var _gauges = _gauges || [];
305+
(function() {
306+
var t = document.createElement('script');
307+
t.type = 'text/javascript';
308+
t.async = true;
309+
t.id = 'gauges-tracker';
310+
t.setAttribute('data-site-id', '4f2038e0cb25bc1b55000003');
311+
t.src = '//secure.gaug.es/track.js';
312+
var s = document.getElementsByTagName('script')[0];
313+
s.parentNode.insertBefore(t, s);
314+
})();
315+
</script>
316+
</body>
317+
</html>

‎index.html‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
<script src="/shared/js/documentation.js" type="text/javascript"></script>
1616
</head>
1717
<body class="api">
18-
1918
<div id="header-wrapper">
2019
<div id="header">
2120
<div>

‎v3/changelog/index.html‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
<script src="/shared/js/documentation.js" type="text/javascript"></script>
1616
</head>
1717
<body class="api">
18-
1918
<div id="header-wrapper">
2019
<div id="header">
2120
<div>

‎v3/events/index.html‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
<script src="/shared/js/documentation.js" type="text/javascript"></script>
1616
</head>
1717
<body class="api">
18-
1918
<div id="header-wrapper">
2019
<div id="header">
2120
<div>

‎v3/events/types/index.html‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
<script src="/shared/js/documentation.js" type="text/javascript"></script>
1616
</head>
1717
<body class="api">
18-
1918
<div id="header-wrapper">
2019
<div id="header">
2120
<div>

‎v3/gists/comments/index.html‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
<script src="/shared/js/documentation.js" type="text/javascript"></script>
1616
</head>
1717
<body class="api">
18-
1918
<div id="header-wrapper">
2019
<div id="header">
2120
<div>

‎v3/gists/index.html‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
<script src="/shared/js/documentation.js" type="text/javascript"></script>
1616
</head>
1717
<body class="api">
18-
1918
<div id="header-wrapper">
2019
<div id="header">
2120
<div>

‎v3/git/blobs/index.html‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
<script src="/shared/js/documentation.js" type="text/javascript"></script>
1616
</head>
1717
<body class="api">
18-
1918
<div id="header-wrapper">
2019
<div id="header">
2120
<div>

0 commit comments

Comments
 (0)