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

Consolidate the REST API #1500

Open
mssola opened this Issue Nov 2, 2017 · 0 comments

Comments

Projects
None yet
1 participant
@mssola
Copy link
Contributor

mssola commented Nov 2, 2017

Someone from the community started the REST API (see #1299), which is quite a big deal. This was also important because we were starting to transition to Vue, which required some work on an API level. Because of this, we started to add more and more endpoints organically. This is good because it means that we are building an API that makes sense (at least for us), but it also means that the totality of it hasn't been designed from the very beginning. This can lead to some inconsistencies, and some areas for improvement.

This issue is a reminder that for a 3.0 version of Portus we need to:

  1. Evaluate what went well and what went wrong during the process of creating the v1 version of the REST API.
  2. Check whether we can provide fixes on the API without breaking anyone's workflow (e.g. creating a v1.1 version and deprecating old endpoints).
  3. After point 2, we should evaluate when to roll out a v2 of the API that removes the oddities of v1.
  4. For v2: add endpoints accepting requests from the registry (see discussion).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment