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
6 years ago
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
6 years ago
e9e93b0eec
Move `invite_room_state` to the correct place in the client-server API
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1350
6 years ago
be9f6042e5
Fix encrypted event examples
6 years ago
e5a7dd1c45
Remove excess commas from JSON
6 years ago
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
6 years ago
295b1322e2
Add back the unsigned.age property to voip event examples
6 years ago
b7577ea237
document encrypted attachments
...
Fix #461 .
6 years ago
579f5ea928
fixup! document key sharing and m.room_key_request
6 years ago
8ae137e82e
fixup! document m.forwarded_room_key
6 years ago
768f33dc2d
fixup! document key sharing and m.room_key_request
6 years ago
337316445f
fixup! document m.forwarded_room_key
6 years ago
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
6 years ago
ef41b5c2bf
Server ACLs
...
Implements the proposal for https://github.com/matrix-org/matrix-doc/issues/1383
6 years ago
019c290fa2
document m.forwarded_room_key
6 years ago
2d8a321b46
document key sharing and m.room_key_request
6 years ago
3869f68a5c
Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions
6 years ago
f853856f21
add missing m.room.encrypted event properties
6 years ago
6c44233c42
require megolm algorithm in m.room.encryption
6 years ago
661176cb3a
Olm m.room.encrypted example
6 years ago
8732378da2
add required room ids
6 years ago
c60109d235
complete m.room_key documentation
6 years ago
3a8d13df60
add missing m.room.encryption properties
6 years ago
e5005b2d0f
document E2E events
...
This was written by Richard van der Hoff.
6 years ago
57571ea4ce
Merge branch 'master' of github.com:matrix-org/matrix-doc into notifications/room
6 years ago
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
6 years ago
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
6 years ago
992bc8828a
Merge branches 'master' and 'notifications/room' of github.com:matrix-org/matrix-doc into notifications/room
7 years ago
c305317fa5
explicitly specify @room
7 years ago
60ae73b179
specify default
7 years ago
1e656d836e
spec notifications key on power level event and provide @room in example
7 years ago
8d05f80cec
Sticker messages (m.sticker) ( #1158 )
7 years ago
6e7d264bc7
Add clarity to the m.ignored_user_list
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
0835612277
Represent the ignored users event correctly
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
af74790681
Merge remote-tracking branch 'matrix-org/master' into travis/m.ignored_user_list
7 years ago
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>
7 years ago
eb8c3255bf
Remove extraneous comma from m.presence schema
...
This causes the build to fail. Fixes #1146
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
d37ed0876f
Merge branch 'master' into travis/m.ignored_user_list
7 years ago
a0dda3cae2
Merge branch 'master' into travis/m.tag
7 years ago
e862ef60ae
Spec ignoring users
...
Adds https://github.com/matrix-org/matrix-doc/issues/528
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
a3f006353c
Tag ordering is defined as a number between 0 and 1, not strings
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
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>
7 years ago
57e5e1e331
Document default room creator PL ( #1081 )
7 years ago
e5e249dce1
Remove redundant 'Required' annotations from event fields
7 years ago
23e2f8986c
Merge pull request #1026 from matrix-org/rav/power_levels_doc
...
Clarify what happens when there is no power_levels event
7 years ago
b4e24d443a
Clarify what happens when there is no power_levels event
7 years ago
a1265a274b
Add spec for m.room.pinned_events
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
0b74492d67
Fix membership on third-party invite upgrade ( #995 )
7 years ago
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 )
7 years ago
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
7 years ago
852f4edead
redacts is an eventID not a roomID (! -> $)
8 years ago
c1b375b2ac
Clarify that age is generated on the local HS
...
Signed-off-by: Johannes Löthberg <johannes@kyriasis.com>
8 years ago
d9894aeffd
Make m.notice description use stricter language
...
Signed-off-by: Johannes Löthberg <johannes@kyriasis.com>
8 years ago
6f1c598db8
Make the key orders consistent
8 years ago
05001bcaa6
Fix whitepace
8 years ago
29e33deeb5
Fix m.location example
8 years ago
30f9ea0225
Spelling
8 years ago
5ccf41bafc
Add type: object
8 years ago
6ecb5d0729
re-order thumbnail keys
8 years ago
4349982189
Fix path
8 years ago
2fdca5a995
Add a thumbnail_info common schema, deduplicate m.room.avatar and m.room.message#m.image
8 years ago
1b661b64dc
Move m.location thumbnail_url to be inside info to match m.video
8 years ago
14d05464ee
Move m.file thumbnail_url to be inside info to match m.video
8 years ago
25b41c7551
Move m.image thumbnail_url to be inside info to match m.video
8 years ago
dfbe416490
Better types for additionalProps
...
recurse down the definitions for additionalProps, so that the types are better
8 years ago
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.
8 years ago
b789251f70
More PR feedback
8 years ago
8af90bfc21
Clarify 'this room'
8 years ago
85bc989c02
pr feedback
8 years ago
8fe8bd6a81
Add is_direct to member event spec.
8 years ago
cade909e25
Fix inconsistencies regarding redacted_because
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
1c02ff5249
Specify requirement of origin_server_ts
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
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).
8 years ago
d724b6bf75
Make null m.room.name behaviour explicit
...
PR feedback
8 years ago
be9dccb266
m.room.canonical alias: fix schema syntax
8 years ago
d4194dd24e
Clarify the room-naming behaviour
...
Make behaviour on empty `m.room.name` and `m.room.canonical_alias` events
explicit.
8 years ago
4f37e4ece0
Merge pull request #342 from matrix-org/erikj/presence
...
Fix and correctly document presence's currently_active
9 years ago
c83940750c
Update m.presence
9 years ago
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
9 years ago
e594132e95
m.room.member: yaml tweak
...
Quote "string" for consistency with "null"
9 years ago
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
9 years ago
2eebacacfe
Merge pull request #286 from matrix-org/dbkr/default_state_defaults
...
Update spec to say what the default state / events defaults are
9 years ago
33ec8dde88
m.room.power_levels: More newlines
9 years ago
8c3838bc04
Formatting tweaks for m.room.power_levels
9 years ago
df0e070146
Merge pull request #321 from matrix-org/rav/fix_eventschema_readme
...
Update eventschema readme
9 years ago
2e9212af8a
Fix typo in m.room.member schema
...
remove spurious SHOULD
9 years ago
4bc78633a5
We don't support z-schema or other JSON tools for now
9 years ago
d94deb6296
Add event as a parent for all event types
...
Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>
9 years ago
dd6dfa7635
Merge pull request #291 from gergelypolonkai/room-avatar-image-info
...
Update m.room.avatar schema so it references image_info in info
9 years ago
77f495d36f
Remove restrictions on StrippedState
...
Note also that these are purely informational and not things on which to
rely.
SPEC-357
9 years ago
6e2b02a608
Update m.room.avatar schema so it references image_info in info
...
Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>
9 years ago
583c8cbfaf
Add invite key to m.room.power_levels schema
...
Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>
9 years ago
449bb09998
Fix for m.room.third_party_invite schema
9 years ago
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).
9 years ago
11c572267e
Add titles where they're missing
9 years ago
ea170e5dca
m.third_party_invite: Allow multiple public keys
9 years ago
c959ca689c
Explain what the room member states mean
9 years ago
9bfe86f474
Add display_name to 3pid invites in m.room.member
9 years ago
f81b967e2d
Make all the schema files yaml
9 years ago
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.
9 years ago
Travis Ralston