Commit graph

146 commits

Author SHA1 Message Date
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
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
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
2e9212af8a Fix typo in m.room.member schema
remove spurious SHOULD
2016-05-05 11:07:37 +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