Clarify ApiInfo rate limiting usage in docs #1524
Conversation
SeanKilleen
changed the title
|
I think breaking it up is good, so we can include the basic information asap |
| var rateLimit = apiInfo?.RateLimit; | ||
|
|
||
| var howManyRequestsCanIMakePerHour = rateLimit?.Limit; | ||
| var howManyRequestsToIHaveLeft = rateLimit?.Remaining; |
There was a problem hiding this comment.
ToIHaveLeft => DoIHaveLeft
There was a problem hiding this comment.
👍 Nice catch, thanks.
| @@ -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. | |||
There was a problem hiding this comment.
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
There was a problem hiding this comment.
👍 Great feedback; will do.
There was a problem hiding this comment.
This has been done.
SeanKilleen
changed the title
|
@ryangribble based on your review: ✅ Added link to Github API The build seems to be failing on Travis, but that seems unrelated since I didn't modify the build script. :) |
SeanKilleen
changed the title
|
|
||
| An authenticated client will have a higher limit than an anonymous client. | ||
|
|
||
| For more information on the API and understanding rate limits, you may want to consult [the Github API docs on rate limits](https://developer.github.com/v3/rate_limit/). |
There was a problem hiding this comment.
I think it would be better to link to this page since it provides info about rate limits etc, rather than the link you had (which is the doc for the actual "Get Rate Limit" API call)
There was a problem hiding this comment.
@ryangribble done.
| var whenDoesTheLimitReset = rateLimit?.Reset; | ||
| ``` | ||
|
|
||
| An authenticated client will have a higher limit than an anonymous client. |
There was a problem hiding this comment.
Let's say "a significantly higher limit" here since its's a big difference
|
@ryangribble ready for review again at your leisure. Thanks for taking the time to be so thorough. And happy new year! |
…teLimitInfoToDocs
|
Awesome stuff, thanks so much for the additional clarity in the docs and congrats @SeanKilleen on the first merged contribution of 2017! Happy New Year 🎉 |
|
|
ryangribble
changed the title
ryangribble
changed the title
ryangribble
changed the title
ryangribble
changed the title
nickfloyd
added
Type: Documentation
Supports #1142.
Remaining Work
If you'd like to break this PR up at all to get some of the basic info in, let me know and I'll switch it up.