Jimmy Cuadra
b885714d94
Remove the "required" designation from the url field of certain
...
m.room.message msgtypes.
Now that content referenced by the *m.audio*, *m.file*, *m.image*, and
*m.video* message types can be encrypted, the `url` field is required
*only* if the content is unencrypted. The "required" designation in the
event schemas (which prefixes the field description with "Required" in
bold in the generated HTML) is used to indicate fields which must always
be present, and this is no longer the case.
Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
2019-06-14 13:49:14 -07:00
Jimmy Cuadra
e670fb1f5a
Add missing format fields to m.room.message$m.notice schema.
...
Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
2019-06-12 16:36:58 -07:00
Travis Ralston
2d18f81807
Merge pull request #2087 from matrix-org/travis/1.0/events-are-extensible
...
Reorganize event structure in c2s spec and clarify event capabilities
2019-06-11 09:55:17 -06:00
Travis Ralston
370ae8b9fe
Merge pull request #2068 from matrix-org/travis/1.0/mxc
...
Refactor documentation for content/media repository
2019-06-11 08:32:06 -06:00
Travis Ralston
04930c6ddf
Don't enforce MXC URIs, but also don't confuse people
2019-06-11 08:29:50 -06:00
Travis Ralston
4b6e2cc956
Merge pull request #2072 from matrix-org/travis/1.0/msc1717-msc1267-sas-verification
...
Spec SAS verification and the common key verification framework
2019-06-07 10:34:08 -06:00
Travis Ralston
d49c7fb3b0
Apply suggestions from code review
...
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2019-06-07 08:01:17 -06:00
Travis Ralston
70da564e2b
Merge pull request #2067 from matrix-org/travis/1.0/stripped-state
...
Clarify exactly what StrippedState is
2019-06-07 07:12:17 -06:00
Travis Ralston
8fd5b15594
Reorganize event structure in c2s spec and clarify event capabilities
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1166
Fixes https://github.com/matrix-org/matrix-doc/issues/1527
Fixes https://github.com/matrix-org/matrix-doc/issues/1827
Note: In order to fix the "state events have the following fields: [no words]" bug (1827) we need to resolve references on common event types. When doing this we ultimately end up with more fields than may be required to explain the section, however this commit alters the section descriptions to just say "these fields" instead of "these additional fields".
This is also preferable over trying to get the inheritance reversed in the common event types, as the `/sync` endpoint has a high amount of reliance on partial events definitions.
2019-06-05 22:55:11 -06:00
Travis Ralston
9ac89cc915
Merge pull request #2056 from matrix-org/travis/1.0/membership-table
...
Add a table to show how changes in membership should be interpreted
2019-06-05 10:38:32 -06:00
Travis Ralston
a3364ff357
Spec SAS verification and the common key verification framework
...
Reference implementations:
* 94f664e725
* https://github.com/matrix-org/matrix-react-sdk/pull/2461
* https://github.com/matrix-org/matrix-js-sdk/pull/818
* https://github.com/matrix-org/matrix-react-sdk/pull/2596
* https://github.com/matrix-org/matrix-js-sdk/pull/837
Proposals:
* [MSC1717](https://github.com/matrix-org/matrix-doc/pull/1717 )
* [MSC1267](https://github.com/matrix-org/matrix-doc/issues/1267 )
No alterations to either proposal have been made intentionally here.
2019-06-04 12:43:47 -06:00
Travis Ralston
9cb60fa468
Merge pull request #2059 from matrix-org/travis/1.0/msc1719-olm-unwedge
...
Add Olm unwedging
2019-06-04 11:14:54 -06:00
Travis Ralston
1f86e8e31b
Refactor documentation for content/media repository
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2060
Fixes https://github.com/matrix-org/matrix-doc/issues/772
Fixes https://github.com/matrix-org/matrix-doc/issues/888
2019-06-02 21:25:11 -06:00
Travis Ralston
7a07a6b358
Clarify exactly what StrippedState is
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2066
The expectation everywhere is that the `sender` is required. `/initialSync` references StrippedState through a `m.room.member` event reference, and does not need editing.
2019-06-02 17:41:39 -06:00
Travis Ralston
d7f37f92eb
Merge branch 'master' into travis/1.0/fix-examples
2019-05-30 16:57:51 -06:00
Travis Ralston
41e07ff7d6
Fix incorrect state of leave->leave
...
As mentioned in PR review, it is possible for moderators in a room to race at kicking someone, resulting in multiple leave events.
2019-05-30 16:54:19 -06:00
Travis Ralston
d48265f49b
typo
2019-05-30 16:51:24 -06:00
Travis Ralston
54f74cd877
Add Olm unwedging
...
As per [MSC1719](https://github.com/matrix-org/matrix-doc/pull/1719 )
No known alterations have been made to the proposal.
Implementation proof: https://github.com/matrix-org/matrix-js-sdk/pull/780
2019-05-30 16:47:30 -06:00
Travis Ralston
f3c0c5232f
Add a table to show how changes in membership should be interpreted
...
Fixes https://github.com/matrix-org/matrix-doc/issues/876
2019-05-29 21:47:07 -06:00
Travis Ralston
464845feb0
Make url required for m.file-like messages
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2008
This also removes `filename` from `m.file` because it has never been used in practice.
2019-05-29 16:36:43 -06:00
Travis Ralston
d6d74c4cbe
Switch to using $ instead of # for sub-types
...
# is reserved by the swagger validator as a way to include partial content from a JSON object (eg: "#/path" would include {"test": true} from the object {"path":{"test":true}}). Instead of trying to convince the validator that it is wrong, we'll just use a different character.
Note that our rendering tools do not care about #-style references to objects. It's still somewhat worth changing the character though.
2019-05-29 15:28:48 -06:00
Travis Ralston
2cf00fc5ca
Merge pull request #2031 from matrix-org/travis/1.0/voip-hangup
...
Add missing reason property to m.call.hangup
2019-05-28 12:11:54 -06:00
Travis Ralston
229893589a
Move wording for reason definitions
2019-05-27 21:18:04 -06:00
Travis Ralston
00f97636a2
Add missing reason property to m.call.hangup
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1689
2019-05-26 22:08:04 -06:00
Travis Ralston
5eea4a477f
Add server notices support
...
As per [MSC1452](https://github.com/matrix-org/matrix-doc/issues/1452 )
Fixes https://github.com/matrix-org/matrix-doc/issues/1254
Although MSC1452 focuses on just the warnings part of the server notices, the base for notices has not been established in the spec. This commit adds the needed support to be able to handle notices.
No intentional divergences from the proposal are included in this changeset. There are a few additions which are used in practice although not defined in the proposal, such as who is responsible for aesthetics, sending notices, and other misc rules.
2019-05-26 20:52:59 -06:00
Jonas Platte
043dddc490
Fix a typo in m.call.invite
2019-04-20 21:56:43 +02:00
Anatoly Sablin
4bec3d6dd8
Avoid duplicates.
2019-02-24 19:43:03 +03:00
Anatoly Sablin
d4b4d92b82
Fix the m.push_rules type (switch from the state event to the common event).
2019-02-16 00:24:26 +03:00
Anatoly Sablin
2de7ef9a3d
#1865 Add the m.push_rules schema.
2019-02-15 23:23:38 +03:00
Travis Ralston
b85f7bb248
Add room version upgrades
...
Implements https://github.com/matrix-org/matrix-doc/issues/1501
2019-01-09 17:02:09 -07:00
Travis Ralston
1268b421ec
Update the m.presence schema to include status_msg
2018-12-10 15:44:01 -07:00
Travis Ralston
e4a8fed0e8
Power levels always have a default of 50 for state_default
...
As per the proposal https://github.com/matrix-org/matrix-doc/issues/1304
2018-09-04 11:43:37 -06:00
Travis Ralston
108c623557
Merge pull request #1635 from turt2live/travis/c2s/read-markers
...
Add read markers
2018-08-31 14:47:39 -06:00
Hubert Chathi
c0dd7e0025
Merge pull request #1420 from Zil0/encrypted_attach
...
Document encrypted attachments
2018-08-31 13:33:05 -04:00
Hubert Chathi
f1f32d3a15
add more clarifications
2018-08-31 12:59:57 -04:00
Travis Ralston
679ddabb53
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/read-markers
2018-08-31 10:34:19 -06:00
Hubert Chathi
e3daf10bb9
refactor encrypted file schema as "Extension to m.message"
2018-08-31 12:11:27 -04:00
Travis Ralston
fc037b3a72
Fix merge
2018-08-31 09:33:30 -06:00
Travis Ralston
2e3e189ea2
Merge remote matrix-org/master
2018-08-31 09:31:39 -06:00
Travis Ralston
afa16f1e4e
Merge pull request #1606 from turt2live/travis/c2s/room-tags
...
Update the room tagging documentation
2018-08-31 08:36:40 -06:00
Travis Ralston
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)
* m.read behaviour: d69decd5c7/synapse/rest/client/v2_alpha/read_marker.py (L45-L52)
2018-08-30 16:21:31 -06:00
Hubert Chathi
4230e375fa
Merge pull request #1465 from Zil0/key_sharing
...
Document key sharing events
2018-08-29 23:05:17 -04:00
Kitsune Ral
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
Travis Ralston
c83da453b5
s/number/integer
2018-08-29 14:18:41 -06:00
Travis Ralston
26d5a24b88
Merge remote matrix-org/master
2018-08-29 14:17:21 -06:00
Travis Ralston
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
Travis Ralston
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
Travis Ralston
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
Valentin Deniaud
28ced3b0a4
fixup! document encrypted attachments
2018-08-28 15:04:40 +02:00
Travis Ralston
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