-
Notifications
You must be signed in to change notification settings - Fork 15
Labels
Milestone
Description
Prerequisites
Before beginning this issue, we should first complete:
Background info
- We urgently need to ship some updates to the referral-related APIs that currently live in ENSApi.
- The urgent updates we need to ship will include a bunch of breaking changes.
- This creates a significant change management problem.
- We must avoid breaking or blocking the ability for Jedrzej to continue shipping updates to ENSAwards.
- It is operationally complex for us to deploy updates to ENSApi -- especially to coordinate these updates with concurrent updates to ENSAwards that we merge at basically the same moment that we update the production deployment of ENSApi.
Suggested strategy
- Instead of making any changes to the existing referral-related APIs that currently live in ENSApi, we can instead create completely new referral-related APIs.
- Assume an implicit
/v0/...route prefix on all existing referral-related APIs. - Effectively copy-paste the existing referral-related API implementations under an explicit
/v1/...route.- The targeted outcome of this is that both the v0 and v1 implementations of these APIs will both exist and be exactly identical (initially!) Therefore, the PR associated with this issue has the goal of just making both of these API routes distinct but ultimately exactly identical.
- In future issues / PRs we will work to evolve the v1 implementation of these APIs to meet the new requirements while keeping the v0 implementation of these APIs completely unchanged.
- We will complete the (many!) significant breaking changes to the v1 implementation of these APIs while keeping the ENSAwards site on the v0 implementation of these APIs. Many updates are needed and will be completed across multiple PRs.
- Once the v1 implementation of these APIs is stable and deployed into production, we can create a PR for ENSAwards to transition all of its logic to the v1 implementation of these APIs.
- Once ENSAwards completes the transition of all its logic to the v1 implementation of these APIs, we can completely delete the v0 implementation of these APIs.
Goals for the PR associated with this issue
- Complete items 1, 2, and 3 from the "Suggested strategy" listed above. Items 4, 5, and 6 can be outside the scope of the PR associated with this issue.
- Introduce zero changes that would break the ENSAwards site.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status
Done