Update:RequirementsV33
From MozillaWiki
« Back to Update:Remora
The goal of AMO Version 3.3 is to support Web API access to AMO content. There are two target clients of the API: Firefox 3 and extension authors.
Firefox 3 [edit]
The new Add-Ons Manager for Firefox 3 includes a revised dialog that allows content from AMO to be displayed. A design walkthru depict this new set of interactions.
Add-Ons in this context refers to the triumvirate of extensions/add-ons, themes and plugins.
Add-Ons Details [edit]
| ID |
Priority |
Requirement |
Assignee |
Bug/Design links |
| DTL-1 |
P1 |
Retrieve Add-Ons attributes |
laura |
bug 399913 |
- Attributes should include:
- name
- type (plugin/extension/theme)?
- description
- thumbnail?
- rating
- "reviews" URL
- "learn more" URL
- "install" URL
|
| DTL-2 |
P1 |
Support the UpdateInfoURL mechanism |
|
bug 395857 |
- Firefox 3 now supports display of "release notes" when add-ons updates are available. More details
|
Add-Ons Lists [edit]
| ID |
Priority |
Requirement |
Assignee |
Bug/Design links |
| LIST-1 |
P1 |
Retrieve a list of recommended add-ons from a single or all categories (n random results) |
laura |
bug 400715 |
- Since only the first n (3? 5?) recommendations are listed, the API doesn't need to return the entire recommended set. In fact, the results should appear to be "random" so that the same list of n addons doesn't always appear at the top of the list. Note also that since the Fx 3 client will need to subtract out the already installed addons, we may want to return more than simply n.
- Open Issue: What happens if we change the AMO design to allow for multiple recommendation lists (e.g. based on user type - new user, advanced user, extension developer, web developers, etc...)
- Possible Answer: The reco list only returns results from the new and adv user reco lists.
- Given : app name/version, (list of installed addons)
- Return: list of recommended addons, link to "more results" on AMO, total number of recommended
|
| LIST-2 |
P1 |
Retrieve a list of featured add-ons for the AMO site |
laura |
bug 400716 |
| LIST-3 |
P2 |
Retrieve a list of new add-ons (n results) |
laura |
bug 400718 |
Add-Ons Search [edit]
| ID |
Priority |
Requirement |
Assignee |
Bug/Design links |
| SRCH-1 |
P1 |
Ability to retrieve AMO search results |
laura |
bug 400719 |
- Given : text query, app name/version
- Return: list of compatible, public addons matching query
|
| SRCH-2 |
P1 |
Limit search results to addons only or plugins only or themes only |
laura |
bug 400721 |
Add-Ons Ratings [edit]
| ID |
Priority |
Requirement |
Assignee |
Bug/Design links |
| RATE-1 |
P2 |
Ability to submit/upload a user ratings of an addon |
laura |
bug 400722 |
-
Open Issue: Do we require login to submit a rating? How to prevent abuse if no login is collected?
- This has been deferred until we agree on an authentication mechanism.
|
Extension Authors [edit]
Extension authors and developers have indicated that they are looking for more metrics and information about the current usage and popularity of their add-on on AMO. To that end, we should offer a read-only API to allow extension authors access that data.
Download Details [edit]
| ID |
Priority |
Requirement |
Assignee |
Bug/Design links |
| DOWN-1 |
P1 |
API should be web-ready (REST) and format should be XML for easier integration into PHP and AJAX sites |
laura |
not a functional req hence no bug # |
| DOWN-2 |
P1 |
Retrieve Cumulative Downloads |
laura |
bug 403939 |
- Parameters should include:
- GUID or identifier for addons
- Version number: either all versions of the addon or only the current version
- Locale Specification: either all locales or a specific locale
- Firefox version: either all or a specific version of Firefox {need spec}
- OS Platform: either all or a specific OS platform {need spec}
|
| DOWN-3 |
P2 |
Retrieve Period X Downloads |
|
|
- Parameters should include:
- Period: enum of either {Day, Week or Month}
- Date: specific day, specific week or specific month
|
| DOWN-4 |
P2 |
Offer the cumulative download count for all addons versions, locales, platforms, fx versions as an RSS 1.0/RSS 2.0/ATOM feed |
|
|
Usage Details [edit]
| ID |
Priority |
Requirement |
Assignee |
Bug/Design links |
| USE-1 |
P1 |
Retrieve Period X Update Pings |
laura |
bug 405900 |
- Parameters should include:
- GUID or identifier for addons
- Version number: either all versions of the addon or only the current version
- Locale Specification: either all locales or a specific locale
- Firefox version: either all or a specific version of Firefox {need spec}
- OS Platform: either all or a specific OS platform {need spec}
- Period: enum of either {Day, Week or Month}
- Date: specific day, specific week or specific month
|
Future Ideas [edit]
- Offer an upload API for extension authors to send their XPI to AMO
- Offer an upload API for sites like MozDev.org to be able to send XPI's in batches (perhaps a sync API?)
