docs-matrix-spec/api
Travis Ralston ff75996524 Add specification for room version 3: Event IDs as hashes
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1659
Implementation proofs (some traversing of the PR tree may be required to get all of them):
* https://github.com/matrix-org/synapse/pull/4483
* https://github.com/matrix-org/synapse/pull/4499

This doesn't intentionally change anything from the proposal.

**Implementation details**:

The simple part of this is the introduction of a rooms/v3.html document. The somewhat unclear part is the stuff done to the s2s definitions. This pulls `unsigned_pdu` out to `unsigned_pdu_base` (all fields except `event_id`) where it can be reused in `pdu` and `pdu_v3` (for rooms v3). These definitions are further moved into the room version specifications where they can highlight the exact schemas in detail.

Version 1 has been updated to include the pre-existing event format, however the core principles of the room have not been changed. The same applies to room version 2. Room versions have immutable core principles once in the spec, otherwise these format changes would land in a pre-existing version.

The client-server API event formats will need updating, however that is being punted to a different commit to try and keep these changes reviewable.
2019-01-30 17:03:03 -07:00
..
application-service Merge pull request #1629 from turt2live/travis/as/route-versions 2018-08-30 11:11:25 -06:00
client-server Merge pull request #1790 from matrix-org/travis/spec/login-redirect 2019-01-30 13:33:03 -07:00
files fix for https://github.com/matrix-org/matrix-doc/issues/270 2016-02-16 11:01:04 +00:00
identity Merge pull request #1644 from matrix-org/rav/is_token_grammar 2018-08-31 16:05:23 -06:00
push-gateway Improve wording on push gateways 2018-08-15 11:59:58 -06:00
server-server Add specification for room version 3: Event IDs as hashes 2019-01-30 17:03:03 -07:00
check_examples.py Revert giving get() a default 2018-07-29 14:04:07 +09:00
openapi_extensions.md Document OpenAPI extension 2018-08-12 16:52:07 +09:00
package.json Reinstate validator.js 2016-05-04 00:19:46 +01:00
README README.rst: Add notes on how to build the spec 2017-10-25 09:57:02 +01:00
validator.js Provide doc-comments with makeHandler(); cleanup 2017-11-15 07:28:25 +09:00

This directory contains swagger-compatible representations of our APIs. See
the main README.rst for details on how to make use of them.