matrix-org / matrix-org/matrix-spec

Appservice registration schema is incomplete

Open
#772 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

The current schemas at https://matrix.org/docs/spec/application_service/r0.1.2#id5 are missing types and don't have titles. Additionally, while most types can be guessed from context and examples, this is not the case for the optional protocols field.

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

Begin with the application service registration schema in the linked Matrix specification section. Compare the existing schemas with the surrounding types and examples, then identify the missing titles and types, including the optional protocols field. Done means the schemas are complete and the protocols type is explicitly documented.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.