matrix-spec-proposals

Commit Graph

Author	SHA1	Message	Date
Damir Jelić	a96a2f3fce	Fix the action of a room key request cancellation. The spec states that the action of a room key request cancellation should be "cancel_request" but every known implementation uses "request_cancellation" instead. This patch fixes the spec to reflect the implementations.	5 years ago
Travis Ralston	ace94f02b7	Merge pull request #2132 from jimmycuadra/clarify-m.key.verification.start Clarify the distinction between m.key.verification.start and its m.sas.v1 variant.	5 years ago
Anatoly Sablin	802b90d113	Typo.	5 years ago
Jimmy Cuadra	8affb23e5e	Address feedback from code review. * Switch "an SAS" back to "a SAS" * Remove the `next_method` field from m.key.verification.start$m.sas.v1 but add additional clarification to its description on m.key.verification.start that it is never present for methods that verify keys both ways.	5 years ago
Jimmy Cuadra	5384b61d95	Fix style issues brought up during code review. Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>	6 years ago
Jimmy Cuadra	bc71dacaf4	Clarify the distinction between m.key.verification.start and its m.sas.v1 variant. Currently the m.key.verification.start event appears twice with the exact same title, in the "Key verification framework" section and the "Short Authentication (SAS) verification" section. It's not immediately clear that the first occurrence describes the format of the event in general terms and that the second occurrence describes the fields when the m.sas.v1 verification method is being used. This is a similar relationship to the m.room.message event and its various msgtype variants. This commit does three things: * It tweaks the generation of the documentation to change the title of the second occurrence of m.key.verification.start to distinguish it from the first. * It updates the language in the description of the two versions of the event to better describe the relationship between the two. * It adds the optional `next_method` field to the schema of the m.sas.v1 variant, as specified in the general form of m.key.verification.start. Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>	6 years ago
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>	6 years ago
Jimmy Cuadra	e670fb1f5a	Add missing format fields to m.room.message$m.notice schema. Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>	6 years ago
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	6 years ago
Travis Ralston	370ae8b9fe	Merge pull request #2068 from matrix-org/travis/1.0/mxc Refactor documentation for content/media repository	6 years ago
Travis Ralston	04930c6ddf	Don't enforce MXC URIs, but also don't confuse people	6 years ago
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	6 years ago
Travis Ralston	d49c7fb3b0	Apply suggestions from code review Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>	6 years ago
Travis Ralston	70da564e2b	Merge pull request #2067 from matrix-org/travis/1.0/stripped-state Clarify exactly what StrippedState is	6 years ago
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.	6 years ago
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	6 years ago
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.	6 years ago
Travis Ralston	9cb60fa468	Merge pull request #2059 from matrix-org/travis/1.0/msc1719-olm-unwedge Add Olm unwedging	6 years ago
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	6 years ago
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.	6 years ago
Travis Ralston	d7f37f92eb	Merge branch 'master' into travis/1.0/fix-examples	6 years ago
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.	6 years ago
Travis Ralston	d48265f49b	typo	6 years ago
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	6 years ago
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	6 years ago
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.	6 years ago
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.	6 years ago
Travis Ralston	2cf00fc5ca	Merge pull request #2031 from matrix-org/travis/1.0/voip-hangup Add missing reason property to m.call.hangup	6 years ago
Travis Ralston	229893589a	Move wording for reason definitions	6 years ago
Travis Ralston	00f97636a2	Add missing reason property to m.call.hangup Fixes https://github.com/matrix-org/matrix-doc/issues/1689	6 years ago
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.	6 years ago
Jonas Platte	043dddc490	Fix a typo in m.call.invite	6 years ago
Anatoly Sablin	4bec3d6dd8	Avoid duplicates.	6 years ago
Anatoly Sablin	d4b4d92b82	Fix the m.push_rules type (switch from the state event to the common event).	6 years ago
Anatoly Sablin	2de7ef9a3d	#1865 Add the m.push_rules schema.	6 years ago
Travis Ralston	b85f7bb248	Add room version upgrades Implements https://github.com/matrix-org/matrix-doc/issues/1501	6 years ago
Travis Ralston	1268b421ec	Update the m.presence schema to include status_msg	6 years ago
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	6 years ago
Travis Ralston	108c623557	Merge pull request #1635 from turt2live/travis/c2s/read-markers Add read markers	6 years ago
Hubert Chathi	c0dd7e0025	Merge pull request #1420 from Zil0/encrypted_attach Document encrypted attachments	6 years ago
Hubert Chathi	f1f32d3a15	add more clarifications	6 years ago
Travis Ralston	679ddabb53	Merge remote-tracking branch 'matrix-org/master' into travis/c2s/read-markers	6 years ago
Hubert Chathi	e3daf10bb9	refactor encrypted file schema as "Extension to m.message"	6 years ago
Travis Ralston	fc037b3a72	Fix merge	6 years ago
Travis Ralston	2e3e189ea2	Merge remote matrix-org/master	6 years ago
Travis Ralston	afa16f1e4e	Merge pull request #1606 from turt2live/travis/c2s/room-tags Update the room tagging documentation	6 years ago
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)`	6 years ago
Hubert Chathi	4230e375fa	Merge pull request #1465 from Zil0/key_sharing Document key sharing events	6 years ago
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>	6 years ago
Travis Ralston	c83da453b5	s/number/integer	6 years ago

1 2 3 4 5

235 Commits (675cabc33d4a0a7622dbea54c12a98cfb2ceeabc)