Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: properly abstract the backend from the frontend #13

Open
oSumAtrIX opened this issue Jul 13, 2023 · 1 comment
Open

fix: properly abstract the backend from the frontend #13

oSumAtrIX opened this issue Jul 13, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@oSumAtrIX
Copy link
Member

Issue

Currently, the API returns keywords such as "repository" or "login" propagating the backend naming schema (GitHub) but it does not make sense in the sense of the frontend of the API to mention them. ReVanced API clients don't have anything to do with GitHub.

  • /v2/team/members mentions "login".
  • /v2/{repo}/contributors mentions "repo" in the path as well as "GitHub" in the documentation

Solution

Properly transform the backend and abstract it in the API. As an example /v2/team/members can mention "name" instead of "login" and /v2/{repo}/contributors can mention "product" instead of "repo".

@alexandreteles alexandreteles self-assigned this Jul 13, 2023
@alexandreteles alexandreteles added the documentation Improvements or additions to documentation label Jul 13, 2023
@alexandreteles
Copy link
Member

This is primarily a documentation issue; not much has to be done refactor-wise. The propagation happened because as I built the main backend on top of GitHub's REST API, the automatic generation of docstrings picked up their API terms. I've put this in the backlog with a low priority because this effort is better done once we have all the endpoints structured adequately so I don't have too much rework.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 📋 Backlog
Development

No branches or pull requests

2 participants