indieweb / indieweb/microsub

Provide an option to return only unread entries in a timeline

Open
#24 11 comments 2 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
23
Forks
1
PR merge metrics
No merged PRs in 30d

Description

By default, a call to retrieve the timeline will still return already-read entries. However, in certain cases, such as if there are lots of unread entries and you start reading them from newest to oldest, or if somehow an entry was added far back in the timeline, you might want to see only the unread items.

This could be accomplished with an additional parameter to the [timeline](https://indieweb.org/Microsub-spec#Timelines) API call.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the Microsub specification's Timelines API section linked in the issue and review how timeline retrieval currently describes read and unread entries. Define the additional parameter and its unread-only behavior, then update the specification so the API change and its expected result are explicit.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.