Skip to content

Commit d481d77

Browse files
committed
Merge pull request github#285 from github/add-faq
Merge add-faq
2 parents 0d888d3 + dea7a06 commit d481d77

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

content/v3/troubleshooting.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Troubleshooting | GitHub API
3+
---
4+
5+
# Troubleshooting
6+
7+
* TOC
8+
{:toc}
9+
10+
If you're encountering some oddities in the API, here's a list of resolutions to
11+
some of the problems you may be experiencing.
12+
13+
## Why am I getting a `404` error on a repository that exists?
14+
15+
Typically, we send a `404` error when your client isn't properly authenticated.
16+
You might expect to see a `403 Forbidden` in these cases. However, since we don't
17+
want to provide _any_ information about private repositories, the API returns a
18+
`404` error instead.
19+
20+
To fix this, you can either ensure that [you're authenticating correctly](/guides/getting-started/),
21+
or [make sure that your scopes are valid](/v3/oauth/#scopes).
22+
23+
## Why am I not seeing all my results?
24+
25+
Most API calls accessing a list of resources (_e.g._, users, issues, _e.t.c._) support
26+
pagination. If you're making requests and receiving an incomplete set of results, you're
27+
probably only seeing the first page. You'll need to request the remaining pages
28+
in order to get more results.
29+
30+
It's important to *not* try and guess the format of the pagination URL. Not every
31+
API call uses the same structure. Instead, extract the pagination information from
32+
[the Link Header](/v3/#pagination), which is sent with every request.
33+
34+
## Can I get my rate limits bumped?
35+
36+
The GitHub API has a pretty lenient quota for rate limits, for your enjoyment and
37+
our safety. You can read more about it [here](/v3/#rate-limiting).
38+
39+
If you're using OAuth or Basic Authentication and are hitting your rate limits,
40+
you might be able to fix the issue by either caching our results, or [using conditional requests](/v3/#conditional-requests).
41+
42+
In certainly exceptional cases, we may temporarily bump your rate limit higher. You
43+
should be prepared to answer technical questions about your goal and your planned usage of the API. We may still choose not to bump your limit if we feel that you can achieve your wildest
44+
dreams with the current rate limit (but don't worry, we'll help you out).

layouts/default.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ <h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/">Overvie
5050
<li><a href="/v3/meta/">Meta</a></li>
5151
<li><a href="/v3/oauth/">OAuth</a></li>
5252
<li><a href="/v3/rate_limit/">Rate Limit</a></li>
53+
<li><a href="/v3/troubleshooting/">Troubleshooting</a></li>
5354
</ul>
5455
</li>
5556
<li class="js-topic">

0 commit comments

Comments
 (0)