Create v5 API, freeze v4, deprecate v3

mozilla / addons

☂ Umbrella repository for Mozilla Addons ✨

Other

123 stars 53 forks source link

Create v5 API, freeze v4, deprecate v3 #1805

Open diox opened 5 years ago

diox commented 5 years ago

We want to do an API version bump. The idea is to:

[x] Rename v4dev to v5. v5 will become the new "experimental / in progress" API version mozilla/addons#6622
- [x] Move addons-code-manager to v5 instead of v4dev mozilla/addons-code-manager#675
[x] Freeze v4 API mozilla/addons#8139
[ ] Deprecate v3 API mozilla/addons#1861
- [x] Make sure FxA uses v4 endpoint mozilla/addons#6342
- [x] Move Firefox to v4 endpoints https://bugzilla.mozilla.org/show_bug.cgi?id=1686187
- [x] Upgrade webext to use v4 mozilla/web-ext#2120
- [x] notify releng to update their langpack submission script mozilla-releng/scriptworker-scripts#316

In addition, the following needs to happen but does not block right now (will come back to bite us if we don't act on it though):

[x] Move addons-frontend to use v5. Blocked by https://github.com/mozilla/addons/issues/12436 essentially.

┆Issue is synchronized with this Jira Task

eviljeff commented 5 years ago

Move addons-frontend to use v5 ... does not block right now

It doesn't block creating v5, but it practically does block freezing v4 because we won't then be able to add any new feature to AMO frontend that relies on an API change (i.e. almost every new feature). If v4 isn't frozen it makes moving Firefox to v4 more risky too.

diox commented 5 years ago

Yeah. Technically we can plan for this because AFAIK there are no features planned for the frontend in Q2 or Q3 that would require extra API work besides recommended add-ons frontend changes in Q2. But it would definitely makes things a lot easier to just migrate frontend to v5 first, you're right.

eviljeff commented 4 years ago

A recent shower thought was to have a /api/vFirefox70/ (or whatever version of Firefox it was first introduced in) and only expose the subset of endpoints needed by Firefox at that point to /vFirefox70/ to de-couple the whole v3 (v4, v5...) API from what Firefox needs. If we were going to the effort of having changes made in Firefox I'd be in favour of jumping straight to a v5 base too

The blockers on removal are still getting consumers to upgrade though. We need an agreed commitment to move off the existing API versions - and that includes addons-frontend (so an agreement within the team) - backed by goals to do the work.

eviljeff commented 3 years ago

Updated the issue with new issues/bugs. We need to do some sort of external communications too (not a massive rush if we're looking at a 10+ month timescale but the sooner the better obviously)

eviljeff commented 3 years ago

https://docs.google.com/document/d/1I0C56T8uK-IZ3_h2NiasOkkyjxzzx2SMF7rNXAHpvvU/edit# for comms

diox commented 2 years ago

Note: we did publish the announcement on Feb 1st: https://blog.mozilla.org/addons/2021/02/01/addons-mozilla-org-api-v3-deprecation/

KevinMind commented 2 months ago

Old Jira Ticket: https://mozilla-hub.atlassian.net/browse/ADDSRV-11