matrix-spec

The Matrix protocol specification

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

Richard van der Hoff cf87120d78 Fixes to the API docs * fix security data for DELETE /user/{userId}/rooms/{roomId}/tags/{tag} * fix definition for body of PUT /pushrules/{scope}/{kind}/{ruleId}/actions		9 years ago
api	Fixes to the API docs	9 years ago
attic	Consistently spell homeserver as homeserver	9 years ago
changelogs	Clarify `history_visibility` behaviour	9 years ago
drafts	random incoherent thoughts on reputation that should live somewhere	9 years ago
event-schemas	Add event as a parent for all event types	9 years ago
meta	Update doc style	10 years ago
scripts	Script to serve the generated swagger JSON	9 years ago
specification	Merge pull request #305 from matrix-org/rav/show_own_leave_event	9 years ago
supporting-docs	Remove port number from room IDs in pasted examples	9 years ago
templating	Change `id` in the push gateway poke to be `event_id` and spec that it's the Matrix event ID of the message. Correct the spec for badge count pushes which omit fields previously described as mandatory. Add more detail about when to use event_id to suppress dupes. Also add the push gateway doc so it's actually included in the spec.	9 years ago
.gitignore	Dump-swagger: take output file name rather than output dir	9 years ago
CONTRIBUTING.rst	Add CONTINUTING.rst	9 years ago
README.rst	alas clarify the room link	10 years ago
jenkins.sh	Remove redundant node event schema checker	9 years ago

README.rst

This repository contains the documentation for Matrix.

Structure
=========

- ``api`` : Contains the HTTP API specification.
- ``drafts`` : Contains documents which will make it into the specification
  and/or supporting documentation at some point in the future.
- ``event-schemas`` : Contains the `JSON Schema`_ for all Matrix events
  contained in the specification, along with example JSON files.
- ``meta`` : Contains documents outlining the processes involved when writing
  documents, e.g. documentation style, guidelines.
- ``scripts`` : Contains scripts to generate formatted versions of the
  documentation, typically HTML.
- ``specification`` : Contains the specification split up into sections.
- ``supporting-docs`` : Contains additional documents which explain design 
  decisions, examples, use cases, etc.
- ``templating`` : Contains the templates and templating system used to
  generate the spec.

Contributing
============

Known issues with the specification are represented as JIRA issues at
https://matrix.org/jira/browse/SPEC

If you want to ask more about the specification, or have suggestions for
improvements, join us on ``#matrix-dev:matrix.org`` via https://matrix.org/beta.

.. _JSON Schema: http://json-schema.org/