wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
4927 commits 4 branches 0 tags 17 MiB
Commit graph

203 commits

Author SHA1 Message Date
Travis Ralston
74b627ac0b Fix the response format of the /send endpoint 
Fixes https://github.com/matrix-org/matrix-doc/issues/2236
 2020-05-20 17:42:15 -06:00
Kegsay
fc91946e5a
Update api/server-server/backfill.yaml 
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2020-05-20 11:07:35 +01:00
Kegan Dougal
9765116c47 Make backfill wording clearer 2020-05-20 10:11:30 +01:00
Travis Ralston
05e83f2e7d Fix more describes -> describe 2020-05-19 09:55:55 -06:00
Travis Ralston
7c0046ffc7 describes -> describe 2020-05-19 08:09:19 -06:00
Travis Ralston
d419e3b38a Remove extraneous spaces 2020-05-19 08:08:31 -06:00
Travis Ralston
a2a1694c35 Spec v2 send_join and send_leave endpoints 
MSC: https://github.com/matrix-org/matrix-doc/pull/1802

Fixes https://github.com/matrix-org/matrix-doc/issues/2541

This also adds the v2 invite endpoint to the ACL protected list as that appears to be an omission.
 2020-05-15 14:10:06 -06:00
Travis Ralston
42ae5c966a Clarify the limits of prev_events and auth_events 
Fixes https://github.com/matrix-org/matrix-doc/issues/2307

These restrictions are due to a Synapse change which never made it to the spec prior to the MSC process. This is therefore documenting an omission.

Synapse's numbers are verified here: 207b1737ee/synapse/handlers/federation.py (L1183-L1213)

... and Synapse's handling of the backfill endpoint is described here: 207b1737ee/synapse/handlers/federation.py (L829-L837)

This also includes a mention that https://github.com/matrix-org/matrix-doc/pull/1594 should render the `auth_events` limitation unnecessary. 

No changes are required to the the "checks on receipt of a PDU" section of the server-server spec as it starts with "must be a valid event", to which an event is invalid if it contains too many prev or auth events.
 2020-05-12 19:02:39 -06:00
Gnuxie
6b8b31ce63
correct use of required annotation in json-schema 
https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.5.3
 2020-05-06 17:10:39 +01:00
Patrick Cloke
fc03f7faa6 Remove query_auth from the specification per MSC2451. 2020-03-24 12:42:15 -04:00
Travis Ralston
8d865ca53a Add s2s POST /publicRooms per MSC2197 
See https://github.com/matrix-org/matrix-doc/pull/2197
 2019-09-24 13:36:51 -06:00
Alexey Andreyev
9ed19a37ad
Client-server: Fix upload keys example request 
Contributes to #1733

Signed-off-by: Alexey Andreyev <aa13q@ya.ru>
 2019-07-08 22:28:32 +03:00
Travis Ralston
8ac555f870
Merge pull request #2083 from matrix-org/travis/1.0/key-object 
Clarify the key object definition for the key management API
 2019-06-11 09:50:34 -06:00
Travis Ralston
8b7887dfc2 Link to key algorithms section 2019-06-11 09:47:02 -06:00
Travis Ralston
6d60258e25
Merge pull request #2080 from matrix-org/travis/1.0/msc2076-msc2077-v5-rooms 
Spec v5 rooms: Key validity
 2019-06-11 08:51:25 -06:00
Travis Ralston
b7378a860a
Merge pull request #2097 from matrix-org/travis/1.0/common-themes 
Specify some of the common concepts for Matrix in the index
 2019-06-11 07:51:06 -06:00
Travis Ralston
cf19f52576 Enforce 7 day validity requirement everywhere 
also misc formatting fixes
 2019-06-10 13:21:24 -06:00
Travis Ralston
6d62a1b444
Merge pull request #2084 from matrix-org/travis/1.0/s2s-swagger-touchups 
Touchups on the s2s swagger definitions
 2019-06-10 07:22:24 -06:00
Travis Ralston
70da564e2b
Merge pull request #2067 from matrix-org/travis/1.0/stripped-state 
Clarify exactly what StrippedState is
 2019-06-07 07:12:17 -06:00
Travis Ralston
b9c9396c11 Specify some of the common concepts for Matrix in the index 
See https://github.com/matrix-org/matrix-doc/pull/2061
Fixes https://github.com/matrix-org/matrix-doc/issues/1468
Fixes https://github.com/matrix-org/matrix-doc/issues/1528

The section is not referenced by the specifications yet - they do a fairly good job of explaining it over and over. In future, it would be good to point all the references to the index.
 2019-06-06 15:59:54 -06:00
Travis Ralston
9bf0103ef3 Clarify how many PDUs are in a given transaction object 
Fixes https://github.com/matrix-org/matrix-doc/issues/2093
 2019-06-06 14:36:30 -06:00
Travis Ralston
e115e3439d Touchups on the s2s swagger definitions 
Duplicate properties, wrong types, etc.
 2019-06-05 22:13:25 -06:00
Travis Ralston
a19eb59f13 Clarify the key object definition for the key management API 
Fixes https://github.com/matrix-org/matrix-doc/issues/1907


One too far
 2019-06-05 22:09:42 -06:00
Travis Ralston
a6314df44c Spec v5 rooms: Key validity 
Proposals:
* [MSC2076](https://github.com/matrix-org/matrix-doc/pull/2076)
* [MSC2077](https://github.com/matrix-org/matrix-doc/pull/2077)

Implementation references:
* 00bf99fa62
* https://github.com/matrix-org/synapse/pull/5354
* https://github.com/matrix-org/synapse/pull/5321

No known differences from the proposals are included here - alterations are accidental.
 2019-06-05 17:03:19 -06:00
Travis Ralston
0b45f3795b Rename example to invite_room_state 
This is a better representation of what it actually is
 2019-06-02 18:02:22 -06:00
Travis Ralston
237d585e07 Shorten references to StrippedState in s2s spec 2019-06-02 17:59:19 -06:00
Travis Ralston
b9c4a2561f Fix examples of StrippedState in s2s spec 2019-06-02 17:50:27 -06:00
Travis Ralston
7a07a6b358 Clarify exactly what StrippedState is 
Fixes https://github.com/matrix-org/matrix-doc/issues/2066

The expectation everywhere is that the `sender` is required. `/initialSync` references StrippedState through a `m.room.member` event reference, and does not need editing.
 2019-06-02 17:41:39 -06:00
Travis Ralston
699cafe670 v4 is v4, not v3 2019-05-27 21:27:54 -06:00
Travis Ralston
3b0e194ff7 Add version 4 rooms to the spec 
As per [MSC1884](https://github.com/matrix-org/matrix-doc/pull/1884) and [MSC2002](https://github.com/matrix-org/matrix-doc/pull/2002).

No known changes since the proposals were accepted.

Due to being in the area: This fixes https://github.com/matrix-org/matrix-doc/issues/1863
 2019-05-24 15:50:05 -06:00
Andrew Morgan
3c62b90dfb Add missing punctuation 2019-05-07 16:59:10 -07:00
Anatoly Sablin
d52918a892 Fix #1904. 2019-02-24 22:26:32 +03:00
Travis Ralston
71f251c733
Merge pull request #1855 from matrix-org/travis/fix-wk-fallback 
Fix contradiction in wellknown discovery for servers
 2019-02-06 12:22:59 -07:00
Travis Ralston
c8428b1f8b Fix contradiction in wellknown discovery for servers 
Fixes https://github.com/matrix-org/matrix-doc/issues/1854
 2019-02-05 22:39:36 -07:00
Travis Ralston
3dd0601a96 Remove more TLS fingerprint talk 2019-02-04 13:52:20 -07:00
Travis Ralston
222957157f Add missing required flags 2019-02-01 13:56:30 -07:00
Travis Ralston
1d0156ad78 Fix more titles 2019-02-01 13:37:19 -07:00
Travis Ralston
985d02d95e Fix titles in schemas 2019-02-01 13:35:38 -07:00
Travis Ralston
82bed06d3f The event *format* changes, not the version 2019-02-01 13:19:24 -07:00
Travis Ralston
890fb1a019 Fix examples for new schema 
Fix missed example in make_join

Fix state array in response of send_join

Try removing examples from send_join?

Try printing more information about the error

Copy/paste known working examples

Try schema definitions in the response?
 2019-02-01 11:14:42 -07:00
Travis Ralston
5d8fa65e6e De-duplicate state keys 2019-02-01 10:11:39 -07:00
Travis Ralston
33406e4662 Apply event format warnings to the remainder of the s2s spec 2019-02-01 10:08:30 -07:00
Travis Ralston
9b214ec16d Make the backfill response aware of event format changes 2019-02-01 08:40:18 -07:00
Travis Ralston
e27c83d9f8
Merge pull request #1817 from matrix-org/neilj/remove_presence_lists 
remove references to presence lists
 2019-02-01 08:37:08 -07:00
Travis Ralston
41e50d553e
Merge pull request #1830 from matrix-org/travis/spec/x509-wk 
Specify .well-known s2s discovery and X.509 validation
 2019-02-01 08:36:55 -07:00
Travis Ralston
01556e5b17 Clarifications and bug fixes in how v3 rooms work 2019-01-31 16:44:37 -07:00
Travis Ralston
c888f3f080 Make example strings more legible 2019-01-31 00:09:30 -07:00
Travis Ralston
0347e873ef Specify .well-known s2s discovery and X.509 validation 
Original proposals:
* https://github.com/matrix-org/matrix-doc/pull/1708 (note: the JSON requirements were softened by https://github.com/matrix-org/matrix-doc/pull/1824)
* https://github.com/matrix-org/matrix-doc/pull/1711

Implementation proofs:
* https://github.com/matrix-org/synapse/pull/4489
* No explicit PRs for MSC1711 could be found, however Synapse is known to implement it.

There are no intentional changes which differ from the proposals in this commit, however the author has relied upon various historical conversations outside of the proposals to gain the required context. Inaccuracies introduced by the author are purely accidental.
 2019-01-30 22:11:31 -07:00
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
Neil Johnson
afd399d7d4 remove unused schema defs 2019-01-30 11:43:30 +00:00