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

818 commits

Author SHA1 Message Date
Andrew Morgan
2068cba598 Clients should submit a POST request 2019-06-10 09:14:25 +01:00
Andrew Morgan
7116f9334e More consolidation 2019-06-10 09:09:26 +01:00
Andrew Morgan
d1fde0837a Consolidate id_server into ref. id_server/next_link are ignored 2019-06-10 09:06:13 +01:00
Andrew Morgan
ab0c1bc054 Add changelog, update imperative check, rename sid.yaml 2019-06-10 08:41:35 +01:00
Andrew Morgan
fe23de7d7f A SMS -> An SMS 2019-06-10 05:20:15 +01:00
Andrew Morgan
046a834488 Slight code cleanup 2019-06-09 22:04:58 +01:00
Andrew Morgan
2551ff6ce0 Actually check in code 2019-06-09 20:12:59 +01:00
Andrew Morgan
525bedf8e1 Fix refs 2019-06-09 20:10:44 +01:00
Andrew Morgan
fba61941af Move submit_url responses to ref 2019-06-09 20:02:57 +01:00
Andrew Morgan
0ded484276 Address review comments 2019-06-09 16:10:44 +01:00
Andrew Morgan
1776ba28d3 Address review comments 2019-06-08 18:52:38 +01:00
Andrew Morgan
a8edb066aa Clear up some wording 2019-06-07 18:00:12 +01:00
Andrew Morgan
8a6ef187db more object! 2019-06-07 17:52:17 +01:00
Travis Ralston
a38af2009f
Apply suggestions from code review 
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2019-06-07 10:37:57 -06:00
Travis Ralston
906d3cd447
Merge pull request #2055 from matrix-org/travis/1.0/registration-clarification 
Clarify guest accounts and `auth` usage on /register
 2019-06-07 10:05:56 -06:00
Andrew Morgan
62910a28cc Merge branch 'master' into anoa/hs_3pid_tokens 
* master:
  Update example
  Fix 404s in links from room v1 spec
  Provide a more complete example of a "minimally-sized event"
  Revert signature change for redactable event test
  Clarify how many PDUs are in a given transaction object
  Clarify that the server shouldn't process retries for UIA
  Clarify when authorization and rate-limiting are not applicable
  Skip over partial event definitions in examples
  Rename example to invite_room_state
  Shorten references to StrippedState in s2s spec
  Fix examples of StrippedState in s2s spec
  Clarify exactly what StrippedState is
  Clarify that UIA stages cannot be attempted twice
  Fix test vectors with invalid JSON and signature
  Spec 3PID unbind API
  Spec MSISDN UIA support
 2019-06-07 15:55:04 +01:00
Andrew Morgan
3148184052 HS' can send 3PID token. Add a new submit_url field 2019-06-07 15:54:51 +01:00
Travis Ralston
a0e8201816
Apply suggestions from code review 
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2019-06-07 08:27:53 -06:00
Travis Ralston
77c4c4b07c Add general clarity 2019-06-07 08:27:18 -06:00
Travis Ralston
9cf03325b9
Merge pull request #2046 from matrix-org/travis/1.0/msc1915-unbind 
Spec 3PID unbind API
 2019-06-07 07:33:33 -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
f0eb495cee Clarify how notification counts are calculated in /sync 
Fixes https://github.com/matrix-org/matrix-doc/issues/2015
 2019-06-06 15:41:28 -06:00
Travis Ralston
afead2eb1b Clarify LL in /sync a bit more 2019-06-06 14:18:41 -06:00
Travis Ralston
e1266b859f
Merge pull request #2030 from matrix-org/travis/1.0/bind-msisdn 
Spec MSISDN UIA support
 2019-06-06 10:24:34 -06:00
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