Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify ApiInfo rate limiting usage in docs #1524

Merged
merged 8 commits into from
Jan 1, 2017
Merged

Clarify ApiInfo rate limiting usage in docs #1524

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ac86bfc
Draft section on ApiInfo in getting started
SeanKilleen Dec 24, 2016
307d461
typo: to --> do
SeanKilleen Dec 28, 2016
7492a86
Add link to github api
SeanKilleen Dec 30, 2016
d7b35aa
Add note on authenticated client limits
SeanKilleen Dec 30, 2016
9d575a8
wording tweak
SeanKilleen Dec 31, 2016
4c242bd
Point to better API doc link
SeanKilleen Dec 31, 2016
c44777c
change variable init in code sample
SeanKilleen Dec 31, 2016
e653995
Merge remote-tracking branch 'refs/remotes/octokit/master' into addRa…
SeanKilleen Dec 31, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,22 @@ If you've authenticated as a given user, you can query their details directly:
```
var user = await client.User.Current();
```

### Too Much of a Good Thing: Dealing with API Rate Limits
Like any popular API, Github needs to throttle some requests. The OctoKit.NET client allows you to get some insight into how many requests you have left and when you can start making requests again. It does this via the `ApiInfo` object and the `GetLastApiInfo()` method.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a hyperlink to the github API docs "rate limiting" section? Also maybe it's worth mentioning that an authenticated client has a much higher limit than anonymous

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Great feedback; will do.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has been done.


Example usage:

```csharp
var client; //Create the client up here

// Prior to first API call, this will be null, because it only deals with the last call.
var apiInfo = client.GetLastApiInfo();

// If the ApiInfo isn't null, there will be a property called RateLimit
var rateLimit = apiInfo?.RateLimit;

var howManyRequestsCanIMakePerHour = rateLimit?.Limit;
var howManyRequestsToIHaveLeft = rateLimit?.Remaining;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ToIHaveLeft => DoIHaveLeft

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Nice catch, thanks.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

var whenDoesTheLimitReset = rateLimit?.Reset;
```