matrix-org / matrix-org/matrix-spec

Room event fields say content is the HTTP body

Open
#867 0 comments 0 reactions 0 assignees View on GitHub
clarification
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

> When interacting with the REST API, this is the HTTP body.

This isn't entirely true if dealing with certain APIs. Should clarify what endpoints expect it to be the body rather than blanket statement this.

Contributor guide

Open the contributing guide

Research direction

Review the room event field descriptions containing the statement that content is the HTTP body. Identify the affected wording and the endpoints where the statement is not accurate, then revise it to describe the applicable cases without making a blanket claim. Confirm that the resulting specification text distinguishes which endpoints expect content as the body.

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
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.