Version Path Element Introduction

[erichfi]

User Story:

As a developer,
I want to have a version path element in API endpoints,
So that I can manage and integrate future API versions smoothly.

Acceptance Criteria

GIVEN the current API versioning,
WHEN new API requests are made,
THEN endpoints should reflect the version path, e.g., /v2/.

Product & Design Links:

N/A

Tech Details:

• Introduce the /v2/ versioning in the API endpoints.
• Make v2 available on a feature flag; it should not be in production yet.
• Clean up the current v2 for the registry and duplicate tests for v2.

Open Questions:

• Should /v2 be made unavailable on gitcoin.co, and how would this be managed with load balancer rules?

Notes/Assumptions:

• This will be the standard path for all future versions.
• The /v2 should only be available on the new domain, passport.xyz. 2 options here:
  • python code
  • or the preferred way: in the load balancer (@larisa17 can provide guidance here)

[nutrina]

This ticket basically says:

• take the current version of the API
• clone it
• make it available on the /v2 subpath without any other modification
• feature flag it, it should not be available in production
• clean up the v2 for the registry with this occasion (delete the current v2)
• also duplicate the tests and have them run against the v2 version of the api

Question:

• do we want to make sure the /v2 is not available on gitcoin.co --> this can be achieved via load balancer rules