matrix-org / matrix-org/matrix-spec

Federated media multipart/mixed JSON object shouldn't be required to be empty

Open
#1,952 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

spec-bug
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

Link to problem area:
https://github.com/matrix-org/matrix-spec/blob/2cbf6067a6d50ea2160e72d2a570f2cb8eeb0a20/data/api/server-server/content_repository.yaml#L44-L45
https://spec.matrix.org/v1.11/server-server-api/#get_matrixfederationv1mediadownloadmediaid

Issue
MSC3916 point 4 describes the federated multipart/mixed media metadata JSON object as

No properties are yet specified for the JSON object to be returned. One possible use is described by https://github.com/matrix-org/matrix-spec-proposals/pull/3911.

However the spec entry just says 'Currently, this always be an empty object.'

Expected behaviour
Either mention that there are currently no standard fields for the object in spec, or have an explanation similar to other areas in the spec where objects are allowed extending with keys that follow Java package naming convention.
afaik current server implementations already just parse the JSON object but don't enforce it to be empty.

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 with data/api/server-server/content_repository.yaml at lines 44-45 and compare the rendered media download endpoint with MSC3916 point 4. Update the specification so it no longer incorrectly requires the multipart metadata object to be empty, using wording consistent with the proposal or existing extensible-object guidance. Done when the source and rendered API description agree.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.