4230e375fa
Merge pull request #1465 from Zil0/key_sharing
...
Document key sharing events
2018-08-29 23:05:17 -04:00
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
c83da453b5
s/number/integer
2018-08-29 14:18:41 -06:00
26d5a24b88
Merge remote matrix-org/master
2018-08-29 14:17:21 -06:00
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
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
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
28ced3b0a4
fixup! document encrypted attachments
2018-08-28 15:04:40 +02:00
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
439b9d2925
Power levels are also integers
2018-08-27 18:59:35 -06:00
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
4e885c3f77
Merge pull request #1550 from turt2live/travis/general/acls
...
Server ACLs
2018-08-27 17:48:43 -06:00
313e6de48b
tweak wording to spell out that handling legacy/noncompliant servers.
2018-08-27 23:36:48 +01:00
76afef79f8
Clarify the rationale and motive for blanket IP banning and port exclusion
2018-08-27 16:14:37 -06:00
82be6077ff
Add a note that ACLs don't operate at the auth level; Fix glob definition
2018-08-27 16:13:42 -06:00
be2e0fc9d4
Clarify that ACLs are required to manually deny unsupported hosts
2018-08-27 16:12:42 -06:00
72de8bec5c
Remove unused algorithms for encrypted messages
2018-08-27 15:05:56 -06:00
438f5825ae
Add more supported encryption algorithms to message events
2018-08-27 14:55:59 -06:00
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
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
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
b7577ea237
document encrypted attachments
...
Fix #461 .
2018-08-25 17:31:49 +02:00
579f5ea928
fixup! document key sharing and m.room_key_request
2018-08-25 17:26:40 +02:00
8ae137e82e
fixup! document m.forwarded_room_key
2018-08-25 17:26:00 +02:00
768f33dc2d
fixup! document key sharing and m.room_key_request
2018-08-25 16:55:28 +02:00
337316445f
fixup! document m.forwarded_room_key
2018-08-25 16:55:00 +02:00
ef41b5c2bf
Server ACLs
...
Implements the proposal for https://github.com/matrix-org/matrix-doc/issues/1383
2018-08-22 12:48:37 -06:00
019c290fa2
document m.forwarded_room_key
2018-08-21 21:35:03 +02:00
2d8a321b46
document key sharing and m.room_key_request
2018-08-21 21:35:03 +02:00
3869f68a5c
Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions
2018-08-21 12:22:35 -06:00
f853856f21
add missing m.room.encrypted event properties
2018-08-18 11:41:45 +02:00
6c44233c42
require megolm algorithm in m.room.encryption
2018-08-18 11:41:45 +02:00
661176cb3a
Olm m.room.encrypted example
2018-08-18 11:41:45 +02:00
c60109d235
complete m.room_key documentation
2018-08-18 11:41:45 +02:00
3a8d13df60
add missing m.room.encryption properties
2018-08-18 11:41:45 +02:00
e5005b2d0f
document E2E events
...
This was written by Richard van der Hoff.
2018-08-18 11:41:45 +02:00
57571ea4ce
Merge branch 'master' of github.com:matrix-org/matrix-doc into notifications/room
2018-08-16 23:09:59 +01:00
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
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
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
c305317fa5
explicitly specify @room
2018-04-15 22:41:24 +01:00
60ae73b179
specify default
2018-04-15 22:37:23 +01:00
1e656d836e
spec notifications key on power level event and provide @room in example
2018-04-15 22:35:44 +01:00
8d05f80cec
Sticker messages (m.sticker) ( #1158 )
2018-03-27 10:00:41 +01:00
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
0835612277
Represent the ignored users event correctly
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-06 10:21:38 -07:00
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
d37ed0876f
Merge branch 'master' into travis/m.ignored_user_list
2018-03-05 14:52:37 -07:00
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
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
57e5e1e331
Document default room creator PL ( #1081 )
2017-11-20 16:22:30 +00:00
e5e249dce1
Remove redundant 'Required' annotations from event fields
2017-11-03 17:17:59 +00:00
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
b4e24d443a
Clarify what happens when there is no power_levels event
2017-10-17 16:34:50 +01:00
a1265a274b
Add spec for m.room.pinned_events
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
2017-09-29 11:59:27 -06:00
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
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
6f1c598db8
Make the key orders consistent
2016-11-07 14:54:59 +00:00
30f9ea0225
Spelling
2016-11-07 14:30:16 +00:00
5ccf41bafc
Add type: object
2016-11-07 14:29:17 +00:00
6ecb5d0729
re-order thumbnail keys
2016-11-07 14:28:19 +00:00
4349982189
Fix path
2016-11-07 10:54:02 +00:00
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
1b661b64dc
Move m.location thumbnail_url to be inside info to match m.video
2016-11-04 14:59:39 +00:00
14d05464ee
Move m.file thumbnail_url to be inside info to match m.video
2016-11-04 14:57:45 +00:00
25b41c7551
Move m.image thumbnail_url to be inside info to match m.video
2016-11-04 14:52:01 +00:00
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
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
b789251f70
More PR feedback
2016-10-05 12:59:49 +01:00
8af90bfc21
Clarify 'this room'
2016-10-04 15:08:48 +01:00
85bc989c02
pr feedback
2016-10-04 15:07:14 +01:00
8fe8bd6a81
Add is_direct to member event spec.
2016-10-03 17:33:45 +01:00
cade909e25
Fix inconsistencies regarding redacted_because
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
2016-08-30 21:18:55 -07:00
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
d724b6bf75
Make null m.room.name behaviour explicit
...
PR feedback
2016-07-12 13:44:04 +01:00
be9dccb266
m.room.canonical alias: fix schema syntax
2016-07-12 10:04:01 +01:00
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
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
c83940750c
Update m.presence
2016-06-29 10:42:33 +01:00
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
e594132e95
m.room.member: yaml tweak
...
Quote "string" for consistency with "null"
2016-06-22 17:32:01 +01:00
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
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
33ec8dde88
m.room.power_levels: More newlines
2016-05-13 10:28:26 +01:00
8c3838bc04
Formatting tweaks for m.room.power_levels
2016-05-13 10:26:27 +01:00
2e9212af8a
Fix typo in m.room.member schema
...
remove spurious SHOULD
2016-05-05 11:07:37 +01:00
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
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
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
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
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
449bb09998
Fix for m.room.third_party_invite schema
2016-03-04 16:58:02 +01:00
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
11c572267e
Add titles where they're missing
2016-03-02 15:23:48 +00:00
ea170e5dca
m.third_party_invite: Allow multiple public keys
2016-02-12 13:15:21 +00:00
c959ca689c
Explain what the room member states mean
2015-12-21 14:51:49 +00:00
9bfe86f474
Add display_name to 3pid invites in m.room.member
2015-12-17 19:01:20 +01:00
f81b967e2d
Make all the schema files yaml
2015-12-07 13:56:36 +00:00
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
aa4ed10821
Unify v1 and v2 event schemas
2015-12-01 17:23:58 +00:00
Hubert Chathi