Sandbox::https://github.com/pythonandchips/developer.github.com/blob/gh-pages/index.html

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

<!DOCTYPE html>

<head>

<title>GitHub API</title>

</head>

<div>

<li><a href="/changes/">Changes</a></li>

<li><a

href="https://github.com/contact">Support</a></li>

</a></li>

</ul>

</div>

</div>

</div>

<h1 id="the-github-api">The GitHub API</h1>

<p>This describes the resources that make up the official GitHub API v3. If

you have any problems or requests please contact

<a href="mailto:support@github.com?subject=APIv3">support</a>.</p>

<p>For the new API v3, start browsing the resources on the right »</p>

<p>View the <a href="#changes">API Changelog</a> for information on existing and

planned changes to the API.</p>

<h2 id="current-version">Current Version</h2>

<pre><code>Accept: application/vnd.github.beta+json

</code></pre>

<p>The GitHub API version is currently in beta. <a href="/v3/media/">The <code>beta</code> media type</a>

property will be valid until sometime in 2013. A notice will be given closer

to the actual date.</p>

<p>We consider the “beta” API unchangeable. <a href="https://github.com/contact">File a support issue</a>

if you have problems.</p>

<h3 id="upcoming-version">Upcoming Version</h3>

<pre><code>Accept: application/vnd.github.v3+json

</code></pre>

<p>The API is expected to be finalized Real Soon Now.</p>

<h4 id="expected-changes-a-namechangesa">Expected Changes <a name="changes"></a>

</h4>

<ul>

<li>All <code>*_url</code> attributes move to a <code>_links</code> object. See <a href="/v3/pulls/#get-a-single-pull-request">Pull

Requests</a> for an example.</li>

<li>The <code>/repos/:owner/:repo/hooks/:id/test</code> action becomes

<code>/repos/:owner/:repo/hooks/:id/tests</code>.</li>

<li>The <code>/gists/:id/fork</code> action becomes <code>/gists/:id/forks</code>.</li>

<li>Gist forks/history objects become separate API calls.</li>

<li>Gist files object is not returned on Gist listings.</li>

<li>Commit schema will change to be <a href="https://gist.github.com/3a2e5779588e21b0c0f3">more consistent</a>.</li>

<li>

<code>master_branch</code> becomes <code>default_branch</code>.</li>

<li>

<code>integrate_branch</code> on the <a href="/v3/repos/#get">repo API</a> will no longer be

returned.</li>

<li>Use the <code>private</code> attribute when creating a private repository,

instead of setting <code>public</code> to false.</li>

<li>

<p>User Emails come back as a hash instead of a string.</p>

<pre><code> {"email": "email@whatev.com", "state": "verified"}

</code></pre>

</li>

</ul><h3 id="breaking-beta-changes">Breaking Beta Changes</h3>

<h5 id="august-30-2012">August 30, 2012</h5>

<ul>

<li>Added <code>repo:status</code> scope</li>

<li>Added Status API</li>

</ul><h5 id="august-7-2012">August 7, 2012</h5>

<ul>

<li>Clarified watching/stargazing</li>

</ul><h5 id="june-12-2012">June 12, 2012:</h5>

<ul>

<li>Removed API v1 support</li>

<li>Removed API v2 support</li>

</ul><h5 id="june-15th-2011">June 15th, 2011:</h5>

<ul>

<li>

<code>gravatar_url</code> is being deprecated in favor of <code>avatar_url</code> for all

responses that include users or orgs. A default size is no longer

included in the url.</li>

<li>Creating new gists (both anonymously and with an authenticated user)

should use <code>POST /gists</code> from now on. <code>POST /users/:user/gists</code> is no

longer supported.</li>

</ul><h5 id="june-1st-2011">June 1st, 2011:</h5>

<ul>

<li>Removed support for PUT verb on update requests. Use POST or PATCH

instead.</li>

<li>Removed <code>.json</code> extension from all URLs.</li>

<li>No longer using the X-Next or X-Last headers. Pagination info is

returned in the Link header instead.</li>

<li>JSON-P response has completely changed to a more consistent format.</li>

<li>Starring gists now uses PUT verb (instead of POST) and returns 204.</li>

</ul>

</div>

<ul>

<h3><a href="#" class="js-expand-btn collapsed"> </a><a href="/v3/">Summary</a></h3>

<li><a href="/v3/oauth/">OAuth</a></li>

<li><a href="/v3/media/">Media Types</a></li>

<li><a href="/v3/libraries/">Libraries</a></li>

</ul>

</li>

<h3><a href="#" class="js-expand-btn collapsed"> </a><a href="/v3/gists/">Gists</a></h3>

<li><a href="/v3/gists/comments/">Comments</a></li>

</ul>

</li>

<li><a href="/v3/git/blobs/">Blobs</a></li>

<li><a href="/v3/git/commits/">Commits</a></li>

<li><a href="/v3/git/refs/">References</a></li>

<li><a href="/v3/git/trees/">Trees</a></li>

</ul>

</li>

<h3><a href="#" class="js-expand-btn collapsed"> </a><a href="/v3/issues/">Issues</a></h3>

<li><a href="/v3/issues/assignees/">Assignees</a></li>

<li><a href="/v3/issues/comments/">Comments</a></li>

<li><a href="/v3/issues/events/">Events</a></li>

<li><a href="/v3/issues/labels/">Labels</a></li>

<li><a href="/v3/issues/milestones/">Milestones</a></li>

</ul>

</li>

<li><a href="/v3/orgs/members/">Members</a></li>

<li><a href="/v3/orgs/teams/">Teams</a></li>

</ul>

</li>

<h3><a href="#" class="js-expand-btn collapsed"> </a><a href="/v3/pulls/">Pull Requests</a></h3>

<li><a href="/v3/pulls/comments/">Review Comments</a></li>

</ul>

</li>

<h3><a href="#" class="js-expand-btn collapsed"> </a><a href="/v3/repos/">Repositories</a></h3>

<li><a href="/v3/repos/collaborators/">Collaborators</a></li>

<li><a href="/v3/repos/comments/">Comments</a></li>

<li><a href="/v3/repos/commits/">Commits</a></li>

<li><a href="/v3/repos/contents/">Contents</a></li>

<li><a href="/v3/repos/downloads/">Downloads</a></li>

<li><a href="/v3/repos/forks/">Forks</a></li>

<li><a href="/v3/repos/hooks/">Hooks</a></li>

<li><a href="/v3/repos/merging/">Merging</a></li>

<li><a href="/v3/repos/starring/">Starring</a></li>

<li><a href="/v3/repos/statuses/">Statuses</a></li>

<li><a href="/v3/repos/watching/">Watching</a></li>

</ul>

</li>

<h3><a href="#" class="js-expand-btn collapsed"> </a><a href="/v3/users/">Users</a></h3>

<li><a href="/v3/users/emails/">Emails</a></li>

<li><a href="/v3/users/followers/">Followers</a></li>

</ul>

</li>

<h3><a href="#" class="js-expand-btn collapsed"> </a><a href="/v3/events/">Events</a></h3>

<li><a href="/v3/events/types/">Types</a></li>

</ul>

</li>

<h3><a href="#" class="js-expand-btn collapsed"> </a><a href="/v3/search/">Search</a></h3>

<li><a href="/v3/search/#search-issues">Issues</a></li>

<li><a href="/v3/search/#search-repositories">Repositories</a></li>

<li><a href="/v3/search/#search-users">Users</a></li>

<li><a href="/v3/search/#email-search">Email</a></li>

</ul>

</li>

<li class="js-guides"><h3><a href="/v3/markdown/">Markdown</a></h3></li>

</ul>

</div>

<p>This website is a <a href="https://github.com/github/developer.github.com" target="_blank">public GitHub repository</a>. Please help us by forking the project and adding to it.</p>

</div>

</div>

</div>

<![if !IE]><h4 id="blacktocat">GitHub Links</h4><![endif]>

<h4>GitHub</h4>

<li><a href="https://github.com/about">About</a></li>

<li><a href="https://github.com/features">Features</a></li>

<li><a href="https://github.com/contact">Contact & Support</a></li>

<li><a href="https://github.com/training">Training</a></li>

<li><a href="http://status.github.com/">Site Status</a></li>

</ul>

<h4>Tools</h4>

<li><a href="http://mac.github.com/">GitHub for Mac</a></li>

<li><a href="http://mobile.github.com/">Issues for iPhone</a></li>

<li><a href="https://gist.github.com">Gist: Code Snippets</a></li>

<li><a href="http://enterprise.github.com/">GitHub Enterprise</a></li>

<li><a href="http://jobs.github.com/">Job Board</a></li>

</ul>

<h4>Extras</h4>

<li><a href="http://shop.github.com/">GitHub Shop</a></li>

<li><a href="http://octodex.github.com/">The Octodex</a></li>

</ul>

<h4>Documentation</h4>

<li><a href="http://help.github.com/">GitHub Help</a></li>

<li><a href="http://developer.github.com/">Developer API</a></li>

<li><a href="http://github.github.com/github-flavored-markdown/">GitHub Flavored Markdown</a></li>

<li><a href="http://pages.github.com/">GitHub Pages</a></li>

</ul>

</div>

</div>

<![if !IE]><a class="home" href="http://github.com">Home</a><![endif]>

<li><a href="http://help.github.com/terms-of-service/">Terms of Service</a></li>

<li><a href="http://help.github.com/privacy-policy/">Privacy</a></li>

<li><a href="http://help.github.com/security/">Security</a></li>

</ul>

</div>

</div>

</div>

</div>

var _gauges = _gauges || [];

(function() {

var t = document.createElement('script');

t.type = 'text/javascript';

t.async = true;

t.id = 'gauges-tracker';

t.setAttribute('data-site-id', '4f2038e0cb25bc1b55000003');

t.src = '//secure.gaug.es/track.js';

var s = document.getElementsByTagName('script')[0];

s.parentNode.insertBefore(t, s);

})();

</script>

</body>

</html>

FilesExpand file tree

index.html

Latest commit

History

index.html

File metadata and controls