matrix-org / matrix-org/matrix-spec

Clarification: Should retrieving a single event return an array

Open
#690 1 comment 0 reactions 0 assignees View on GitHub
A-S2S clarification
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

Currently the spec for retrieving a single event [GET /_matrix/federation/v1/event/{eventId}](https://matrix.org/docs/spec/server_server/r0.1.4#get-matrix-federation-v1-event-eventid) has a response defined as:

Parameter | Type | Description
-- | -- | --
.. | .. | ..
pdus | [PDU] | **Required.** A single PDU. Note that events have a different format depending on the room version - check the room version specification for precise event formats.

The comment and the response type seem to disagree. Should this actually return a `PDU` instead of a `[PDU]`?

Contributor guide

Open the contributing guide

Research direction

Read the GET /_matrix/federation/v1/event/{eventId} definition and compare the declared pdus response type with its description of a single PDU. Check the referenced room-version event format, then align the response type and explanatory text so the specification resolves the question consistently.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.