matrix-org / matrix-org/matrix-spec

`/logout` does not take a request body, which is inconsistent

Open
#1,845 1 comment 0 reactions 0 assignees View on GitHub
wart
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

Other PUT and POST requests except for media upload take a JSON request body, even if that's just `{}`.

For some reason `/logout` is an exception to this, although it's not clear why or whether this is just an accident.

Area: https://spec.matrix.org/v1.8/client-server-api/#post_matrixclientv3logout

Contributor guide

Open the contributing guide

Research direction

Read the linked Matrix Client-Server API section for POST /_matrix/client/v3/logout and compare its request-body definition with the other PUT and POST endpoints. Confirm the intended consistency rule and update the specification so the logout endpoint's request-body behavior is explicit; done means the section clearly resolves whether an empty JSON body is required or allowed.

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
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.