Skip to content

Commit dd3cf31

Browse files
pengwynnpengwynn
committed
boom
1 parent f7c6922 commit dd3cf31

File tree

9 files changed

+57
-12
lines changed

9 files changed

+57
-12
lines changed

‎v3/git/import/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ <h1 id="import-api">Import API</h1>
3838

3939
<p>Would this be cool?</p>
4040

41-
<p>See the <a href="http://progit.org/book/ch8-2.html#a_custom_importer">Pro Git book</a> or the
41+
<p>See the <a href="http://git-scm.com/book/ch8-2.html#a_custom_importer">Pro Git book</a> or the
4242
<a href="http://www.kernel.org/pub/software/scm/git/docs/git-fast-import.html">fast-import man page</a>
4343
for more information about the fast-import syntax.</p>
4444

‎v3/git/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ <h1 id="git-db-api">Git DB API</h1>
5050
<p><img src="http://git-scm.com/figures/18333fig0904-tn.png" alt="git db"></p>
5151

5252
<p>For more information on the Git object database, please read the
53-
<a href="http://progit.org/book/ch9-0.html">Git Internals</a> chapter of
53+
<a href="http://git-scm.com/book/ch9-0.html">Git Internals</a> chapter of
5454
the Pro Git book.</p>
5555

5656
<p>As an example, if you wanted to commit a change to a file in your

‎v3/index.html

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ <h2 id="client-errors">Client Errors</h2>
104104
</code></pre>
105105
</li>
106106
<li>
107-
<p>Sending invalid files will result in a 422 Unprocessable Entity
107+
<p>Sending invalid files will result in a <code>422 Unprocessable Entity</code>
108108
response.</p>
109109

110110
<pre><code> HTTP/1.1 422 Unprocessable Entity
@@ -124,7 +124,7 @@ <h2 id="client-errors">Client Errors</h2>
124124
</li>
125125
</ol><p>All error objects have resource and field properties so that your client
126126
can tell what the problem is. There’s also an error code to let you
127-
know what is wrong with the field. These are the possible validation error
127+
know what is wrong with the field. These are the possible validation error
128128
codes:</p>
129129

130130
<dl>
@@ -163,7 +163,7 @@ <h2 id="http-verbs">HTTP Verbs</h2>
163163
POST requests.</dd>
164164
<dt>PUT</dt>
165165
<dd>Used for replacing resources or collections. For PUT requests
166-
with no <code>body</code> attribute, be sure to set the <code>Content-Length</code> header to zero. </dd>
166+
with no <code>body</code> attribute, be sure to set the <code>Content-Length</code> header to zero.</dd>
167167
<dt>DELETE</dt>
168168
<dd>Used for deleting resources.</dd>
169169
</dl><h2 id="authentication">Authentication</h2>
@@ -194,7 +194,7 @@ <h2 id="http-verbs">HTTP Verbs</h2>
194194

195195
<p>Requests that require authentication will return 404, instead of 403, in some places.
196196
This is to prevent the accidental leakage of private repositories to unauthorized
197-
users. </p>
197+
users.</p>
198198

199199
<h2 id="pagination">Pagination</h2>
200200

@@ -240,7 +240,26 @@ <h2 id="pagination">Pagination</h2>
240240
X-RateLimit-Remaining: 4966
241241
</pre>
242242

243-
<p>You can <a href="https://github.com/contact">contact us</a> to request white listed access for your application. We prefer sites that
243+
<p>You can also check your rate limit status without incurring an API hit.</p>
244+
245+
<pre><code>GET /rate_limit
246+
</code></pre>
247+
248+
<h3 id="rate-limit">Rate limit</h3>
249+
250+
<pre class="headers"><code>Status: 200 OK
251+
X-RateLimit-Limit: 5000
252+
X-RateLimit-Remaining: 4999</code></pre>
253+
254+
<pre class="highlight"><code class="language-javascript"><span class="p">{</span>
255+
<span class="s2">"rate"</span><span class="o">:</span> <span class="p">{</span>
256+
<span class="s2">"remaining"</span><span class="o">:</span> <span class="mi">4999</span><span class="p">,</span>
257+
<span class="s2">"limit"</span><span class="o">:</span> <span class="mi">5000</span>
258+
<span class="p">}</span>
259+
<span class="p">}</span>
260+
</code></pre>
261+
262+
<p>Please <a href="https://github.com/contact">contact us</a> to request white listed access for your application. We prefer sites that
244263
setup OAuth applications for their users.</p>
245264

246265
<h2 id="cross-origin-resource-sharing">Cross Origin Resource Sharing</h2>
@@ -253,14 +272,14 @@ <h2 id="cross-origin-resource-sharing">Cross Origin Resource Sharing</h2>
253272
<p>Here’s a sample request sent from a browser hitting
254273
<code>http://some-site.com</code>:</p>
255274

256-
<pre><code>$ curl -i https://api.github.com -H "Origin: http://some-site.com"
275+
<pre><code>$ curl -i https://api.github.com -H "Origin: http://some-site.com"
257276
HTTP/1.1 302 Found
258277
</code></pre>
259278

260279
<p>Any domain that is registered as an OAuth Application is accepted.
261280
Here’s a sample request for a browser hitting <a href="http://calendaraboutnothing.com/">Calendar About Nothing</a>:</p>
262281

263-
<pre><code>$ curl -i https://api.github.com -H "Origin: http://calendaraboutnothing.com"
282+
<pre><code>$ curl -i https://api.github.com -H "Origin: http://calendaraboutnothing.com"
264283
HTTP/1.1 302 Found
265284
Access-Control-Allow-Origin: http://calendaraboutnothing.com
266285
Access-Control-Expose-Headers: Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-OAuth-Scopes, X-Accepted-OAuth-Scopes
@@ -269,7 +288,7 @@ <h2 id="cross-origin-resource-sharing">Cross Origin Resource Sharing</h2>
269288

270289
<p>This is what the CORS preflight request looks like:</p>
271290

272-
<pre><code>$ curl -i https://api.github.com -H "Origin: http://calendaraboutnothing.com" -X OPTIONS
291+
<pre><code>$ curl -i https://api.github.com -H "Origin: http://calendaraboutnothing.com" -X OPTIONS
273292
HTTP/1.1 204 No Content
274293
Access-Control-Allow-Origin: http://calendaraboutnothing.com
275294
Access-Control-Allow-Headers: Authorization, X-Requested-With

‎v3/oauth/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ <h3 id="parameters">Parameters</h3>
6363
you <a href="https://github.com/settings/applications/new">registered</a>.</dd>
6464
<dt>redirect_uri</dt>
6565
<dd>
66-
<em>Optional</em> <strong>string</strong> - URL in your app where user’s will be sent
66+
<em>Optional</em> <strong>string</strong> - URL in your app where users will be sent
6767
after authorization. See details below about <a href="#redirect-urls">redirect
6868
urls</a>.</dd>
6969
<dt>scope</dt>

‎v3/orgs/teams/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,7 @@ <h3 id="response-6">Response</h3>
314314
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/users/octocat"</span>
315315
<span class="p">},</span>
316316
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Hello-World"</span><span class="p">,</span>
317+
<span class="s2">"full_name"</span><span class="o">:</span> <span class="s2">"octocat/Hello-World"</span><span class="p">,</span>
317318
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"This your first repo!"</span><span class="p">,</span>
318319
<span class="s2">"homepage"</span><span class="o">:</span> <span class="s2">"https://github.com"</span><span class="p">,</span>
319320
<span class="s2">"language"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
@@ -385,7 +386,7 @@ <h3 id="reponse-2">Reponse</h3>
385386

386387
<h2 id="remove-team-repo">Remove team repo</h2>
387388

388-
<p>In order to add a repo to a team, the authenticated user must be an
389+
<p>In order to remove a repo from a team, the authenticated user must be an
389390
owner of the org that the team is associated with.
390391
NOTE: This does not delete the repo, it just removes it from the team.</p>
391392

‎v3/pulls/index.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ <h3 id="parameters">Parameters</h3>
112112
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/users/octocat"</span>
113113
<span class="p">},</span>
114114
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Hello-World"</span><span class="p">,</span>
115+
<span class="s2">"full_name"</span><span class="o">:</span> <span class="s2">"octocat/Hello-World"</span><span class="p">,</span>
115116
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"This your first repo!"</span><span class="p">,</span>
116117
<span class="s2">"homepage"</span><span class="o">:</span> <span class="s2">"https://github.com"</span><span class="p">,</span>
117118
<span class="s2">"language"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
@@ -155,6 +156,7 @@ <h3 id="parameters">Parameters</h3>
155156
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/users/octocat"</span>
156157
<span class="p">},</span>
157158
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Hello-World"</span><span class="p">,</span>
159+
<span class="s2">"full_name"</span><span class="o">:</span> <span class="s2">"octocat/Hello-World"</span><span class="p">,</span>
158160
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"This your first repo!"</span><span class="p">,</span>
159161
<span class="s2">"homepage"</span><span class="o">:</span> <span class="s2">"https://github.com"</span><span class="p">,</span>
160162
<span class="s2">"language"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
@@ -241,6 +243,7 @@ <h3 id="response-1">Response</h3>
241243
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/users/octocat"</span>
242244
<span class="p">},</span>
243245
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Hello-World"</span><span class="p">,</span>
246+
<span class="s2">"full_name"</span><span class="o">:</span> <span class="s2">"octocat/Hello-World"</span><span class="p">,</span>
244247
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"This your first repo!"</span><span class="p">,</span>
245248
<span class="s2">"homepage"</span><span class="o">:</span> <span class="s2">"https://github.com"</span><span class="p">,</span>
246249
<span class="s2">"language"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
@@ -284,6 +287,7 @@ <h3 id="response-1">Response</h3>
284287
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/users/octocat"</span>
285288
<span class="p">},</span>
286289
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Hello-World"</span><span class="p">,</span>
290+
<span class="s2">"full_name"</span><span class="o">:</span> <span class="s2">"octocat/Hello-World"</span><span class="p">,</span>
287291
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"This your first repo!"</span><span class="p">,</span>
288292
<span class="s2">"homepage"</span><span class="o">:</span> <span class="s2">"https://github.com"</span><span class="p">,</span>
289293
<span class="s2">"language"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
@@ -432,6 +436,7 @@ <h3 id="response-2">Response</h3>
432436
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/users/octocat"</span>
433437
<span class="p">},</span>
434438
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Hello-World"</span><span class="p">,</span>
439+
<span class="s2">"full_name"</span><span class="o">:</span> <span class="s2">"octocat/Hello-World"</span><span class="p">,</span>
435440
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"This your first repo!"</span><span class="p">,</span>
436441
<span class="s2">"homepage"</span><span class="o">:</span> <span class="s2">"https://github.com"</span><span class="p">,</span>
437442
<span class="s2">"language"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
@@ -475,6 +480,7 @@ <h3 id="response-2">Response</h3>
475480
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/users/octocat"</span>
476481
<span class="p">},</span>
477482
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Hello-World"</span><span class="p">,</span>
483+
<span class="s2">"full_name"</span><span class="o">:</span> <span class="s2">"octocat/Hello-World"</span><span class="p">,</span>
478484
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"This your first repo!"</span><span class="p">,</span>
479485
<span class="s2">"homepage"</span><span class="o">:</span> <span class="s2">"https://github.com"</span><span class="p">,</span>
480486
<span class="s2">"language"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
@@ -582,6 +588,7 @@ <h3 id="response-3">Response</h3>
582588
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/users/octocat"</span>
583589
<span class="p">},</span>
584590
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Hello-World"</span><span class="p">,</span>
591+
<span class="s2">"full_name"</span><span class="o">:</span> <span class="s2">"octocat/Hello-World"</span><span class="p">,</span>
585592
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"This your first repo!"</span><span class="p">,</span>
586593
<span class="s2">"homepage"</span><span class="o">:</span> <span class="s2">"https://github.com"</span><span class="p">,</span>
587594
<span class="s2">"language"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
@@ -625,6 +632,7 @@ <h3 id="response-3">Response</h3>
625632
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/users/octocat"</span>
626633
<span class="p">},</span>
627634
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Hello-World"</span><span class="p">,</span>
635+
<span class="s2">"full_name"</span><span class="o">:</span> <span class="s2">"octocat/Hello-World"</span><span class="p">,</span>
628636
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"This your first repo!"</span><span class="p">,</span>
629637
<span class="s2">"homepage"</span><span class="o">:</span> <span class="s2">"https://github.com"</span><span class="p">,</span>
630638
<span class="s2">"language"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>

‎v3/repos/forks/index.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ <h3 id="parameters">Parameters</h3>
6969
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/users/octocat"</span>
7070
<span class="p">},</span>
7171
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Hello-World"</span><span class="p">,</span>
72+
<span class="s2">"full_name"</span><span class="o">:</span> <span class="s2">"octocat/Hello-World"</span><span class="p">,</span>
7273
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"This your first repo!"</span><span class="p">,</span>
7374
<span class="s2">"homepage"</span><span class="o">:</span> <span class="s2">"https://github.com"</span><span class="p">,</span>
7475
<span class="s2">"language"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>
@@ -127,6 +128,7 @@ <h3 id="parameters-1">Parameters</h3>
127128
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/users/octocat"</span>
128129
<span class="p">},</span>
129130
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Hello-World"</span><span class="p">,</span>
131+
<span class="s2">"full_name"</span><span class="o">:</span> <span class="s2">"octocat/Hello-World"</span><span class="p">,</span>
130132
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"This your first repo!"</span><span class="p">,</span>
131133
<span class="s2">"homepage"</span><span class="o">:</span> <span class="s2">"https://github.com"</span><span class="p">,</span>
132134
<span class="s2">"language"</span><span class="o">:</span> <span class="kc">null</span><span class="p">,</span>

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy