Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-22 09:18:38 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
3643 commits 30 branches 42 tags 32 MiB
Commit graph

915 commits

Author SHA1 Message Date
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 38ae166e9d
Merge pull request #1505 from turt2live/travis/general/3pid_invite 
Clarify how third party invites work
 2018-08-31 08:38:40 -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 4bd23a9086 send_attempt is no longer optional 2018-08-30 22:28:50 -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 ce14779af1
Merge pull request #1567 from turt2live/travis/c2s/3pid-binding 
Document `validated_at`, `added_at`, and POST /3pid/delete
 2018-08-30 16:33:24 -06:00
Travis Ralston 5da3072eef Wording change ('may not' has a special meaning) 2018-08-30 16:32:14 -06:00
Travis Ralston 2a08a308f3 device_keys are required 2018-08-30 16:29:24 -06:00
Travis Ralston 219b27b182 Merge remote matrix-org/master 2018-08-30 16:27:20 -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
Richard van der Hoff 0f84c69805
Merge branch 'master' into rav/clarify_event_signing 2018-08-30 22:48:56 +01: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 d57b977a55 Merge branch 'm-master' into travis/general/3pid_invite 2018-08-30 15:01:31 -06:00
Travis Ralston e82c22b060
Merge pull request #1615 from turt2live/travis/is/touchups 
Touch up more of the identity service specification
 2018-08-30 12:23:25 -06:00
Travis Ralston f09db16027 Merge remote-tracking branch 'matrix-org/master' into travis/s2s/key-mgmt 2018-08-30 12:19:59 -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 cc1e496287
Merge pull request #1629 from turt2live/travis/as/route-versions 
Version all appservice endpoints and provide a fallback
 2018-08-30 11:11:25 -06:00
Travis Ralston 0f2e01f5b5
Merge pull request #1555 from turt2live/travis/as/cleanup 
Application service spec cleanup; Security definitions; r0 prep
 2018-08-30 11:08:10 -06:00
Travis Ralston be5c566028 Version all appservice endpoints and provide a fallback 
Fixes https://github.com/matrix-org/matrix-doc/issues/1616
 2018-08-30 11:03:42 -06:00
Travis Ralston 6b52e1df77
Merge pull request #1587 from turt2live/travis/s2s/clarify-state-ids-inclusion 
Clarify that the requested event is excluded from /state and /state_ids
 2018-08-30 07:44:27 -06:00
Richard van der Hoff 55c4307f12 Rewrite the section on signing events 
... for clarity and de-duplication. And to say a bit about validating the
signatures.
 2018-08-30 14:37:24 +01: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 a5c3924492 Merge remote matrix-org/master 2018-08-29 21:28:24 -06:00
Travis Ralston f030d19f3c Clean up identity service swagger 
* Add `consumes` (swagger)
* Remove `http` as a supported scheme (the spec specifically says clients MUST use https)
* Clarify various descriptions
  * Full stops
  * Additional wording
  * s/older versions/previous drafts - we haven't had a release yet
* Indentation on examples
 2018-08-29 21:02:13 -06:00
Travis Ralston 684d80c422 Revert changes to 3pid lookup types in the IS spec 
The validator doesn't know what a "3PID Medium" is, for example, so it throws exceptions. This does reduce clarity in the spec though.
 2018-08-29 17:52:02 -06:00
Travis Ralston abb91508be
Merge pull request #1556 from turt2live/travis/is/cleanup 
Identity Service API cleanup
 2018-08-29 15:16:53 -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
Travis Ralston f2d02c9559 Take out device management section for now 
This will be handled by the implementation of https://github.com/matrix-org/matrix-doc/issues/1212
 2018-08-29 14:37:30 -06:00
Travis Ralston 5ff244f06b More clarification about how /state_ids works 2018-08-29 09:00:46 -06:00
Travis Ralston de36d97839 Clarify which event is actually be excluded from /state_ids 2018-08-29 08:53:20 -06:00
Hubert Chathi 5019fb7c49
Merge pull request #1359 from uhoreg/well-known 
.well-known discovery
 2018-08-29 10:40:54 -04:00
Erik Johnston 7327656965
Merge pull request #1581 from matrix-org/erikj/limit_txn_size 
Specify a limit on the number of EDUs and PDUs a transaction can contain
 2018-08-29 09:48:57 +01: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 dad037170a Clarify that the requested event is excluded from /state and /state_ids 
Fixes https://github.com/matrix-org/matrix-doc/issues/1564
 2018-08-28 15:45:50 -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
Erik Johnston fc1fdc95af Specify a limit on the number of EDUs and PDUs a transaction can contain 2018-08-28 17:29:58 +01: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 f01cfa2c7b Add security definitions to hs->as endpoints 2018-08-27 18:04:14 -06:00
Travis Ralston 17e0ef4b91 Remove empty file and now-empty section from the appservice spec 
This commit has approval under https://github.com/matrix-org/matrix-doc/pull/1555 although is being included in this branch/PR so the build passes, permitting a merge.
 2018-08-27 17:58:47 -06:00
Travis Ralston 51193cac39 Merge remote-tracking branch 'matrix-org/master' into travis/as/normal-events 2018-08-27 17:53:32 -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 8069981252 Add federation /user/* endpoints 
Fixes https://github.com/matrix-org/matrix-doc/issues/1438
 2018-08-27 14:19:10 -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 dafea96621 Fix indentation and schema references in the identity service spec 2018-08-24 15:53:27 -06:00
Travis Ralston 4abd618147 Flag response fields in the Identity Service spec as required 2018-08-24 15:53:00 -06: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 2d43ff1234 Update third party network schemas 
Some information was missed when this was reviewed. This commit adds some additional documentation for how these objects interact with each other.
 2018-08-24 10:48:47 -06:00
Travis Ralston 9eda1a6971 Move the third party network API to it's own section 2018-08-24 10:22:19 -06:00
Travis Ralston 6a91ea9c85 Specify that application services receive events in the CSAPI format 
Fixes https://github.com/matrix-org/matrix-doc/issues/1269

This is also supposed to fix the 'age' problem, however that is a larger problem with the event schemas that is reserved for a future PR/commit.
Reference: https://github.com/matrix-org/matrix-doc/issues/1294
Reference: https://github.com/matrix-org/matrix-doc/issues/1524
 2018-08-23 13:31:33 -06:00
Travis Ralston bbd33c1461 Move appservice transaction API to the right section 
Part of https://github.com/matrix-org/matrix-doc/issues/1532
 2018-08-23 13:29:04 -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
Travis Ralston 3869f68a5c Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions 2018-08-21 12:22:35 -06:00
Travis Ralston 6172d5986a
Merge pull request #1537 from turt2live/travis/as/user-alias-query 
Clean up user and alias querying for application services
 2018-08-21 12:14:07 -06:00
Travis Ralston e4f5c3d55e
Merge pull request #1518 from turt2live/travis/c2s/create-room-improvements 
Add general clarity to the /createRoom endpoint
 2018-08-21 12:04:56 -06:00
Travis Ralston 1d7ea314d4
Merge pull request #1482 from turt2live/travis/s2s/presence 
Document how presence EDUs work between servers
 2018-08-21 11:26:32 -06:00
Travis Ralston e500e2502a Document the maximum value for depth 
Implements the proposal for https://github.com/matrix-org/matrix-doc/issues/1230
 2018-08-21 09:38:01 -06:00
Travis Ralston 7e5160c7c2 Merge remote-tracking branch 'matrix-org/master' into travis/as/user-alias-query 2018-08-20 12:37:05 -06:00
Travis Ralston a320c58e42 A path parameter is obviously URL encoded 2018-08-20 12:36:26 -06:00
Travis Ralston 7ad22b2454
Merge pull request #1533 from turt2live/travis/as/general 
General/small improvements to the application service API specification
 2018-08-20 12:28:38 -06:00
Travis Ralston 8dc6f092ef Define the type of the power_level_content_override field 2018-08-20 12:27:29 -06:00
Travis Ralston 7e6ca5fef8 Take out the room_alias response field 
The argument is that this isn't really needed at this time.
 2018-08-20 12:23:17 -06:00
Travis Ralston 1fd7c99461 Clarify that the creation event can have other keys in it 2018-08-20 12:21:55 -06:00
Travis Ralston 6c7a93d2f5 Move description about which preset to use when none is specified 2018-08-20 12:21:43 -06:00
Travis Ralston 7d14309b63 Move the power level event schema to where it was 2018-08-20 12:21:19 -06:00
Travis Ralston c8ba2e098c Wording improvements for appservices 2018-08-20 12:09:17 -06:00
Travis Ralston 8b65da1cf6 Don't try and be fancy about titles 2018-08-20 11:07:10 -06:00
Travis Ralston e712466dca Improve description for currently_active 2018-08-20 10:44:28 -06:00