809528 - Limit parameter for feed API, with a value of 50 by default

Status: VERIFIED FIXED

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

Description

[John Karahalis [:openjck]]

Our feed API should provide an optional parameter for limiting the number of results, with a value of 50 by default.

Comment 1

[David Walsh :davidwalsh]

Reference:  https://github.com/mozilla/kuma/pull/674/files

What's an example URL endpoint for this?  I'm not entirely sure where to start with this.

Comment 2

[Luke Crouch [:groovecoder]]

e.g., http://developer.mozilla.org/en-US/docs/feeds/rss/revisions and http://developer.mozilla.org/en-US/docs/feeds/json/revisions powered by https://github.com/mozilla/kuma/blob/master/apps/wiki/feeds.py#L262

Comment 3

[Les Orchard [:lorchard]]

FWIW, there's currently a hardcoded limit of 100. Should be pretty easy to change that into a default and honor a query param for a different limit.

But, make sure to add an upper bound to the limit - say, 1000 or something, so that someone requesting the feed can't use ?limit=999999 and try grabbing ALL the things.

Comment 4

[Les Orchard [:lorchard]]

Actually, another thought I just had from IRC:

We can have a low ceiling like 50 or 100 items, as long as we also have an ?offset parameter to facilitate pagination through results.

An example use case would be a script that wants to scoop up every page under a certain tag in JSON. It could request 50 results using an offset incrementing by 50, until the results run out.

Comment 5

[[github robot]]

Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/fdef8f1525197870ff94a5ebb20f59dabd07af27
fix bug 809528 - Add limit param for RSS feeds

https://github.com/mozilla/kuma/commit/5e88792488443637af008978f360725422c71fe2
Merge pull request #751 from darkwing/rss-limit-809528

fix bug 809528 - Add limit param for RSS feeds

Comment 6

[Stephen Donner [:stephend] Not actively reading bugmail]

Verified on staging: 50 items by default on https://developer.allizom.org/en-US/docs/feeds/rss/revisions

Comment 7

[Stephen Donner [:stephend] Not actively reading bugmail]

Verified FIXED on prod now, too: https://developer.mozilla.org/en-US/docs/feeds/rss/revisions -- defaults to 50 items.