anuraghazra / anuraghazra/github-readme-stats

Allow Specifying GitHub IDs as Query Param for User Data Retrieval

Open
#3,488 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
JavaScript
Stars
79.8k
Forks
37.7k
PR merge metrics
No merged PRs in 30d

Description

### Is your feature request related to a problem? Please describe.

Currently, the API utilizes GitHub usernames to display user data. However, GitHub usernames are subject to change, potentially leading to broken URLs and disrupted user experiences. To address this issue, I propose the implementation of a new feature that allows users to specify GitHub IDs as query parameter.

### Describe the solution you'd like

Introduce an optional query parameter, such as `id`, to the relevant API endpoints. This parameter would enable users to retrieve user data based on the GitHub ID. By incorporating this feature, we can mitigate the impact of username changes and enhance the stability.

### Compatibility with existing URLs

The addition of a query parameter ensures backward compatibility while offering an alternative and more resilient means of identifying users.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.