Update:RequirementsV33: Difference between revisions

Jump to navigation Jump to search
no edit summary
No edit summary
Line 16: Line 16:
</tr>
</tr>
<tr>
<tr>
<td>DTL-</td>
<td>DTL-1</td>
<td>P1</td>
<td>P1</td>
<td>Retrieve Add-Ons attributes</td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td colspan=5>
* Attributes should include:
** name
** type (plugin/extension/theme)?
** description
** thumbnail?
** rating
** "reviews" URL
** "learn more" URL
** "install" URL
</td>
</tr>
</tr>
</table>
</table>
Line 34: Line 47:
</tr>
</tr>
<tr>
<tr>
<td>RECO-</td>
<td>RECO-1</td>
<td>P1</td>
<td>P1</td>
<td>Retrieve a list of recommended add-ons</td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td colspan=5>
* 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
 
</td>
</tr>
</tr>
</table>
</table>
Line 52: Line 77:
</tr>
</tr>
<tr>
<tr>
<td>SRCH-</td>
<td>SRCH-1</td>
<td>P1</td>
<td>P1</td>
<td>Ability to retrieve AMO search results</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td colspan=5>
* Given : text query, app name/version, list of installed addons
* Return: list of compatible, public addons matching query
* Issue: Does AMO or Fx do the final set subtraction (result set less already installed set)
* Answer: For privacy reasons it would probably be better to have the client filter out already-installed addons
* Issue: What happens if we change search to include "special" results for cases where, e.g. no matching addons were found or we add "see also" type results.
</td>
</tr>
<tr>
<td>SRCH-2</td>
<td>P1</td>
<td>Limit search results to addons only or plugins only or themes only</td>
<td></td>
<td></td>
<td></td>
<td></td>
Line 70: Line 114:
</tr>
</tr>
<tr>
<tr>
<td>RATE-</td>
<td>RATE-1</td>
<td>P1</td>
<td>P1</td>
<td>Ability to submit/upload a user ratings of an addon</td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td colspan=5>
* Open Issue: Do we require login to submit a rating? How to prevent abuse if no login is collected?
</td>
</tr>
</tr>
</table>
</table>
Some of the requirements derived from this design include:
* RETR-001: Ability to retrieve extension description
* RATE-001: Ability to upload user ratings of addons
** Open Issue: Do we require login? How to prevent abuse?
* SEARCH-001: Ability to retrieve AMO search results
** Given : text query, app name/version, list of installed addons*
** Return: list of compatible, public addons matching query
** Open Issue: Does AMO or Fx do the final set subtraction (result set less already installed set)
** SRCH-001b: Limit search results to addons only or plugins only or themes only
***"Recommended addons" feed***
Given : app name/version, list of installed addons*
Return: list of recommended addons, link to "more results" on AMO, total number of results
***Addon data required (for search results, recommended)***
  - name
  - type (plugin/extension/theme)?
  - description
  - thumbnail?
  - rating
  - "reviews" link
  - "learn more" link
  - "install" URL
* For privacy reasons it would probably be better to have the client filter out already-installed addons


= Extension Authors =
= Extension Authors =
1,071

edits

Navigation menu