7b0f5ea77b
Merge pull request #2159 from jimmycuadra/reference-hash-purpose
...
Clarify the purpose of reference hashes.
2019-07-09 16:27:44 -06:00
52643a92c6
Less confusing wording on Application Service's Legacy Routes ( #2160 )
...
https://matrix.org/docs/spec/application_service/r0.1.1#legacy-routes
The "becomes" wording made it a little bit confusing for which was the new route and which was the old.
2019-07-09 17:54:45 +01:00
5df86dabe0
Clarify the purpose of reference hashes.
...
The server-server specification describes a "reference hash" of an event
and how to calculate it, but is otherwise not mentioned anywhere else in
the document. This change adds a sentence to explain that they are used
for event identifiers in later room versions, which are described in
other documents.
Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
2019-07-09 01:14:29 -07:00
9ed19a37ad
Client-server: Fix upload keys example request
...
Contributes to #1733
Signed-off-by: Alexey Andreyev <aa13q@ya.ru>
2019-07-08 22:28:32 +03:00
9208c5cd13
Add changelog
2019-07-03 11:34:00 +01:00
e88a074c9f
Add changelog
2019-06-25 17:02:39 +01:00
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
8246383330
Fix typos in changelog entry.
2019-06-18 16:37:37 -07:00
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
d09af5b191
Identity r0.2.1
2019-06-17 11:18:24 -06:00
c63b5aff69
Create 2136.clarification
2019-06-17 00:10:59 -06:00
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
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
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
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
aadf1cc733
Merge pull request #2131 from jimmycuadra/e2ee-easier-typo
...
Fix typo in key verification framework section.
2019-06-14 21:56:29 +01:00
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
2dd0da7d50
Fix typo in key verification framework section.
...
Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
2019-06-14 13:48:07 -07:00
cac72ff873
Merge pull request #2126 from matrix-org/travis/403-id-unbind
...
Add 403 error to IS unbind
2019-06-13 06:25:28 -06:00
a9297f9e6c
Merge pull request #2125 from jimmycuadra/m.notice-format
...
Add missing format fields to m.room.message$m.notice schema.
2019-06-12 17:48:56 -06:00
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
67ea3b9ce8
Add 403 error to IS unbind
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2117
2019-06-12 15:41:10 -06:00
b8f1f37927
Remove incorrect id_server param from IS spec
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2118
2019-06-12 15:29:25 -06:00
98c9d93b20
Merge pull request #2113 from matrix-org/client_server/release-r0.5.0
...
Client-Server r0.5.0
2019-06-11 10:54:06 -06:00
497c6875ac
Merge pull request #2112 from matrix-org/server_server/release-r0.1.2
...
Federation r0.1.2
2019-06-11 10:53:56 -06:00
67d12165e8
Merge pull request #2111 from matrix-org/identity_service/release-r0.2.0
...
Identity r0.2.0
2019-06-11 10:53:44 -06:00
1ca60bf5d7
Client-Server r0.5.0
2019-06-11 10:40:48 -06:00
8e6ccf0a0e
Federation r0.1.2
2019-06-11 10:38:12 -06:00
34ad81e81b
Identity r0.2.0
2019-06-11 10:30:56 -06:00
4f915f2760
Appservice r0.1.1
2019-06-11 10:15:51 -06:00
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
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
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
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
6d60258e25
Merge pull request #2080 from matrix-org/travis/1.0/msc2076-msc2077-v5-rooms
...
Spec v5 rooms: Key validity
2019-06-11 08:51:25 -06:00
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
b7378a860a
Merge pull request #2097 from matrix-org/travis/1.0/common-themes
...
Specify some of the common concepts for Matrix in the index
2019-06-11 07:51:06 -06:00
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
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
572d29348c
Update changelogs/client_server/newsfragments/2101.breaking
...
Co-Authored-By: Travis Ralston <travpc@gmail.com>
2019-06-11 00:18:37 +01:00
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
f047e235df
Merge branch 'master' into travis/1.0/event-ids
2019-06-10 10:52:34 -06:00
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
0f82056ca2
Highlight breaking change
2019-06-10 08:43:34 +01:00
ab0c1bc054
Add changelog, update imperative check, rename sid.yaml
2019-06-10 08:41:35 +01:00
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
00588efd3f
Merge pull request #2086 from matrix-org/travis/1.0/fed-content-type
...
Clarify that the default s2s transport is JSON over HTTP
2019-06-07 10:12:59 -06:00
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
6a4a6db1bd
Merge pull request #2081 from matrix-org/travis/1.0/pdu-signatures
...
Clarify which servers are supposed to sign events
2019-06-07 08:56:14 -06:00
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
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
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
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
b9c9396c11
Specify some of the common concepts for Matrix in the index
...
See https://github.com/matrix-org/matrix-doc/pull/2061
Fixes https://github.com/matrix-org/matrix-doc/issues/1468
Fixes https://github.com/matrix-org/matrix-doc/issues/1528
The section is not referenced by the specifications yet - they do a fairly good job of explaining it over and over. In future, it would be good to point all the references to the index.
2019-06-06 15:59:54 -06:00
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
9bf0103ef3
Clarify how many PDUs are in a given transaction object
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2093
2019-06-06 14:36:30 -06:00
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
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
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
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
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
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
500f3d3bf1
Clarify that the default s2s transport is JSON over HTTP
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1713
2019-06-05 22:28:57 -06:00
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
7ce1ff2135
Clarify which servers are supposed to sign events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2074
2019-06-05 20:30:21 -06:00
a6314df44c
Spec v5 rooms: Key validity
...
Proposals:
* [MSC2076](https://github.com/matrix-org/matrix-doc/pull/2076 )
* [MSC2077](https://github.com/matrix-org/matrix-doc/pull/2077 )
Implementation references:
* 00bf99fa62https://github.com/matrix-org/synapse/pull/5354
* https://github.com/matrix-org/synapse/pull/5321
No known differences from the proposals are included here - alterations are accidental.
2019-06-05 17:03:19 -06:00
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
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
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
a3364ff357
Spec SAS verification and the common key verification framework
...
Reference implementations:
* 94f664e725https://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
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
9dd171a718
Merge pull request #2069 from matrix-org/bwindels/messages-chunk-order
...
Clarify the order events in chunk are returned in for /messages
2019-06-04 10:59:45 -06:00
042455d954
Update changelog to appease style guidelines
2019-06-04 10:58:39 -06:00
8b28972a2d
PR feedback
2019-06-04 09:29:12 +02:00
010757c01d
Merge pull request #2057 from matrix-org/anoa/clarify_email_sending
...
Clarify what the client should receiving on email resending
2019-06-03 11:05:28 -06:00
49b9bfc9f6
Move changelog to the right place
2019-06-03 09:48:53 +01:00
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
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
d7f37f92eb
Merge branch 'master' into travis/1.0/fix-examples
2019-05-30 16:57:51 -06:00
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
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
9d7289f4f2
Merge pull request #2049 from matrix-org/travis/1.0/store-invite-params
...
Add missing aesthetic parameters to /store-invite
2019-05-30 16:18:22 -06:00
a2f955b50d
Merge pull request #2053 from matrix-org/travis/1.0/required-urls
...
Make url required for m.file-like messages
2019-05-30 14:17:50 -06:00
ff33b470a4
Merge pull request #2039 from matrix-org/travis/1.0/more-changelogs
...
Fix more changelog entries
2019-05-30 14:14:34 -06:00
dda8976d25
Add changelog
2019-05-30 12:33:29 +01:00
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
2ed37f5bf4
Clarify guest accounts and `auth` usage on /register
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1980
Fixes https://github.com/matrix-org/matrix-doc/issues/1984
2019-05-29 21:03:19 -06:00
0f623113f1
Clarify that UIA stages cannot be attempted twice
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1987
Note: Synapse currently does not care, however the spirit of the text in the spec implies that completed == done forever, so we're just reinforcing it here.
2019-05-29 18:36:10 -06:00
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
792bb8faa4
Renumber changelog to match PR
2019-05-29 16:28:36 -06:00
f9472bae41
Change reference for definition of push rule condition kinds
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1970
2019-05-29 16:27:52 -06:00
d2232aca97
Merge pull request #2042 from matrix-org/travis/1.0/ordered-flows
...
Clarify that login flows must be completed in order
2019-05-29 16:26:22 -06:00
c25afa663e
Use consistent event examples throughout the Client-Server API
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1968
2019-05-29 14:57:56 -06:00
15b8011f63
Add missing aesthetic parameters to /store-invite
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2048
2019-05-29 13:37:58 -06:00
4452ebf371
Merge pull request #2041 from matrix-org/travis/1.0/upload-mime-example
...
Fix example Content-Type for /media/upload request
2019-05-29 08:24:19 -06:00
0463084924
Spec 3PID unbind API
...
As per [MSC1915](https://github.com/matrix-org/matrix-doc/pull/1915 )
Implementation proof:
* https://github.com/matrix-org/synapse/pull/4982
* https://github.com/matrix-org/sydent/pull/160
The only alteration made which differs from the proposal is clarity on how to handle homeservers not knowing the `id_server`. All other differences are unintentional.
2019-05-28 15:05:41 -06:00
76829ad988
Merge pull request #2037 from matrix-org/travis/1.0/appservice-hs-token
...
Clarify how homeservers are meant to auth themselves to appservices
2019-05-28 12:56:28 -06:00
a8f61697d1
Merge pull request #2032 from matrix-org/travis/1.0/redaction-effects
...
Clarify how redactions affect room state
2019-05-28 12:52:42 -06:00
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
bf86b4b83c
Fix incorrect PR reference on changelog
2019-05-27 23:42:08 -06:00
Travis Ralston