matrix-spec-proposals

Proposals for changes to the matrix 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 838af2a23e Updates to swagger table generation A bunch of related fixes to the code for parsing the state and API yaml files: 1. Some of our objects are {key: {key: value}} - style nested key/value dictionaries. Handle this by refactoring get_json_schema_object_fields so that such objects are handled wherever they appear, rather than when they are just subproperties of a 'proper' object. 2. Fix multi-level inheritance (so an object can have an 'allOf' property which can successfully refer to an object which itself has an 'allOf' property). 3. $ref fields in event schemas weren't being expanded correctly 4. sort type tables breadth-first rather than depth-first so that the ordering in complex structures like the /sync response makes a bit more sense.		9 years ago
api	Guest users are allowed room initialSync	9 years ago
attic	Add v1 registration / login stuff into attic dir	10 years ago
drafts	More formatting..	9 years ago
event-schemas	Specify guest room access	9 years ago
meta	Update doc style	10 years ago
scripts	speculator: Nessle up some more if statements	9 years ago
specification	Merge pull request #161 from matrix-org/daniel/guestdisplaynames	9 years ago
supporting-docs	typos and fixes	9 years ago
templating	Updates to swagger table generation	9 years ago
.gitignore	.gitignore speculator	9 years ago
CHANGELOG.rst	Go into a bit more detail about feature profiles	9 years ago
README.rst	alas clarify the room link	10 years ago
jenkins.sh	If build.py throws, actually print stdout. Also run jenkins.sh in verbose mode.	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/