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.
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.
6 years ago
..
application-service Merge pull request #1629 from turt2live/travis/as/route-versions 6 years ago
client-server Merge pull request #1790 from matrix-org/travis/spec/login-redirect 6 years ago
files fix for https://github.com/matrix-org/matrix-doc/issues/270 9 years ago
identity Merge pull request #1644 from matrix-org/rav/is_token_grammar 6 years ago
push-gateway Improve wording on push gateways 6 years ago
server-server Add specification for room version 3: Event IDs as hashes 6 years ago
README README.rst: Add notes on how to build the spec 7 years ago
check_examples.py Revert giving get() a default 6 years ago
openapi_extensions.md Document OpenAPI extension 6 years ago
package.json Reinstate validator.js 9 years ago
validator.js Provide doc-comments with makeHandler(); cleanup 7 years ago

README

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