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

262 commits

Author SHA1 Message Date
Travis Ralston e5a7dd1c45 Remove excess commas from JSON 2018-08-25 23:00:26 -06:00
Travis Ralston aa294fac06 Define the supported HTML subset for message events 
Also clarify that `m.notice` messages can support HTML.

Fixes https://github.com/matrix-org/matrix-doc/issues/1559
Fixes https://github.com/matrix-org/matrix-doc/issues/1560
 2018-08-25 22:57:52 -06:00
Travis Ralston 295b1322e2 Add back the unsigned.age property to voip event examples 2018-08-25 22:26:23 -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 0f28f83270 Fix client-server event schemas: remove age, dedupe fields 
This commit adds support for event schema examples to have references to help reduce the chance of fields being forgotten. This also helps reduce duplication of fields, allowing for a more consistent spec that uses the same values everywhere.

This also removes both `unsigned` and `age` from the examples as per:
* https://github.com/matrix-org/matrix-doc/issues/1524
* https://github.com/matrix-org/matrix-doc/issues/630

Finally, this replaces "localhost" in the examples with an example domain. This is really just a nitpick thing on my part where seeing a "real world" domain is preferred. 

Fixes https://github.com/matrix-org/matrix-doc/issues/1524
Fixes https://github.com/matrix-org/matrix-doc/issues/630
Step towards https://github.com/matrix-org/matrix-doc/issues/1530
 2018-08-24 18:04:51 -06: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 8732378da2 add required room ids 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 af74790681 Merge remote-tracking branch 'matrix-org/master' into travis/m.ignored_user_list 2018-03-06 10:18:24 -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 eb8c3255bf Remove extraneous comma from m.presence schema 
This causes the build to fail. Fixes #1146

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-05 18:45:57 -07:00
Travis Ralston d37ed0876f
Merge branch 'master' into travis/m.ignored_user_list 2018-03-05 14:52:37 -07:00
Richard van der Hoff a0dda3cae2
Merge branch 'master' into travis/m.tag 2018-03-05 18:58:53 +00: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 a3f006353c Tag ordering is defined as a number between 0 and 1, not strings 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-03 12:40:48 -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
Brendan Abolivier 0b74492d67 Fix membership on third-party invite upgrade (#995) 2017-09-26 14:57:51 +01:00
krombel f8ce497bd6 Fix inconsistency: join_rules => join_rule 
All other docs do not have `join_rules` but `join_rule`
This PR fix this inconsistency.

Mentioned by @digital:sorunome.de in [#matrix-dev:matrix.org](https://matrix.to/#/!XqBunHwQIXUiqCaoxq:matrix.org/$150142347531959wjGGm:sorunome.de)
 2017-07-31 12:04:24 +02:00
Brendan Abolivier 750d980bc0 Room member (#950) 
* Fixed an incorrect membership on example
* Added precision on membership upon profile update
* Changed first example into a join
* Changed the state/{eventType}/{stateKey} example with an actual state key
 2017-07-14 15:30:56 +01:00
Michael Telatynski 852f4edead redacts is an eventID not a roomID (! -> $) 2017-07-05 16:18:49 +01: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 05001bcaa6 Fix whitepace 2016-11-07 14:32:48 +00:00
Mark Haines 29e33deeb5 Fix m.location example 2016-11-07 14:31:29 +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 49cd65dd58 Add a license to the spec 
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
 2016-07-12 17:28:30 +01: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
Richard van der Hoff e594132e95 m.room.member: yaml tweak 
Quote "string" for consistency with "null"
 2016-06-22 17:32:01 +01:00
Richard van der Hoff 5b12e2cfef Convert event schemas to yaml 
We've decided to make the event schemas YAML, so we might as well take
advantage of it.

(This conversion was done mostly automatically, except for:
 - s/null/"null"/ in m.room.member
 - reformat description in m.room.power_levels
 2016-06-22 12:01:08 +01:00
Richard van der Hoff 2eebacacfe Merge pull request #286 from matrix-org/dbkr/default_state_defaults 
Update spec to say what the default state / events defaults are
 2016-05-13 11:30:34 +02:00
Richard van der Hoff 33ec8dde88 m.room.power_levels: More newlines 2016-05-13 10:28:26 +01:00
Richard van der Hoff 8c3838bc04 Formatting tweaks for m.room.power_levels 2016-05-13 10:26:27 +01:00
Richard van der Hoff df0e070146 Merge pull request #321 from matrix-org/rav/fix_eventschema_readme 
Update eventschema readme
 2016-05-05 11:41:38 +01:00
Richard van der Hoff 2e9212af8a Fix typo in m.room.member schema 
remove spurious SHOULD
 2016-05-05 11:07:37 +01:00
Richard van der Hoff 4bc78633a5 We don't support z-schema or other JSON tools for now 2016-05-05 10:50:03 +01:00
Gergely Polonkai d94deb6296 Add event as a parent for all event types 
Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>
 2016-03-16 16:46:16 +01:00
Kegsay dd6dfa7635 Merge pull request #291 from gergelypolonkai/room-avatar-image-info 
Update m.room.avatar schema so it references image_info in info
 2016-03-14 15:31:57 +00:00
Daniel Wagner-Hall 77f495d36f Remove restrictions on StrippedState 
Note also that these are purely informational and not things on which to
rely.

SPEC-357
 2016-03-10 14:27:54 +00:00
Gergely Polonkai 6e2b02a608 Update m.room.avatar schema so it references image_info in info 
Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>
 2016-03-08 16:32:19 +01:00
Gergely Polonkai 583c8cbfaf Add invite key to m.room.power_levels schema 
Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>
 2016-03-08 15:50:27 +01:00
Gergely Polonkai 449bb09998 Fix for m.room.third_party_invite schema 2016-03-04 16:58:02 +01:00
David Baker 65e5a316bd Update spec to say what the default state / events defaults are, from inspecting the behaviour of synapse (which I'm not sure was intentional). 2016-03-02 18:31:14 +00:00
Daniel Wagner-Hall 11c572267e Add titles where they're missing 2016-03-02 15:23:48 +00:00
Daniel Wagner-Hall ea170e5dca m.third_party_invite: Allow multiple public keys 2016-02-12 13:15:21 +00:00
Daniel Wagner-Hall c959ca689c Explain what the room member states mean 2015-12-21 14:51:49 +00:00
Daniel Wagner-Hall 9bfe86f474 Add display_name to 3pid invites in m.room.member 2015-12-17 19:01:20 +01:00
Daniel Wagner-Hall f81b967e2d Make all the schema files yaml 2015-12-07 13:56:36 +00:00
Daniel Wagner-Hall 63ca91f353 Move event signing to server-server spec 
It's *definitely* not a client concern.

It isn't really in the right place at the moment, but s-s is very much a
work in progress whereas c-s is nearly stable.
 2015-12-04 10:55:18 +00:00
Daniel Wagner-Hall aa4ed10821 Unify v1 and v2 event schemas 2015-12-01 17:23:58 +00:00
Daniel Wagner-Hall 79244e8065 Remove redundant node event schema checker 
The python one does the same
 2015-11-30 16:40:48 +00:00
Daniel Wagner-Hall 6c66bfc755 Flatten out v1 and v2_alpha directories 
As a side effect, I got rid of all of the horrible symlinks and just put
in all of the proper relative paths. Because the horrible symlinks were
horrible.
 2015-11-30 11:22:57 +00:00
Paul Evans eb61f018c2 Merge pull request #144 from matrix-org/paul/small-fixes 
Don't mark 'aliases' on m.room.canonical_alias as required
 2015-11-27 15:42:36 +00:00