Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-25 10:28:37 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
4262 commits 30 branches 42 tags 32 MiB
Commit graph

227 commits

Author SHA1 Message Date
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.
 2019-06-18 18:42:23 -06:00
Jimmy Cuadra 8246383330 Fix typos in changelog entry. 2019-06-18 16:37:37 -07:00
Travis Ralston 204601d9a4
Merge pull request #2133 from matrix-org/travis/fix-olm-2 
Fix link to Olm signing specification
 2019-06-18 10:01:04 -06:00
Travis Ralston c63b5aff69
Create 2136.clarification 2019-06-17 00:10:59 -06:00
Travis Ralston 33ca891e71 Fix link to Olm signing specification 
See https://github.com/matrix-org/matrix.org/issues/478
 2019-06-14 22:22:43 -06:00
Jimmy Cuadra 5384b61d95 Fix style issues brought up during code review. 
Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
 2019-06-14 17:35:39 -07:00
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>
 2019-06-14 16:20:51 -07:00
Travis Ralston b807e1cbe5
Merge pull request #2129 from jimmycuadra/conditionally-required-url-fields 
Remove the "required" designation from the `url` field of certain m.room.message msgtypes.
 2019-06-14 14:58:57 -06:00
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 2dd0da7d50 Fix typo in key verification framework section. 
Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
 2019-06-14 13:48:07 -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 1ca60bf5d7 Client-Server r0.5.0 2019-06-11 10:40:48 -06: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 8ac555f870
Merge pull request #2083 from matrix-org/travis/1.0/key-object 
Clarify the key object definition for the key management API
 2019-06-11 09:50:34 -06:00
Travis Ralston 19f017f9bd
Merge pull request #2035 from matrix-org/travis/1.0/msc688-msc1227-lazy-loading 
Spec lazy-loading room members
 2019-06-11 09:39:32 -06:00
Travis Ralston fbdb56a29f
Merge pull request #2101 from matrix-org/anoa/hs_3pid_tokens 
Add submit_url field to requestToken responses, clarify HS's can send tokens themselves
 2019-06-11 09:25:53 -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 c1c26859e2
Merge pull request #2096 from matrix-org/travis/1.0/read-notifs 
Clarify how notification counts are calculated in /sync
 2019-06-11 07:50:33 -06:00
Travis Ralston 39b79fe453
Merge pull request #2088 from matrix-org/travis/1.0/duplicate-state-endpoint 
Merge GET/PUT /state/:event_type endpoints
 2019-06-11 07:49:20 -06:00
Andrew Morgan 572d29348c
Update changelogs/client_server/newsfragments/2101.breaking 
Co-Authored-By: Travis Ralston <travpc@gmail.com>
 2019-06-11 00:18:37 +01:00
Travis Ralston 32761fc108
Merge pull request #2098 from matrix-org/travis/1.0/modules-update 
Clarify what a "module" is and update feature profiles for clients
 2019-06-10 14:05:15 -06:00
Travis Ralston f047e235df Merge branch 'master' into travis/1.0/event-ids 2019-06-10 10:52:34 -06:00
Travis Ralston 7fe7d365e2
Merge pull request #2089 from matrix-org/travis/1.0/cors 
Clarify when and where CORS headers should be returned
 2019-06-10 07:21:52 -06:00
Andrew Morgan 0f82056ca2 Highlight breaking change 2019-06-10 08:43:34 +01:00
Andrew Morgan ab0c1bc054 Add changelog, update imperative check, rename sid.yaml 2019-06-10 08:41:35 +01: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 906d3cd447
Merge pull request #2055 from matrix-org/travis/1.0/registration-clarification 
Clarify guest accounts and `auth` usage on /register
 2019-06-07 10:05:56 -06:00
Travis Ralston f4e85853d4
Merge pull request #2054 from matrix-org/travis/1.0/uia-clarifications 
Clarify that UIA stages cannot be attempted twice
 2019-06-07 07:38:40 -06:00
Travis Ralston 9cf03325b9
Merge pull request #2046 from matrix-org/travis/1.0/msc1915-unbind 
Spec 3PID unbind API
 2019-06-07 07:33:33 -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 cd6b012523 Clarify what a "module" is and update feature profiles for clients 
Fixes https://github.com/matrix-org/matrix-doc/issues/2009
 2019-06-06 17:07:49 -06:00
Travis Ralston f0eb495cee Clarify how notification counts are calculated in /sync 
Fixes https://github.com/matrix-org/matrix-doc/issues/2015
 2019-06-06 15:41:28 -06:00
Travis Ralston e1266b859f
Merge pull request #2030 from matrix-org/travis/1.0/bind-msisdn 
Spec MSISDN UIA support
 2019-06-06 10:24:34 -06:00
Travis Ralston 976f32fcab Clarify that /register must produce valid Matrix User IDs 
Fixes https://github.com/matrix-org/matrix-doc/issues/1793
 2019-06-05 23:23:23 -06:00
Travis Ralston 79bbb47d9f Clarify when authorization and rate-limiting are not applicable 
Fixes https://github.com/matrix-org/matrix-doc/issues/1971
 2019-06-05 23:18:04 -06:00
Travis Ralston bbc7401973 Clarify when and where CORS headers should be returned 
Fixes https://github.com/matrix-org/matrix-doc/issues/1736
Fixes https://github.com/matrix-org/matrix-doc/issues/2013
 2019-06-05 23:14:33 -06:00
Travis Ralston c8a3850598 Merge GET/PUT /state/:event_type endpoints 
Clarifying that the state key is optional, and how that works.

Fixes https://github.com/matrix-org/matrix-doc/issues/1182
 2019-06-05 23:06:00 -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 a19eb59f13 Clarify the key object definition for the key management API 
Fixes https://github.com/matrix-org/matrix-doc/issues/1907


One too far
 2019-06-05 22:09:42 -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 aa110b2be2
Merge pull request #2025 from matrix-org/travis/1.0/3rdpartysigned 
Fix third party signed definitions for join APIs
 2019-06-05 07:10:19 -06:00
Travis Ralston e8d6a57a2e
Merge pull request #2052 from matrix-org/travis/1.0/pushrules-kind 
Change reference for definition of push rule condition kinds
 2019-06-05 07:08: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 042455d954
Update changelog to appease style guidelines 2019-06-04 10:58:39 -06:00
Bruno Windels 8b28972a2d PR feedback 2019-06-04 09:29:12 +02: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 ff768ec75f
Merge pull request #2036 from matrix-org/travis/1.0/wk-fail-error 
Clarify that FAIL_ERROR is not limited to just homeservers.
 2019-05-30 16:56:28 -06:00