NatLabRockies / NatLabRockies/api-umbrella

Add option to make HTTP caching ignore URL query string ordering

Open
#32 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Add something like boltsort or querystring so that we can treat these two requests as the same for caching purposes:

/api/whatever?limit=10&start=50
/api/whatever?start=50&limit=10

This sort-indepdant behavior should not be the default, however (since the query string ordering can matter to some backends). It should be an option that has to be explicitly turned on for specific api backends.

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

No file, test, or entry point is named. Start by locating the HTTP cache-key construction and the configuration path for options on specific API backends, then compare the requested behavior with the linked boltsort and querystring projects. Done means query parameter ordering can be ignored only when explicitly enabled, while default behavior remains unchanged.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua, nginx
Domain
api, backend-api-design, performance
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.