875536 - Make a special Fireplace API namespace

Status: RESOLVED FIXED

(Marketplace Graveyard :: API, defect, P3)

Description

[Andy McKay]

There's a bunch of APIs for fireplace that are very fireplace specific. This calls are things that we don't expect other clients to make and are formatting their response in a way that we wouldn't normally expect. This makes it hard for fireplace, we can't change things quickly and hard for clients who expect things to happen in a certain way (the GET /apps/app/...) for example. Another is the home page (http://firefox-marketplace-api.readthedocs.org/en/latest/topics/home.html#get--api-v1-home-page-) which is returning a result exactly the way fireplace wants. If that design changes, we shouldn't change the api.

URLs that I think we should move:

/home/page/ > /fireplace/home/
/apps/app/(int:id)|(str:slug) > /fireplace/app/(int:id)|(str:slug) *
/search/featured/ > /fireplace/search/featured/


** /apps/app/ will stay where it is, its just that /fireplace/app/ will have the more expanded result that fireplace wanted (users, upsell etc)

Any others?

* /apps/rating/ contains user information, I'm tempted to fork it similar to /apps/app/


We'll need to move documentation and make clear that whilst clients can use this, we won't be worrying about changing things rapidly as the fireplace client needs change.

Comment 1

[Allen Short [:ashort]]

https://github.com/mozilla/zamboni/commit/c829719
https://github.com/mozilla/zamboni/commit/292ba68