Remove hard-coded NCBI api_key from functions.conf nrdbGffDetails

Open Beginner friendly
  • Is something wrong?
#260 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
94/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
perl
Domain
api, backend

Research direction

Read Model/lib/jbrowse/functions.conf at nrdbGffDetails (around line 351) and locate the NCBI E-utilities esummary request. Remove its api_key parameter, leaving the rest of the request unchanged. Confirm the JBrowse 1 regression checks remain byte-identical, as required by the linked migration decision.

Written by the indexing model from the issue text.

Description

Model/lib/jbrowse/functions.conf nrdbGffDetails (line 351 at 5a80b14e0) calls NCBI E-utilities esummary from the browser with a hard-coded api_key. The key only raises the rate limit (3 req/s per IP without, 10/s with); one request per popup click from each user's IP doesn't need it, and a shared key in public client code puts every user on one budget that anyone can exhaust. Drop the api_key parameter; nothing else changes.

Deferred so the JBrowse 1 regression checks in the v5 work stay byte-identical (John). Decision: jbrowse5-migration 0010. Rotating the old key is for its owner.

Dominant language
Perl
Stars
1
Forks
1
Avg merge
1h 35m
Merged PRs (30d)
20

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from VEuPathDB/ApiCommonModel

All issues in VEuPathDB/ApiCommonModel

Similar issues

More Perl issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.