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
Kegan Dougal 365a9076b9 Add nested dict template support; Add x-pattern
For cases where event schema specify `patternProperties` it would be nice
to give that pattern a "human-readable" form rather than a raw regex. This
is now supported by specifying `x-pattern` in the value part of the specified
pattern e.g. `patternProperties:{ "^.*":{ x-pattern: "$THING", ... } }`

Templating had limited record type descriptions limited to value primitives
e.g. `{string: integer}`. It now supports inspecting the values recursively
if the value is `object`.

Updated `m.receipt` to take both these points into account to make it read
better. Tweak receipt module text.
10 years ago
api Merge pull request #64 from matrix-org/erikj/invite_state 10 years ago
attic Add v1 registration / login stuff into attic dir 11 years ago
drafts Merge pull request #26 from matrix-org/macaroons 10 years ago
event-schemas Add nested dict template support; Add x-pattern 10 years ago
meta Update doc style 11 years ago
scripts Merge pull request #76 from matrix-org/speculator-speedup 10 years ago
specification Add nested dict template support; Add x-pattern 10 years ago
supporting-docs glue footer to the bottom 11 years ago
templating Add nested dict template support; Add x-pattern 10 years ago
.gitignore .gitignore speculator 11 years ago
CHANGELOG.rst Add sync API yaml. Add template for sync_http_api. 11 years ago
README.rst alas clarify the room link 11 years ago
jenkins.sh Add the jenkins command to source control so that we can update 10 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/