`jwt_token` not accurately named

Open

#181 opened on Aug 14, 2024 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 3/5
Estimated time: 1-2 days
Newbie friendliness: 35/100

Issue type: Refactor
Clarity: Mostly clear
Activity status: Stale
Tech stack: python
Domain: api, authentication

Research direction

Start in ghapi/core.py at lines 96-101 and trace how the GhApi constructor's authentication arguments are documented and consumed. Compare the terminology with the linked GitHub installation-token documentation; done means the selected naming, compatibility warning, and authentication guidance are consistently addressed.

Written by the indexing model from the issue text.

Description

In the constructor for a GhApi object, the jwt_token parameter appears to be used as a bearer token, whereas the token parameter uses an Authorization: token prefix:

https://github.com/fastai/ghapi/blob/4fe9459c7e7bd631c7317eaa9d2365f14f2cb34d/ghapi/core.py#L96-L101

There are other types of bearer tokens apart from JWTs. In the app space, installation access tokens are also passed via a Bearer header, but are not JWTs. These look more like PATs, starting with ghs_.

I might recommend:

clarifying the documentation on different ways to authenticate to the GitHub API, or pointing at the appropriate GitHub docs.
rename the current jwt_token arg to something like bearer_token
raise a non-fatal warning when jwt_token is specified, asking developers to use the appropriately-named bearer_token arg.

Dominant language: Python
Stars: 687
Forks: 69
Avg merge: 1m
Merged PRs (30d): 2

Contributor guide

Open the contributing guide

First steps

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

Similar issues

validate-structure inspecte challenge/work/.terraform et rend faux les labs qui ont un provider en cache Open

bug

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

stephrobert/dsoxlab#238 · Opened Sep 24, 2026
Uniform probability densities use the upper bound as an interval width Open

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

nasa/fmdtools#40 · Opened Sep 24, 2026
_common_folder() treats a single file as the common folder; single-file archives can't be installed (4.2.8) / crash (master) Open

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

sublimehq/package_control#1780 · Opened Sep 24, 2026
Set 'Sample' input in 'autorun.py' to utilize 'Sample' Tab in eLog Open

Difficulty 2/5 1-3 hours Newbie friendliness 65/100

pcdshub/mfx#309 · 2 comments · Opened Sep 24, 2026
niri config file addition does not respect existing optional include Open

Difficulty 2/5 1-3 hours Newbie friendliness 70/100

nwg-piotr/nwg-displays#145 · Opened Sep 24, 2026

More Python issues