Confirmed users
920
edits
User:LesOrchard/BandwagonAPI: Difference between revisions
Jump to navigation
Jump to search
no edit summary
LesOrchard (talk | contribs) (Starting in on the resources) |
LesOrchard (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
== Bandwagon API == | == Bandwagon API == | ||
=== Open Questions === | |||
* How much detail about addons in collection responses is necessary? The less, the better, since building full addon records is expensive. | |||
* Product spec calls for ability to create collections for "auto-publishers" to sync with list of addons in browser. How is this distinguished from creating a collection in general, or is a distinction even necessary? | |||
=== Implementation Notes === | === Implementation Notes === | ||
| Line 11: | Line 19: | ||
The only URL that should be hardcoded (or preferably kept in a user preference) | The only URL that should be hardcoded (or preferably kept in a user preference) | ||
in the client application is the URL to the [[#.2Fapi | in the client application is the URL to the [[#.2Fapi.2Fsharing.2F|service document]]. | ||
This will not only make it easier to switch between production, staging, and dev instances | This will not only make it easier to switch between production, staging, and dev instances | ||
of the API, it will also make the client resilient to other more granular | of the API, it will also make the client resilient to other more granular | ||
| Line 156: | Line 164: | ||
*** i.e. <tt>Location: /api/1.3/sharing/collections/5497c4b6-f2e9-11dd-b326-7f8fd4293122</tt> | *** i.e. <tt>Location: /api/1.3/sharing/collections/5497c4b6-f2e9-11dd-b326-7f8fd4293122</tt> | ||
<!-- not necessary for now? | |||
===== DELETE - Delete a collection ===== | ===== DELETE - Delete a collection ===== | ||
* Response (on success) | * Response (on success) | ||
** Status: <tt>410 Gone</tt> | ** Status: <tt>410 Gone</tt> | ||
--> | |||
==== /api/sharing/collections/{uuid}/addons/{addon guid} ==== | ==== /api/sharing/collections/{uuid}/addons/{addon guid} ==== | ||
| Line 230: | Line 240: | ||
==== Addon Collection ==== | ==== Addon Collection ==== | ||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | ||
<collection xmlns="http://addons.mozilla.org/" | <collection xmlns="http://addons.mozilla.org/" | ||
xml:base="http://addons.mozilla.org/api/1.3/sharing/"> | |||
href="collections/98404f20-f2e0-11dd-9121-3307c31c9566" | |||
title="My Laptop Addons" | |||
writable="yes" subscribed="yes" | |||
lastmodified="2009-01-04T00:10:00Z"> | |||
<addon href="collections/98404f20-f2e0-11dd-9121-3307c31c9566/addons/AE93811A-5C9A-4d34-8462-F7B864FC4696"> | <addon href="collections/98404f20-f2e0-11dd-9121-3307c31c9566/addons/AE93811A-5C9A-4d34-8462-F7B864FC4696"> | ||
<meta> | <meta> | ||
| Line 260: | Line 272: | ||
check out what other people are discovering. | check out what other people are discovering. | ||
</description> | </description> | ||
<icon>https://addons.mozilla.org/en-US/firefox/images/addon_icon/138/1216845032</icon> | |||
<thumbnail>https://addons.mozilla.org/en-US/firefox/images/t/23099/1215517056</thumbnail> | <thumbnail>https://addons.mozilla.org/en-US/firefox/images/t/23099/1215517056</thumbnail> | ||
<rating>5</rating> | <rating>5</rating> | ||
<learnmore>https://addons.mozilla.org/addon/138</learnmore> | <learnmore>https://addons.mozilla.org/addon/138</learnmore> | ||
</addon> | </addon> | ||
<addon> | |||
<meta> | |||
<added>2009-01-02T00:00:12Z</added> | |||
<comments>You should really use this.</comments> | |||
</meta> | |||
<name>FoxyTunes</name> | |||
<type id="1">Extension</type> | |||
<guid>{463F6CA5-EE3C-4be1-B7E6-7FEE11953374}</guid> | |||
<version>50845</version> | |||
<status id="4">Public</status> | |||
<authors> | |||
<author>Alex Sirota</author> | |||
<author>Yahoo! Inc. </author> | |||
</authors> | |||
<summary> | |||
Do you listen to Music while surfing the Web?^M^MFoxyTunes lets | |||
you control almost any media player and find lyrics, covers, | |||
videos, bios and much more with a click right from your | |||
browser. | |||
</summary> | |||
<description> | |||
Do you listen to Music while surfing the Web?FoxyTunes lets | |||
you control almost any media player and find lyrics, covers, | |||
videos, bios and much more with a click right from your | |||
browser.Supports WinAmp, iTunes, Yahoo Music Engine, | |||
Pandora, foobar2000, Windows Media Player, Xbox Media Center, | |||
Musicmatch, Quintessential, J. River, jetAudio, XMPlay, | |||
MediaMonkey, Media Player Classic, Sonique, wxMusik, Real | |||
Player, XMMS, Noatun, Juk, Amarok, Music Player Daemon, | |||
Rhythmbox and many other players.Just click on the orange | |||
note and select your player.CNET Editor's Rating: 5/5 | |||
starsPC Magazine: Top 15 Firefox ExtensionsPC World: Top | |||
Download Picks | |||
</description> | |||
<icon>https://addons.mozilla.org/en-US/firefox/images/addon_icon/219/1226633195</icon> | |||
<thumbnail>https://addons.mozilla.org/en-US/firefox/images/t/20256/1209472104</thumbnail> | |||
<rating>5</rating> | |||
<learnmore>https://addons.mozilla.org/addon/219</learnmore> | |||
</addon> | |||
</collection> | </collection> | ||