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

258 commits

Author SHA1 Message Date
Travis Ralston 2cf00fc5ca
Merge pull request #2031 from matrix-org/travis/1.0/voip-hangup 
Add missing reason property to m.call.hangup
 2019-05-28 12:11:54 -06:00
Travis Ralston 229893589a Move wording for reason definitions 2019-05-27 21:18:04 -06:00
Travis Ralston 00f97636a2 Add missing reason property to m.call.hangup 
Fixes https://github.com/matrix-org/matrix-doc/issues/1689
 2019-05-26 22:08:04 -06:00
Travis Ralston 5eea4a477f Add server notices support 
As per [MSC1452](https://github.com/matrix-org/matrix-doc/issues/1452) 

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

Although MSC1452 focuses on just the warnings part of the server notices, the base for notices has not been established in the spec. This commit adds the needed support to be able to handle notices.

No intentional divergences from the proposal are included in this changeset. There are a few additions which are used in practice although not defined in the proposal, such as who is responsible for aesthetics, sending notices, and other misc rules.
 2019-05-26 20:52:59 -06:00
Jonas Platte 043dddc490
Fix a typo in m.call.invite 2019-04-20 21:56:43 +02:00
Anatoly Sablin 4bec3d6dd8 Avoid duplicates. 2019-02-24 19:43:03 +03:00
Anatoly Sablin d4b4d92b82 Fix the m.push_rules type (switch from the state event to the common event). 2019-02-16 00:24:26 +03:00
Anatoly Sablin 2de7ef9a3d #1865 Add the m.push_rules schema. 2019-02-15 23:23:38 +03: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 1268b421ec
Update the m.presence schema to include status_msg 2018-12-10 15:44:01 -07:00
Travis Ralston e4a8fed0e8 Power levels always have a default of 50 for state_default 
As per the proposal https://github.com/matrix-org/matrix-doc/issues/1304
 2018-09-04 11:43:37 -06:00
Travis Ralston 108c623557
Merge pull request #1635 from turt2live/travis/c2s/read-markers 
Add read markers
 2018-08-31 14:47:39 -06:00
Hubert Chathi c0dd7e0025
Merge pull request #1420 from Zil0/encrypted_attach 
Document encrypted attachments
 2018-08-31 13:33:05 -04:00
Hubert Chathi f1f32d3a15 add more clarifications 2018-08-31 12:59:57 -04:00
Travis Ralston 679ddabb53 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/read-markers 2018-08-31 10:34:19 -06:00
Hubert Chathi e3daf10bb9 refactor encrypted file schema as "Extension to m.message" 2018-08-31 12:11:27 -04:00
Travis Ralston fc037b3a72 Fix merge 2018-08-31 09:33:30 -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 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
Hubert Chathi 4230e375fa
Merge pull request #1465 from Zil0/key_sharing 
Document key sharing events
 2018-08-29 23:05:17 -04: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 c83da453b5 s/number/integer 2018-08-29 14:18:41 -06:00
Travis Ralston 26d5a24b88 Merge remote matrix-org/master 2018-08-29 14:17:21 -06:00
Travis Ralston c297c6a35d Update schemas and auth rules to cover the @ state key restriction 
Fixes https://github.com/matrix-org/matrix-doc/issues/1305

Also fixes an issue regarding the `_` being restricted previously, which is false.
 2018-08-28 13:06:52 -06:00
Travis Ralston ee3b0f42db Fix server ACL schema: The type is a string 
It cannot be an enum otherwise the build starts screaming.
 2018-08-28 10:34:49 -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
Valentin Deniaud 28ced3b0a4 fixup! document encrypted attachments 2018-08-28 15:04:40 +02:00
Travis Ralston efef3412a0 Take out the underscore restriction from state events 
It's not needed anymore, and we should remove it while we're in the area.

Includes other misc changes to the schema layout.
 2018-08-27 19:07:32 -06:00
Travis Ralston 439b9d2925 Power levels are also integers 2018-08-27 18:59:35 -06:00
Travis Ralston ee2ebe6792
Merge pull request #1568 from turt2live/travis/c2s/invite-room-state 
Move `invite_room_state` to the correct place in the client-server API
 2018-08-27 18:47:24 -06:00
Travis Ralston 4e885c3f77
Merge pull request #1550 from turt2live/travis/general/acls 
Server ACLs
 2018-08-27 17:48:43 -06:00
Matthew Hodgson 313e6de48b
tweak wording to spell out that handling legacy/noncompliant servers. 2018-08-27 23:36:48 +01:00
Travis Ralston 76afef79f8 Clarify the rationale and motive for blanket IP banning and port exclusion 2018-08-27 16:14:37 -06:00
Travis Ralston 82be6077ff Add a note that ACLs don't operate at the auth level; Fix glob definition 2018-08-27 16:13:42 -06:00
Travis Ralston be2e0fc9d4 Clarify that ACLs are required to manually deny unsupported hosts 2018-08-27 16:12:42 -06:00
Travis Ralston 72de8bec5c Remove unused algorithms for encrypted messages 2018-08-27 15:05:56 -06:00
Travis Ralston 438f5825ae Add more supported encryption algorithms to message events 2018-08-27 14:55:59 -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 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 e9e93b0eec Move invite_room_state to the correct place in the client-server API 
Fixes https://github.com/matrix-org/matrix-doc/issues/1350
 2018-08-26 20:51:39 -06:00
Valentin Deniaud b7577ea237 document encrypted attachments 
Fix #461.
 2018-08-25 17:31:49 +02:00
Valentin Deniaud 579f5ea928 fixup! document key sharing and m.room_key_request 2018-08-25 17:26:40 +02:00
Valentin Deniaud 8ae137e82e fixup! document m.forwarded_room_key 2018-08-25 17:26:00 +02:00
Valentin Deniaud 768f33dc2d fixup! document key sharing and m.room_key_request 2018-08-25 16:55:28 +02:00
Valentin Deniaud 337316445f fixup! document m.forwarded_room_key 2018-08-25 16:55:00 +02:00
Travis Ralston ef41b5c2bf Server ACLs 
Implements the proposal for https://github.com/matrix-org/matrix-doc/issues/1383
 2018-08-22 12:48:37 -06:00
Valentin Deniaud 019c290fa2 document m.forwarded_room_key 2018-08-21 21:35:03 +02:00
Valentin Deniaud 2d8a321b46 document key sharing and m.room_key_request 2018-08-21 21:35:03 +02:00
Travis Ralston 3869f68a5c Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions 2018-08-21 12:22:35 -06:00
Valentin Deniaud f853856f21 add missing m.room.encrypted event properties 2018-08-18 11:41:45 +02:00
Valentin Deniaud 6c44233c42 require megolm algorithm in m.room.encryption 2018-08-18 11:41:45 +02:00
Valentin Deniaud 661176cb3a Olm m.room.encrypted example 2018-08-18 11:41:45 +02:00
Valentin Deniaud c60109d235 complete m.room_key documentation 2018-08-18 11:41:45 +02:00
Valentin Deniaud 3a8d13df60 add missing m.room.encryption properties 2018-08-18 11:41:45 +02:00
Valentin Deniaud e5005b2d0f document E2E events 
This was written by Richard van der Hoff.
 2018-08-18 11:41:45 +02:00
Michael Telatynski 57571ea4ce
Merge branch 'master' of github.com:matrix-org/matrix-doc into notifications/room 2018-08-16 23:09:59 +01:00
Travis Ralston fde48e7ee8 Specify how room versioning works 
This is the spec PR for https://github.com/matrix-org/matrix-doc/issues/1425

Room version upgrades are not part of MSC1425.

Documented aspects:
* room_version on the create event
* creating a room with a specific version (useful for testing)
* make_join behaviour
* error code documentation
* grammar of room versions

Based upon https://docs.google.com/document/d/1urKgReoHqxX8R_XtySB17dPi-DZcKhqTEL2_s895Wz0/edit
 2018-08-15 15:12:36 -06:00
Travis Ralston 55e4e90ab1 Document message formats as-is 
This is likely to later be replaced by mixins, however this is being documented now so clients aren't left in the dark.

Fixes https://github.com/matrix-org/matrix-doc/issues/917
 2018-07-10 12:52:11 -06:00
Michael Telatynski 992bc8828a
Merge branches 'master' and 'notifications/room' of github.com:matrix-org/matrix-doc into notifications/room 2018-05-12 09:24:53 +01:00
Michael Telatynski c305317fa5
explicitly specify @room 2018-04-15 22:41:24 +01:00
Michael Telatynski 60ae73b179
specify default 2018-04-15 22:37:23 +01:00
Michael Telatynski 1e656d836e
spec notifications key on power level event and provide @room in example 2018-04-15 22:35:44 +01:00
Richard Lewis 8d05f80cec Sticker messages (m.sticker) (#1158) 2018-03-27 10:00:41 +01:00
Travis Ralston 6e7d264bc7 Add clarity to the m.ignored_user_list 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-06 10:32:18 -07:00
Travis Ralston 0835612277 Represent the ignored users event correctly 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-06 10:21:38 -07:00
Travis Ralston 331e49bd0d Improve the documentation of ignored users 
* Fix the event schema to represent the real world
* Add the module to the spec targets
* Remove incomplete thought from the client behaviour
* Link to the account data API
* Minor word choice changes

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-06 09:00:32 -07:00
Travis Ralston d37ed0876f
Merge branch 'master' into travis/m.ignored_user_list 2018-03-05 14:52:37 -07:00
Travis Ralston e862ef60ae Spec ignoring users 
Adds https://github.com/matrix-org/matrix-doc/issues/528

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-03 15:39:10 -07:00
Travis Ralston a488bd5503 Make m.presence match what synapse returns 
Considering this is the behaviour that is embedded into most client libraries and the most popular homeserver, it should be adopted as the standard.

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-03 12:12:47 -07:00
Max Dor 57e5e1e331 Document default room creator PL (#1081) 2017-11-20 16:22:30 +00:00
Richard van der Hoff e5e249dce1 Remove redundant 'Required' annotations from event fields 2017-11-03 17:17:59 +00:00
Richard van der Hoff 23e2f8986c Merge pull request #1026 from matrix-org/rav/power_levels_doc 
Clarify what happens when there is no power_levels event
 2017-10-17 20:54:18 +01:00
Richard van der Hoff b4e24d443a Clarify what happens when there is no power_levels event 2017-10-17 16:34:50 +01:00
Travis Ralston a1265a274b Add spec for m.room.pinned_events 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2017-09-29 11:59:27 -06:00
Johannes Löthberg c1b375b2ac Clarify that age is generated on the local HS 
Signed-off-by: Johannes Löthberg <johannes@kyriasis.com>
 2016-11-30 23:12:47 +01:00
Johannes Löthberg d9894aeffd Make m.notice description use stricter language 
Signed-off-by: Johannes Löthberg <johannes@kyriasis.com>
 2016-11-30 00:59:51 +01:00
Mark Haines 6f1c598db8 Make the key orders consistent 2016-11-07 14:54:59 +00:00
Mark Haines 30f9ea0225 Spelling 2016-11-07 14:30:16 +00:00
Mark Haines 5ccf41bafc Add type: object 2016-11-07 14:29:17 +00:00
Mark Haines 6ecb5d0729 re-order thumbnail keys 2016-11-07 14:28:19 +00:00
Mark Haines 4349982189 Fix path 2016-11-07 10:54:02 +00:00
Mark Haines 2fdca5a995 Add a thumbnail_info common schema, deduplicate m.room.avatar and m.room.message#m.image 2016-11-07 10:50:52 +00:00
Mark Haines 1b661b64dc Move m.location thumbnail_url to be inside info to match m.video 2016-11-04 14:59:39 +00:00
Mark Haines 14d05464ee Move m.file thumbnail_url to be inside info to match m.video 2016-11-04 14:57:45 +00:00
Mark Haines 25b41c7551 Move m.image thumbnail_url to be inside info to match m.video 2016-11-04 14:52:01 +00:00
Richard van der Hoff dfbe416490 Better types for additionalProps 
recurse down the definitions for additionalProps, so that the types are better
 2016-10-14 15:57:52 +01:00
David Baker 4480553bf9 Move m.direct description to the swagger 
Also change the swagger to yaml so I can put that description in it
without having to figure out how to embed that in json.
 2016-10-05 13:12:14 +01:00
David Baker b789251f70 More PR feedback 2016-10-05 12:59:49 +01:00
David Baker 8af90bfc21 Clarify 'this room' 2016-10-04 15:08:48 +01:00
David Baker 85bc989c02 pr feedback 2016-10-04 15:07:14 +01:00
David Baker 8fe8bd6a81 Add is_direct to member event spec. 2016-10-03 17:33:45 +01:00
Benjamin Saunders cade909e25 Fix inconsistencies regarding redacted_because 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-08-30 21:18:55 -07:00
Benjamin Saunders 1c02ff5249 Specify requirement of origin_server_ts 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-08-12 01:49:14 -07:00
Richard van der Hoff d724b6bf75 Make null m.room.name behaviour explicit 
PR feedback
 2016-07-12 13:44:04 +01:00
Richard van der Hoff be9dccb266 m.room.canonical alias: fix schema syntax 2016-07-12 10:04:01 +01:00
Richard van der Hoff d4194dd24e Clarify the room-naming behaviour 
Make behaviour on empty `m.room.name` and `m.room.canonical_alias` events
explicit.
 2016-07-11 17:49:27 +01:00
Richard van der Hoff 4f37e4ece0 Merge pull request #342 from matrix-org/erikj/presence 
Fix and correctly document presence's currently_active
 2016-06-29 11:36:55 +01:00
Erik Johnston c83940750c Update m.presence 2016-06-29 10:42:33 +01:00
Richard van der Hoff adb5768731 m.room.power_levels: clarify documentation 
- clarify description and add text for invite, ban, etc.
- the keys aren't required. Document their defaults
- add 'invite' to example
 2016-06-22 17:45:49 +01:00