anuraghazra / github-readme-stats

:zap: Dynamically generated stats for your github readmes

Home Page:https://github-readme-stats.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Allow Specifying GitHub IDs as Query Param for User Data Retrieval

rmhaiderali opened this issue · comments

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 github_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.