911382 - Collections API should also allow filtering on ids for region/carrier/category

Status: RESOLVED FIXED

(Marketplace Graveyard :: API, defect, P2)

Description

[Matt Basta [:basta]]

https://marketplace-dev.allizom.org/api/v1/rocketfuel/collections/?cat&region=2&carrier=0

You can see that this list of results contains collections that have regions other than "2".

Specifying `cat=None` (and other values) does not seem to show only collections for the homepage.

Comment 1

[Mathieu Pillard [:mat]]

The filtering stuff is because you need to use slugs, not ids. 
https://marketplace-dev.allizom.org/api/v1/rocketfuel/collections/?cat&region=us&carrier=carrierless works

Not sure about cat=None yet, I'll have to look into it.

Comment 2

[Matt Basta [:basta]]

Mmmm. Can you update the docs, then?

http://firefox-marketplace-api.readthedocs.org/en/latest/topics/rocketfuel.html#get--api-v1-rocketfuel-collections-

Comment 3

[Mathieu Pillard [:mat]]

Oops, my bad, I will. Unless you need IDs? In which case I can try to fix it to really accept both.

Comment 4

[Matt Basta [:basta]]

We're using IDs for everything now, but I'll change it to use slugs.

Comment 5

[Mathieu Pillard [:mat]]

Ok. For what it's worth, I switched to slug to be compatible with what the App Search API does. I expected IDs to still work, but there must be some django-filter weirdness I had not anticipated.

Comment 6

[Matt Basta [:basta]]

It's a little wonky that you filter with slugs bug the category/region/carrier fields in the collection objects return IDs.

Comment 7

[Chuck Harmston [:chuck]]

I'd be really happy if we could take slugs or IDs anywhere.

Comment 8

[Mathieu Pillard [:mat]]

Updated description. I opened https://bugzilla.mozilla.org/show_bug.cgi?id=911414 for the filtering on category=''.

Comment 9

[Mathieu Pillard [:mat]]

PR to allow filtering on null and ids: https://github.com/mozilla/zamboni/pull/1082

Comment 10

[Mathieu Pillard [:mat]]

Fixed in https://github.com/mozilla/zamboni/commit/e2e71c7579fc1ef0f32de896c0c2d6b7f453fcdf

We now allow filtering on both slugs and ids for region/carrier/cat.