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

1206 commits

Author SHA1 Message Date
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
Travis Ralston
9dd171a718
Merge pull request #2069 from matrix-org/bwindels/messages-chunk-order 
Clarify the order events in chunk are returned in for /messages
 2019-06-04 10:59:45 -06:00
Bruno Windels
8b28972a2d PR feedback 2019-06-04 09:29:12 +02:00
Travis Ralston
010757c01d
Merge pull request #2057 from matrix-org/anoa/clarify_email_sending 
Clarify what the client should receiving on email resending
 2019-06-03 11:05:28 -06:00
Andrew Morgan
0b42a17352
Update api/identity/definitions/request_email_validation.yaml 
Co-Authored-By: Travis Ralston <travpc@gmail.com>
 2019-06-03 09:48:38 +01: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
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
d7f37f92eb Merge branch 'master' into travis/1.0/fix-examples 2019-05-30 16:57:51 -06:00
Andrew Morgan
c0c4629993
Slight word change 2019-05-30 12:31:26 +01:00
Andrew Morgan
6ae7e49522
Clarify what the client should receiving on email resending 
It was a little unclear what the client should do when asked to send a validation email and provides a `send_attempt` value that is not greater than previous attempts. As this is intended to be for when a client mistakenly sends the request twice, it makes logical sense that the implication was to simply resend a success value so the client doesn't error even when an email may have been sent on the first attempt.

This behaviour was also mimicked in Synapse/Sydent.
 2019-05-30 12:30:43 +01: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
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
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
699cafe670 v4 is v4, not v3 2019-05-27 21:27:54 -06:00
Travis Ralston
b3d86f99b9 Add room summary spec 2019-05-27 20:20:00 -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
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
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