matrix-org / matrix-org/matrix-spec
Homeserver signing key grammar is not clear
Open
Beginner friendly
Nobody has claimed this yet.
A-S2S
clarification
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
https://spec.matrix.org/v1.5/server-server-api/ makes faint references to the key *version*, which should match `[a-zA-Z0-9_]`. Ideally though, it would be nice for it to be formally spelt out in https://spec.matrix.org/v1.5/appendices/#identifier-grammar or similar.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the linked Server-Server API and Identifier Grammar sections first, comparing how signing-key versions are described. Clarify the allowed key-version characters in the identifier grammar and make the Server-Server API reference consistent; done means both linked sections formally state the same rule.
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
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100