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

978 commits

Author SHA1 Message Date
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
d7f37f92eb Merge branch 'master' into travis/1.0/fix-examples 2019-05-30 16:57:51 -06:00
Travis Ralston
d6d74c4cbe Switch to using $ instead of # for sub-types 
# is reserved by the swagger validator as a way to include partial content from a JSON object (eg: "#/path" would include {"test": true} from the object {"path":{"test":true}}). Instead of trying to convince the validator that it is wrong, we'll just use a different character.

Note that our rendering tools do not care about #-style references to objects. It's still somewhat worth changing the character though.
 2019-05-29 15:28:48 -06:00
Travis Ralston
c25afa663e Use consistent event examples throughout the Client-Server API 
Fixes https://github.com/matrix-org/matrix-doc/issues/1968
 2019-05-29 14:57:56 -06:00
Travis Ralston
15b8011f63 Add missing aesthetic parameters to /store-invite 
Fixes https://github.com/matrix-org/matrix-doc/issues/2048
 2019-05-29 13:37:58 -06:00
Travis Ralston
62890d21b2 Fix example Content-Type for /media/upload request 
Fixes https://github.com/matrix-org/matrix-doc/issues/1770
 2019-05-27 23:08:02 -06:00
Travis Ralston
699cafe670 v4 is v4, not v3 2019-05-27 21:27:54 -06:00
Travis Ralston
e610f085a9
Merge pull request #2019 from matrix-org/travis/1.0/msc1884-msc2002-v4-rooms 
Add version 4 rooms to the spec
 2019-05-27 20:08:12 -06:00
Travis Ralston
40cf4620d5
Merge pull request #2027 from matrix-org/travis/1.0/pw-change-uia 
Add rationale for UIA on change password, and how access tokens behave
 2019-05-27 19:48:48 -06:00
Travis Ralston
1aa71f2436
Merge pull request #2029 from matrix-org/travis/1.0/delete-alias 
Add M_NOT_FOUND definition for deleting non-existent aliases
 2019-05-27 19:43:04 -06:00
Travis Ralston
a30dbc590d Clarify that e2e keys are also obliterated 2019-05-26 21:39:09 -06:00
Travis Ralston
d52fcdacfa Add M_NOT_FOUND definition for deleting non-existent aliases 
Fixes https://github.com/matrix-org/matrix-doc/issues/1675
 2019-05-26 21:36:31 -06:00
Travis Ralston
221d9f24fd Clarify that logging out deletes devices too 
Fixes https://github.com/matrix-org/matrix-doc/issues/1651
 2019-05-26 21:30:55 -06:00
Travis Ralston
1d33adf62d Add rationale for UIA on change password, and how access tokens behave 
Fixes https://github.com/matrix-org/matrix-doc/issues/680
 2019-05-26 21:21:58 -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
Richard van der Hoff
14715468bb Make thumbnail dimensions mandatory 
Fixes #1883
 2019-04-26 14:41:19 +01:00
aqtusia
24e0ec4bce
Replace /bind with /3pid/bind 2019-04-14 18:17:44 +02:00
Travis Ralston
baf8948eb5 Describe M_UNSUPPORTED_ROOM_VERSION on invite and createRoom endpoints 
Spec for MSC1866: https://github.com/matrix-org/matrix-doc/pull/1866
 2019-02-24 21:55:04 -07:00
Anatoly Sablin
d52918a892 Fix #1904. 2019-02-24 22:26:32 +03:00
Travis Ralston
49119ed345
Merge pull request #1875 from matrix-org/travis/clarify-upgrades 
Clarify the recommendations for "transferable state"
 2019-02-18 06:14:43 -07:00
Travis Ralston
72242e4ebb
Merge pull request #1879 from matrix-org/travis/fix-capabilities 
Correctly nest the capabilities response object
 2019-02-11 21:45:02 -07:00
Travis Ralston
d31d2f5e57 Correctly nest the capabilities response object 
Everything is contained in a "capabilities" property, which is not represented by the schema. The example was correct.
 2019-02-11 20:31:48 -07:00
Travis Ralston
ef13aef8c3 Clarify the recommendations for "transferable state" 
Fixes https://github.com/matrix-org/matrix-doc/issues/1843
 2019-02-10 19:33:43 -07:00
Travis Ralston
6bbf22cd04 Add routes for retrieving account data 
Original proposal: https://github.com/matrix-org/matrix-doc/issues/1339

This contains no known differences to what was ultimately decided upon and implemented.
 2019-02-10 17:07:47 -07: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
df01acc6e2
Merge pull request #1828 from matrix-org/travis/spec/rooms-v3 
Add specification for room version 3: Event IDs as hashes
 2019-01-31 17:59:31 -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
9193d57dfd full stop 2019-01-30 19:47:16 -07:00
Travis Ralston
ccce6c196d Specify how capabilities work in the c2s API 
Original proposals:
* https://github.com/matrix-org/matrix-doc/pull/1753
* https://github.com/matrix-org/matrix-doc/pull/1804

Implementation proof:
* https://github.com/matrix-org/synapse/pull/4472
* https://github.com/matrix-org/matrix-js-sdk/pull/830

There is one change to MSC1753 which is included in this commit. MSC1804 remains unchanged. In the original proposal, the change password capability being present was an indication that password changes were possible. It was found that this doesn't really communicate the state very well to clients in that lack of a capability (or a 404, etc) would mean that users would erroneously not be able to change their passwords. A simple boolean flag was added to assist clients in detecting this capability.
 2019-01-30 19:43:55 -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
Travis Ralston
4437c383bb
Merge pull request #1790 from matrix-org/travis/spec/login-redirect 
Add a mechanism for redirecting clients after login
 2019-01-30 13:33:03 -07:00
Neil Johnson
afd399d7d4 remove unused schema defs 2019-01-30 11:43:30 +00:00
Travis Ralston
d2b35e5150
Merge pull request #1821 from matrix-org/travis/spec/rver-make-memberships 
Specify the room_version response property on /make_{leave|join}
 2019-01-29 10:19:13 -07:00
Erik Johnston
c0039c30f2
Minor wording changes from code review 
Co-Authored-By: turt2live <travpc@gmail.com>
 2019-01-29 09:05:20 -07:00
Travis Ralston
d12593feea Specify the room_version response property on /make_{leave|join} 
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1813
Implementation proof: https://github.com/matrix-org/synapse/pull/4447

There are no changes from the original proposal.
 2019-01-28 22:17:51 -07:00