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

894 commits

Author SHA1 Message Date
Travis Ralston
976f32fcab Clarify that /register must produce valid Matrix User IDs 
Fixes https://github.com/matrix-org/matrix-doc/issues/1793
 2019-06-05 23:23:23 -06:00
Travis Ralston
c8a3850598 Merge GET/PUT /state/:event_type endpoints 
Clarifying that the state key is optional, and how that works.

Fixes https://github.com/matrix-org/matrix-doc/issues/1182
 2019-06-05 23:06:00 -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
fc4965f274 Stronger spec words 2019-06-05 10:40:51 -06:00
Travis Ralston
aa110b2be2
Merge pull request #2025 from matrix-org/travis/1.0/3rdpartysigned 
Fix third party signed definitions for join APIs
 2019-06-05 07:10:19 -06:00
Travis Ralston
e8d6a57a2e
Merge pull request #2052 from matrix-org/travis/1.0/pushrules-kind 
Change reference for definition of push rule condition kinds
 2019-06-05 07:08:32 -06:00
Bruno Windels
8b28972a2d PR feedback 2019-06-04 09:29:12 +02:00
Bruno Windels
53aa8fe8ec clarify the order events in chunk for /messages 2019-06-03 09:47:09 +02:00
Travis Ralston
dc6d89caca Split download endpoints back apart 
Apparently you can't have an optional path parameter.
 2019-06-02 21:31:06 -06:00
Travis Ralston
1f86e8e31b Refactor documentation for content/media repository 
Fixes https://github.com/matrix-org/matrix-doc/issues/2060
Fixes https://github.com/matrix-org/matrix-doc/issues/772
Fixes https://github.com/matrix-org/matrix-doc/issues/888
 2019-06-02 21:25:11 -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
2ed37f5bf4 Clarify guest accounts and auth usage on /register 
Fixes https://github.com/matrix-org/matrix-doc/issues/1980
Fixes https://github.com/matrix-org/matrix-doc/issues/1984
 2019-05-29 21:03:19 -06:00
Travis Ralston
f9472bae41 Change reference for definition of push rule condition kinds 
Fixes https://github.com/matrix-org/matrix-doc/issues/1970
 2019-05-29 16:27:52 -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
0463084924 Spec 3PID unbind API 
As per [MSC1915](https://github.com/matrix-org/matrix-doc/pull/1915)

Implementation proof: 
* https://github.com/matrix-org/synapse/pull/4982
* https://github.com/matrix-org/sydent/pull/160

The only alteration made which differs from the proposal is clarity on how to handle homeservers not knowing the `id_server`. All other differences are unintentional.
 2019-05-28 15:05:41 -06:00
Travis Ralston
c5fdd5cb0b Change note style 2019-05-28 13:57:08 -06:00
Travis Ralston
551806a8ad Add a reference to the filtering module to /sync 2019-05-28 13:57:08 -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
b3d86f99b9 Add room summary spec 2019-05-27 20:20:00 -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
7b266b33da Add membership params 
Fixes https://github.com/matrix-org/matrix-doc/issues/1945
 2019-05-27 19:26:26 -06:00
Travis Ralston
ba520df004 Move lazy loading to a section in Filtering 2019-05-27 17:38:11 -06:00
Travis Ralston
b67161cf97 List the endpoints which are lazy-loading aware 2019-05-27 17:38:11 -06:00
Travis Ralston
34d6c1f4ad Clarify wording further for how to handle redundant members 
Note: This makes assumptions on what the TODO comment in Synapse means: e26e6b3230/synapse/handlers/pagination.py (L262)

Due to lack of implementation, it is assumed that using the same filter across multiple calls to /sync OR /messages will result in the redundant members being excluded in the next request. For example, calling /sync, then /messages which returns some members, then /sync again will exclude the members due to them being in /messages.
 2019-05-27 17:38:11 -06:00
Travis Ralston
d56df3238c Generalize wording to fit /messages and /sync 2019-05-27 14:47:46 -06:00
Travis Ralston
e7ed8a23ce Move lazy loading filter options to event filter 
The options also work on /messages
 2019-05-27 14:47:46 -06:00
Travis Ralston
1bda3fe2b2 Spec MSISDN UIA support 
Fixes https://github.com/matrix-org/matrix-doc/issues/1702

1702 describes the lack of `bind_msisdn` parameter, however the whole login type was missing from UIA.
 2019-05-26 21:49:46 -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
2b96d73305 Fix third party signed definitions for join APIs 
Fixes https://github.com/matrix-org/matrix-doc/issues/1978
 2019-05-26 15:39:35 -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
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
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
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
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
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
bf2b6e6daa remove references to presence lists 2019-01-28 15:05:10 +00:00
Travis Ralston
84a4ca62c3
Merge pull request #1786 from matrix-org/travis/spec/exp-caps 
Add support for unstable feature advertising via /versions
 2019-01-23 19:15:50 -07:00
Travis Ralston
052d68d83d
Merge pull request #1791 from matrix-org/travis/spec/rver-upgrades 
Add room version upgrades
 2019-01-23 19:04:24 -07:00
Travis Ralston
413bfaeb68 Add clarification that clients shouldn't use unstable things as stable 2019-01-23 19:03:14 -07:00