matrix-org / matrix-org/matrix-spec

Make 'since=<empty>' mean the same as the absence of since

Open
#467 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-Client-Server clarification
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

When calling sync with an empty or undefined since parameter it gives back an error

`/_matrix/client/r0/sync?since=undefined`

Wouldn't it be better if it just gave back the initial sync data like

`/_matrix/client/r0/sync`

does, because like that you don't have to write two seperate functions, one for the initial sync (without a since parameter) and one for a normal sync (with a known next_batch and since parameter), you could just call sync with an undefined since and get an initial sync from that.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Matrix specification text for /_matrix/client/r0/sync and its since parameter. Clarify how an empty or undefined since value should compare with an omitted parameter, then update the documented behavior and examples so the expected initial-sync response is clear.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.