Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-02-06 22:33:43 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
4155 commits 28 branches 42 tags 34 MiB
Commit graph

764 commits

Author SHA1 Message Date
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
Travis Ralston f5fa7e5924 Change wording to encourage servers to make reasonable decisions 2019-01-17 14:05:30 -07:00
Travis Ralston aeb524ef89 Remove CAS login and reference it against r0.4.0 
The SSO module should cover what CAS provides, and r0.4.0 is good as a reference for how CAS could be implemented without us repeating it here.
 2019-01-16 16:13:53 -07:00
Richard van der Hoff 6e8739c989
Fix typo 
Co-Authored-By: turt2live <travpc@gmail.com>
 2019-01-11 08:15:08 -07:00
Travis Ralston 5cbfafaab7 Fix link to module 2019-01-09 17:17:50 -07:00
Travis Ralston b85f7bb248 Add room version upgrades 
Implements https://github.com/matrix-org/matrix-doc/issues/1501
 2019-01-09 17:02:09 -07:00
Travis Ralston 0eabf108d9 Add a mechanism for redirecting clients after login 
Implements https://github.com/matrix-org/matrix-doc/pull/1730
 2019-01-09 15:05:27 -07:00
Travis Ralston 3e7a5f5ea4 Initial draft for SSO support 2019-01-09 00:09:38 -07:00
Travis Ralston ccc1cdaead Add support for unstable feature advertising via /versions 
Incorporates https://github.com/matrix-org/matrix-doc/issues/1497
 2019-01-07 14:38:21 -07:00
Richard van der Hoff 8f1291a3e7
Merge pull request #1758 from QMatrixClient/kitsune/lazy-loading 
Spec lazy_load_members and include_redundant_members
 2018-12-24 10:29:36 +01:00
Kitsune Ral 8c80669d7a Add the paragraph for sync.yaml forgotten in the previous commit 2018-12-23 18:58:44 +09:00
Kitsune Ral 1639f27ec5 Describe the actual implication of omitting contains_url 
Closes #1750

Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
 2018-12-12 17:07:06 +09:00
Kitsune Ral 6d0def8b4c Spec lazy_load_members and include_redundant_members 
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
 2018-12-11 19:04:15 +09:00
Kitsune Ral 6782b6399f
Update according to the comments 2018-11-23 17:54:00 +09:00
Kitsune Ral 96d7eed1c6 joining.yaml: add missing response schema details 2018-11-17 19:21:08 +09:00
Konstantinos Sideris 192a6c2ab9 Use example.org on examples instead of domain.com which is a real domain 
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
 2018-09-02 17:58:21 +03:00
Travis Ralston 7d34995ece It's actually an "identity server implementing the Identity Service API" 
Also add a note about appservices being special.
 2018-08-31 15:35:32 -06:00
Travis Ralston 7ac76fa27c Actually we're going with "identity server" afterall 2018-08-31 15:04:00 -06:00
Travis Ralston ec248b436f Identity Service is lowercase 2018-08-31 15:04:00 -06:00
Travis Ralston cc0badaaa1 Fix all naming cases of "identity service" 
Fixes https://github.com/matrix-org/matrix-doc/issues/1396

Includes some "homeserver" fixes too. This commit does not include historical documentation or notes.
 2018-08-31 15:04:00 -06:00
Travis Ralston 683072e624
Merge pull request #1636 from turt2live/travis/c2s/id-server 
Clean up and flesh out all three editions of the /requestToken API
 2018-08-31 14:57:17 -06:00
Travis Ralston a1f655e5be Fix more error wording 2018-08-31 14:53:59 -06:00
Travis Ralston 1261da209d Fix wording for the homeserver not allowing a particular 3pid 2018-08-31 14:38:22 -06:00
Travis Ralston 824ce22caa Add additional clarity to the requestToken errors 2018-08-31 11:41:46 -06:00
Travis Ralston 5bb7eca8e8 English 2018-08-31 11:37:37 -06:00
Travis Ralston 60dd9231e0 Don't explain how the IS might accept a 3pid 
The IS is bound to it's own set of specifications, and if the client chose this API then they should be aware of the risks but not necessarily arbitrary alternatives.
 2018-08-31 11:26:28 -06:00
Travis Ralston 63fdd72f73 Fix error description on /account/3pid/email/requestToken 2018-08-31 11:24:35 -06:00
Travis Ralston f6d9e53f5c Clarify that homeserver must reject clients from setting m.fully_read 2018-08-31 11:13:32 -06:00
Travis Ralston 679ddabb53 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/read-markers 2018-08-31 10:34:19 -06:00
Travis Ralston a4c2b2b905 General clarity and spelling for the requestToken APIs 2018-08-31 10:32:30 -06:00
Travis Ralston 7f1b94c211 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/id-server 2018-08-31 10:29:09 -06:00
Travis Ralston e3ad253dca A sender is also required for the invite_state 2018-08-31 09:44:29 -06:00
Travis Ralston 2f824df8dd Define the real event types on the invite_state 2018-08-31 09:43:29 -06:00
Travis Ralston 2e3e189ea2 Merge remote matrix-org/master 2018-08-31 09:31:39 -06:00
Travis Ralston afa16f1e4e
Merge pull request #1606 from turt2live/travis/c2s/room-tags 
Update the room tagging documentation
 2018-08-31 08:36:40 -06:00
Travis Ralston 73736d41db
Merge pull request #1569 from turt2live/travis/c2s/user-directory 
Clarify the homeserver's behaviour for user searching
 2018-08-31 08:32:02 -06:00
Travis Ralston 7f719b23e7
Merge pull request #1589 from turt2live/travis/c2s/inhibit-login 
Document the inhibit_login registration option
 2018-08-30 18:21:39 -06:00
Travis Ralston dfaed5b525 Clean up and flesh out all three editions of the /requestToken API 
Fixes https://github.com/matrix-org/matrix-doc/issues/1634

Addresses some of https://github.com/matrix-org/matrix-doc/issues/1396
 2018-08-30 18:18:08 -06:00
Travis Ralston 5da3072eef Wording change ('may not' has a special meaning) 2018-08-30 16:32:14 -06:00
Travis Ralston f923d08078 Add read markers 
This is the spec for https://github.com/matrix-org/matrix-doc/issues/910

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

Some reverse engineering was required to work out the complete details as to how this works. In particular, the 405 for setting account data and the behaviour of m.read.

References:
* 405 for account data: d69decd5c7/synapse/rest/client/v2_alpha/account_data.py (L85-L90)
* m.read behaviour: d69decd5c7/synapse/rest/client/v2_alpha/read_marker.py (L45-L52)
 2018-08-30 16:21:31 -06:00
Travis Ralston 8bcd7d26e3 /3pid/delete returns an empty object 2018-08-30 15:28:43 -06:00
Travis Ralston 390f1c16f7 Remove mentions of identity services from /3pid/delete 
This will be covered by https://github.com/matrix-org/matrix-doc/issues/1194

For now, we can accept that homeservers may try to unbind, however clients should not rely on it.
 2018-08-30 15:27:36 -06:00
Travis Ralston 86c85aea71 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/3pid-binding 2018-08-30 15:23:50 -06:00
Travis Ralston 49c5677969 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/user-directory 2018-08-30 12:18:35 -06:00
Travis Ralston f04afaa9b9
Merge pull request #780 from mujx/missing-enum-fields 
Add missing enum fields for the set_presence parameter
 2018-08-30 11:37:34 -06:00
Travis Ralston 7ecf2406eb
Merge pull request #1590 from turt2live/travis/c2s/403-put-state 
Document 403 error for sending state events
 2018-08-30 06:50:48 -06:00
Travis Ralston c03f2f8d79 Minor touchups to the room tagging API 
Fixes some of https://github.com/matrix-org/matrix-doc/issues/1565
 2018-08-29 14:53:55 -06:00
Kitsune Ral 9bc1470305 Elaborate the structure of m.tag events 
...and corresponding structures in tag-related CS API calls

Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
 2018-08-29 14:47:59 -06:00
Hubert Chathi 5019fb7c49
Merge pull request #1359 from uhoreg/well-known 
.well-known discovery
 2018-08-29 10:40:54 -04:00
Travis Ralston d91395cf9f Document 403 error for sending state events 
Fixes https://github.com/matrix-org/matrix-doc/issues/1399
 2018-08-28 19:33:45 -06:00
Travis Ralston 1051aff108 Document the inhibit_login registration option 
Fixes https://github.com/matrix-org/matrix-doc/issues/1351
 2018-08-28 18:36:07 -06:00
Travis Ralston 436544b8f8 Clarify behaviour of ?set_presence=unavailable for /sync 2018-08-28 14:19:55 -06:00
Travis Ralston adef7babfa Merge remote-tracking branch 'matrix-org/master' into mujx/missing-enum-fields 2018-08-28 14:10:17 -06:00
Travis Ralston ad068bcd22 Fix the appservice directory visibility type parameter type 2018-08-28 12:11:36 -06:00
Travis Ralston e9579a7840 The rank in search results is actually a floating point number 
This was accidentally changed in https://github.com/matrix-org/matrix-doc/pull/1571 and appears to be the only instance.
 2018-08-28 11:01:43 -06:00
Travis Ralston 6cdb463829
Merge pull request #1571 from turt2live/travis/general/number-to-int 
Replace applicable types of 'number' to 'integer'
 2018-08-28 07:40:28 -06:00
Travis Ralston f9c7014a65
Merge pull request #1577 from turt2live/travis/c2s/search-filter 
Specify the type of filter the search API expects
 2018-08-27 19:09:19 -06:00
Travis Ralston 03065b0584
Merge pull request #1572 from turt2live/travis/c2s/sync-left-account-data 
Add `account_data` to left rooms in /sync
 2018-08-27 18:59:58 -06:00
Travis Ralston f2332d242a Add some SHOULDs and MUSTs to the user directory requirements 2018-08-27 18:58:16 -06:00
Travis Ralston bb515d15a4 Clarify which collation to use for user directory searching 2018-08-27 18:55:54 -06:00
Travis Ralston 9527ce31f5
Merge pull request #1570 from turt2live/travis/c2s/sync-filtering 
Update filtering API documentation
 2018-08-27 18:51:00 -06:00
Travis Ralston 87133d8505
Merge pull request #1574 from turt2live/travis/c2s/fix-directory-put 
Clean up PUT /directory/room
 2018-08-27 17:49:05 -06:00
Travis Ralston a0b17e6ed6
Merge pull request #1551 from turt2live/travis/c2s/push-rules 
General improvements to the push rules module
 2018-08-27 17:48:01 -06:00
Travis Ralston 97508d5dc5
Merge pull request #1554 from turt2live/travis/general/appservice-directories 
Application service room directories (and other third party network things)
 2018-08-27 17:47:34 -06:00
Travis Ralston 32ac81c588 Spelling 2018-08-27 17:41:27 -06:00
Travis Ralston 5fa6b49365 Specify the type of filter the search API expects 
Note: This is badly named until https://github.com/matrix-org/matrix-doc/pull/1570 lands

Fixes https://github.com/matrix-org/matrix-doc/issues/598
 2018-08-27 15:56:47 -06:00
Travis Ralston e60b44e27f Clean up PUT /directory/room 
Fixes https://github.com/matrix-org/matrix-doc/issues/933

The issue references two problems: a `roomInfo` and lack of a `room_id`. It appears the `room_id` has been fixed since reporting, however the `roomInfo` remained (and is now fixed).
 2018-08-26 22:27:34 -06:00
Travis Ralston 55c0b968b5 Fix event schemas for /sync 
This commit clarifies the required keys for each type of event that appears in sync, fixes the core event schema not declaring 'content' as required, and includes a mention that events may not have a room_id when appearing in /sync.

Fixes https://github.com/matrix-org/matrix-doc/issues/595
Fixes https://github.com/matrix-org/matrix-doc/issues/909
 2018-08-26 22:22:36 -06:00
Travis Ralston 008ebb8c1a Add account_data to left rooms in /sync 
Fixes https://github.com/matrix-org/matrix-doc/issues/1392
 2018-08-26 21:55:30 -06:00
Travis Ralston 667fa082af Replace applicable types of 'number' to 'integer' 
`number` implies/represents a float where `integer` does not.

The only remaining `type: number` in the project appear on power levels: those have been left untouched pending clarification.

Fixes https://github.com/matrix-org/matrix-doc/issues/746
 2018-08-26 21:32:44 -06:00
Travis Ralston b68ed5d594 Define the default for the contains_url filter param 
Fixes https://github.com/matrix-org/matrix-doc/issues/1553
 2018-08-26 21:21:49 -06:00
Travis Ralston 1cbcaba2c7 Clean up examples in filter.yaml 
Indentation, excess examples.
 2018-08-26 21:21:27 -06:00
Travis Ralston 26a7a341f0 Mark the filter_id in the response of POST /filter as required 2018-08-26 21:21:02 -06:00
Travis Ralston 97e3dd443b Update room_event_filter.yaml to use the OpenAPI allOf definition 
This is just maintenance.
 2018-08-26 21:20:01 -06:00
Travis Ralston 7d08ef73d0 Fix naming of the Filter schemas 
EventFilter !== Filter

Fixes https://github.com/matrix-org/matrix-doc/issues/1509
 2018-08-26 21:19:07 -06:00
Travis Ralston 1bc0f63bfb Clarify the homeserver's behaviour for user searching 
The homeserver can implement its own algorithm, but is suggested to ensure the requesting user can reasonably see the other users.

The text is intentionally left vague for whether or not the API is local users only to give the homeserver some flexibility in this area.

General cleanup is also included in this commit.

Fixes https://github.com/matrix-org/matrix-doc/issues/1108
 2018-08-26 21:04:02 -06:00
Travis Ralston b4be11af42 Document POST /account/3pid/delete 
Fixes https://github.com/matrix-org/matrix-doc/issues/985

Includes documentation for https://github.com/matrix-org/synapse/pull/3667

Raises https://github.com/matrix-org/matrix-doc/issues/1566
 2018-08-26 20:41:34 -06:00
Travis Ralston a803d9d077 Document validated_at and added_at on GET /3pid 
Fixes https://github.com/matrix-org/matrix-doc/issues/661
 2018-08-26 20:39:53 -06:00
Kitsune Ral c879eb950f client-server/openid.yaml: Fix a type'o 
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
 2018-08-25 22:49:12 +09:00
Travis Ralston 017d6db737 Document third party network/protocol directories (for appservices) 
Fixes https://github.com/matrix-org/matrix-doc/issues/869
 2018-08-24 11:07:30 -06:00
Travis Ralston 7ec3cc4343 General improvements to the push rules module 
This commit does a few things:
* Add 3 undocumented push rules to the spec for encrypted events and at-room notifications.
* Require unrecognized conditions to not match, ensuring that future conditions do not cause clients to accidentally notify users.
* Clarify that push rules should be enabled when created.
* Document a new condition required for at-room notifications.

Fixes https://github.com/matrix-org/matrix-doc/issues/1163
Fixes https://github.com/matrix-org/matrix-doc/issues/1034
Fixes https://github.com/matrix-org/matrix-doc/issues/676
Fixes https://github.com/matrix-org/matrix-doc/issues/1033
Relates to https://github.com/matrix-org/matrix-doc/issues/1101
 2018-08-22 15:21:21 -06:00