NatLabRockies / NatLabRockies/api-umbrella

Allow rate limiting by custom request header key/value

Open
#307 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
2.2k
Forks
373
PR merge metrics
No merged PRs in 30d

Description

Context

API Umbrella currently supports rate limiting by IP address and API Key.

Idea

As an API Owner
I would like to create a rate limit rule based on a specific request header
so that I can rate limit based on the HTTP Origin Header

Feature request

Add a third option under rate limiting that would allow rate limit rule(s) to be defined based on a specific, but arbitrary, HTTP header key.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the existing IP-address and API-key rate-limiting configuration and implementation, then locate their tests or entry points. The issue does not name files or tests; done should mean that a rate-limit rule can use an arbitrary HTTP request header key and apply consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua, nginx, ruby
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.