Return a list of feed items

[PorterHoskins]

The server should return a list of feed items for the user to browse through.

Feed Item Types

• [ ] Video
• [ ] Event
• [ ] Product Listing

Endpoint Spec:

GET /feed

Query Arguments:

• count: number of items the server should return (Optional)
• index: the place where the server should start when fetching the feed items (Optional)

Headers

• Accept-Language: The language the application is running in. Titles, descriptions, and any other user facing string should come down from the server translated in that language.

Feed Item Model

• identifier: The unique identifier of the item String / GUID
• type: The unique identifier of the item (video, event, listing) String
• title: The title / name of the item String
• description : The description of the content in the item String
• index: The position of the item in the feed. Used for sorting and paging. Integer
• isActive: Flag to display the item or not

Video Data Model

Inherits from Feed Item

• previewImageURL: The url to the image for the frame of the video to show as a preview String
• videoURL: The url to the video stream String
• publishDate: The date the video was published String
• views: The number of times the video was viewed Integer

Event Data Model

Inherits from Feed Item

• coordinates: The GPS coordinates to the event to show on the map String
• address: The street address of the location String
• inviteURL: The link to the event on Eventbrite

Listing Data Model

Inherits from Feed Item

• price: The price of the product in USD Float
• previewImageURL: The url to the image for the product to show as a preview String

[PorterHoskins]

@dodgertodd @kingbrendann what do you guys think about this?

[PorterHoskins]

Updated it with product and Accept-Language

[PorterHoskins]

Updated with index on the Feed Item model

[dodgertodd]

I think I'd change Product into Listing. The Product model is going to be pretty key in the store. I think Listing has a Product. And a Product inheriting, for instance, index from FeedItem seems odd.

[dodgertodd]

I'm writing a RAML spec for this right now. It'll produce docs for us, run validations against schemas, can auto-generate test endpoints, and even skeleton endpoint code. It's pretty rad. Contracts ftw.

[M2LDev]

👍 agreed

[dodgertodd]

Another thing...should I pick on feed and feedItem ? Isn't the convention that a collection resource should be the pluralized version of the type of items in the collection? So it should be feedItems ? Worth it?

[PorterHoskins]

Another thing...should I pick on feed and feedItem ? Isn't the convention that a collection resource should be the pluralized version of the type of items in the collection? So it should be feedItems ? Worth it?

Are you saying the GET /feed should be GET /feedItems? That works for me.

[PorterHoskins]

@dodgertodd we need to add type to the feed item so the parsers can know what it is. Added to the spec.

[PorterHoskins]

@dodgertodd Can you add it to the RAML?

[PorterHoskins]

We might want to add an optional query argument to the feed endpoint someday to pass a list of types if we want to support filtering.

[kingbrendann]

The event object should have a link to the Eventbrite page. They use that for ticketing and stuff.

[kingbrendann]

Let's close this.