keybase / keybase/keybase-issues

Request: API endpoint, response field, or docs on rate limit status

Open
#2,789 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
899
Forks
40
PR merge metrics
No merged PRs in 30d

Description

I wanted to make a more formal request for some way a consumer of the API can fetch info regarding rate limiting, have it returned in responses, or at the very least have information about expected behavior of clients in the website docs. To be clear, I'm not running into issues with the rate limiting, but as I'm working on an API wrapper I realized that I'm flying blind. I'd like to be able to proactively throttle requests and respect your resources, rather than just making requests until receiving an error and guessing at how long to back off. It would be helpful to inform the user of the library about where they are with respect to the rate limit.

I don't foresee a specific application where this would be strictly necessary, but it's a pretty standard feature of public APIs and it would be a simpler process to block on a request until the appropriate time than to either retry behind the scenes or return an error with no information to the user.

From reading #2102 and #1804 it appears that you're using nginx alone for the rate limiting, so I understand that it's not a trivial feature to add to bake it into the API. It would be helpful, if possible, to include the rate limiting configuration of nginx in the website docs if adding it to the API isn't something you can work on. Thanks!

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading issues #2102 and #1804, then review the rate-limiting behavior and nginx configuration referenced in this request. Decide whether the accepted scope is an API endpoint, response information, or website documentation; done should mean the chosen behavior and expected client throttling or backoff guidance are clearly available to API consumers.

Written by the indexing model from the issue text.

Assessment

Tech stack
nginx
Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.