zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2025-12-06 07:16:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Mentioning the reset time is based on UTC standard (#1819)

Browse Source
This commit is contained in:
Ehsan Mirsaeedi
2018-06-20 08:32:12 -04:00
committed by Ryan Gribble
parent 3b2be81486
commit f34a4298e4
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/getting-started.md
View File

@@ -89,7 +89,7 @@ var rateLimit = apiInfo?.RateLimit;
var howManyRequestsCanIMakePerHour = rateLimit?.Limit;
var howManyRequestsDoIHaveLeft = rateLimit?.Remaining;
var whenDoesTheLimitReset = rateLimit?.Reset;
var whenDoesTheLimitReset = rateLimit?.Reset; // UTC time
```
However, if in some cases you need to get the Rate Limit directly from Github, you should call `GitHubClient.Miscellaneous.GetRateLimits()`.
@@ -107,14 +107,14 @@ var coreRateLimit = miscellaneousRateLimit.Resources.Core;
var howManyCoreRequestsCanIMakePerHour = coreRateLimit.Limit;
var howManyCoreRequestsDoIHaveLeft = coreRateLimit.Remaining;
var whenDoesTheCoreLimitReset = coreRateLimit.Reset;
var whenDoesTheCoreLimitReset = coreRateLimit.Reset; // UTC time
// the "search" object provides your rate limit status for the Search API.
var searchRateLimit = miscellaneousRateLimit.Resources.Search;
var howManySearchRequestsCanIMakePerMinute = searchRateLimit.Limit;
var howManySearchRequestsDoIHaveLeft = searchRateLimit.Remaining;
var whenDoesTheSearchLimitReset = searchRateLimit.Reset;
var whenDoesTheSearchLimitReset = searchRateLimit.Reset; // UTC time
```
An authenticated client will have a significantly higher limit than an anonymous client.