586701 - [API] Put the C in CRUD for the Add-on model

Status: RESOLVED FIXED

(addons.mozilla.org Graveyard :: API, defect, P1)

Description

[Wil Clouser [:clouserw]]

Spec: https://wiki.mozilla.org/User:Clouserw/AMO/API

There is a bit of a spec at the URL above, but most of it is just straight up CRUD.  The piston docs[1] can help with how to integrate map our models to their classes.  This should use the JSONEmitter and accept at least JSON as input (it looks like piston does this for free).  This should use our OAUTH setup for authentication.

[1] http://bitbucket.org/jespern/django-piston/wiki/Documentation#piston-documentation

Comment 1

[Dave Dash [:davedash, :dd] (assign all bugs to mbrandt)]

Is this /addons/ via PUT in your docs?  

In my mind it should be POST, not PUT...

Comment 2

[Dave Dash [:davedash, :dd] (assign all bugs to mbrandt)]

Also is the addon XPI to be base64 encoded?

Also, not familiar with XPIs but is there enough data in the XPI that a version can be created automatically: version, platforms, etc?

Comment 3

[Wil Clouser [:clouserw]]

> Is this /addons/ via PUT in your docs?

Yes

> In my mind it should be POST, not PUT...
You're right.  The spec was originally written with the idea that put==create (which is still how I read the RESTful guidelines), but stick with what the piston docs say.  I updated the spec, but let me know if you think there is anything else that needs adjusting.

> Also is the addon XPI to be base64 encoded?
Is there a reason not to use multipart/form-data to send it as a file?

> Also, not familiar with XPIs but is there enough data in the XPI that a
> version can be created automatically: version, platforms, etc?
I think so, CCing Jorge.

Comment 4

[Dave Dash [:davedash, :dd] (assign all bugs to mbrandt)]

multipart/form-data makes sense... 

writing tests for this will be a PITA...

oh wait, it already is a PITA... OAuth is a bitch.

Comment 5

[Jorge Villalobos [:jorgev] (he/him)]

https://developer.mozilla.org/en/Install_Manifests

install.rdf should contain the add-on UUID, name, version number and application compatibility, including version ranges. What it normally doesn't have is the platform information, which is something the author indicates when uploading it.

Comment 6

[Dave Dash [:davedash, :dd] (assign all bugs to mbrandt)]

http://github.com/jbalogh/zamboni/commit/d27ccef