matrix-org / matrix-org/matrix-spec

Grammar for account data types

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

Description

**Link to problem area**:

https://spec.matrix.org/v1.18/client-server-api/#client-config

**Issue**

No grammar is currently specified for the `type` of account data, so it's unclear for implementations what they have to support.

In particular:
* Which characters are allowed?
* What is the maximum length?
* Is a zero-length type permitted?

It seems like the [common namespaced identifier grammar](https://spec.matrix.org/v1.18/appendices/#common-namespaced-identifier-grammar) would be a good fit.

Contributor guide

Open the contributing guide

Research direction

Start with the client configuration section at the linked Matrix Client-Server API specification and compare its account-data description with the common namespaced identifier grammar in the linked appendix. Update the specification to define the account-data type grammar and verify that the allowed characters, maximum length, and empty-value behavior are explicit.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.