Separate /articles and /devices

mozilla-services / readinglist

Reading List Server

https://readinglist.readthedocs.org

Other

36 stars 9 forks source link

Separate /articles and /devices #11

Closed tarekziade closed 9 years ago

tarekziade commented 9 years ago

I see we have a little device API baked in here. Ideally this will disappear when Ben's folks address proper FxA device management, but in the mean time it might be worth separating this into a separate namespace: /articles/1/ for v1 of the reading list API, and /devices/1/ for v1 of the reading list devices API.

leplatrem commented 9 years ago

Opened discussion regarding this: #23

rnewman commented 9 years ago

As mentioned in #23, I think we can do away with normalized device support altogether for now. When marking an article as read or creating a new article, we can rely on the client providing a "{added,marked_read}_by" string for display.

Natim commented 9 years ago

Do we want to handle multiple device information for added_by and marked_read_by?

rnewman commented 9 years ago

No.

The former is the device you first added the record on (see #20), which is immutable‡.

The latter is the device that last transitioned the record from unread=1 to unread=0. In order to modify the latter, you need to explicitly mark the record as unread again first.

The purpose of these two fields is to support a very simple form of provenance for entries —

    BEYOND WHISTLEBLOWING
    [icon] crimethinc.com
    Saved from Richard's iPad on Tuesday

‡ "But what if I rename my device?" you correctly ask. Or what if I have two iPads? Yeah, I know.

Natim commented 9 years ago

Ok this answer our questions about the /devices endpoint.