e3daf10bb9
refactor encrypted file schema as "Extension to m.message"
2018-08-31 12:11:27 -04:00
fc037b3a72
Fix merge
2018-08-31 09:33:30 -06:00
2e3e189ea2
Merge remote matrix-org/master
2018-08-31 09:31:39 -06:00
afa16f1e4e
Merge pull request #1606 from turt2live/travis/c2s/room-tags
...
Update the room tagging documentation
2018-08-31 08:36:40 -06:00
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)d69decd5c7/synapse/rest/client/v2_alpha/read_marker.py (L45-L52)
2018-08-30 16:21:31 -06:00
429f302744
Add an `age` to the invite room state example
2018-08-30 13:32:53 -06:00
464f4f5f21
Correctly check for the 'core' folder
2018-08-30 12:05:56 -06:00
c8a8f13623
Don't check the underlying definitions
...
Otherwise the script will try to find a schema for our templates, which don't exist.
2018-08-30 11:57:01 -06:00
31ea4279d1
Resolve references in the check_examples script
2018-08-30 11:53:39 -06:00
6aacec3178
Fix power level JSON example
2018-08-30 11:40:08 -06:00
827033c128
Merge remote matrix-org/master
2018-08-30 11:29:47 -06:00
fd7cb22a28
Fix event type example of m.forwarded_room_key
2018-08-29 21:22:47 -06:00
4230e375fa
Merge pull request #1465 from Zil0/key_sharing
...
Document key sharing events
2018-08-29 23:05:17 -04:00
c03f2f8d79
Minor touchups to the room tagging API
...
Fixes some of https://github.com/matrix-org/matrix-doc/issues/1565
2018-08-29 14:53:55 -06: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
62b1b8b660
Have unsigned.age appear on all room events
...
This is useful for a lot of things, like bridges (appservices), VoIP handling, and clients which generally may wish to do something with the field. Might as well include it on every event, despite the recommendation of https://github.com/matrix-org/matrix-doc/issues/1524
2018-08-29 09:32:14 -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
8e42f3ab3a
Fix bad merge on brackets
2018-08-27 19:26:08 -06:00
4b05194a91
Fix bad merge
2018-08-27 19:18:14 -06:00
4278a9a516
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/fix-events
2018-08-27 19:17:37 -06:00
e4f8c23972
Merge pull request #1562 from turt2live/travis/c2s/html-formatting
...
Define the supported HTML subset for message events
2018-08-27 19:14:52 -06: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
17bdc0c740
Revert "Fix encrypted event examples"
...
This reverts commit be9f6042e5
2018-08-27 14:51:34 -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
be9f6042e5
Fix encrypted event examples
2018-08-25 23:24:02 -06:00
e5a7dd1c45
Remove excess commas from JSON
2018-08-25 23:00:26 -06:00
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
295b1322e2
Add back the unsigned.age property to voip event examples
2018-08-25 22:26:23 -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
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
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
8732378da2
add required room ids
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
af74790681
Merge remote-tracking branch 'matrix-org/master' into travis/m.ignored_user_list
2018-03-06 10:18:24 -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
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
d37ed0876f
Merge branch 'master' into travis/m.ignored_user_list
2018-03-05 14:52:37 -07:00
a0dda3cae2
Merge branch 'master' into travis/m.tag
2018-03-05 18:58:53 +00: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
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
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
0b74492d67
Fix membership on third-party invite upgrade ( #995 )
2017-09-26 14:57:51 +01:00
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
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
852f4edead
redacts is an eventID not a roomID (! -> $)
2017-07-05 16:18:49 +01: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
05001bcaa6
Fix whitepace
2016-11-07 14:32:48 +00:00
29e33deeb5
Fix m.location example
2016-11-07 14:31:29 +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
Hubert Chathi