0
0
Fork 0
Commit Graph

265 Commits

Author SHA1 Message Date
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
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 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
Travis Ralston 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
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 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
Travis Ralston 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
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 792bb8faa4 Renumber changelog to match PR 2019-05-29 16:28:36 -06:00
Travis Ralston 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
Travis Ralston 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
Travis Ralston 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
Travis Ralston 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
Travis Ralston 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
Travis Ralston 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
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 bf86b4b83c Fix incorrect PR reference on changelog 2019-05-27 23:42:08 -06:00
Travis Ralston 4e58414b26 Clarify that clients should not ack their own messages
Fixes https://github.com/matrix-org/matrix-doc/issues/567
2019-05-27 23:20:09 -06:00
Travis Ralston 572a6056ad Clarify that login flows must be completed in order
Fixes https://github.com/matrix-org/matrix-doc/issues/1134

Evidence of this being the case is shown here: https://github.com/matrix-org/synapse/pull/5174
2019-05-27 23:16:21 -06:00
Travis Ralston 62890d21b2 Fix example Content-Type for /media/upload request
Fixes https://github.com/matrix-org/matrix-doc/issues/1770
2019-05-27 23:08:02 -06:00
Travis Ralston 10648aa9e8 Clarify that FAIL_ERROR is not limited to just homeservers.
Fixes https://github.com/matrix-org/matrix-doc/issues/1735
2019-05-27 22:30:37 -06:00
Travis Ralston bf8ca3abba
Merge pull request #2026 from matrix-org/travis/1.0/msc1452-server-notices
Add server notices support
2019-05-27 21:22:33 -06:00
Travis Ralston b1dccda49d changelog 2019-05-27 20:47:53 -06:00
Travis Ralston 40cf4620d5
Merge pull request #2027 from matrix-org/travis/1.0/pw-change-uia
Add rationale for UIA on change password, and how access tokens behave
2019-05-27 19:48:48 -06:00
Travis Ralston 1aa71f2436
Merge pull request #2029 from matrix-org/travis/1.0/delete-alias
Add M_NOT_FOUND definition for deleting non-existent aliases
2019-05-27 19:43:04 -06:00
Travis Ralston 23ab1c527a Clarify how redactions affect room state
Fixes https://github.com/matrix-org/matrix-doc/issues/1726
2019-05-26 22:16:12 -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 1bda3fe2b2 Spec MSISDN UIA support
Fixes https://github.com/matrix-org/matrix-doc/issues/1702

1702 describes the lack of `bind_msisdn` parameter, however the whole login type was missing from UIA.
2019-05-26 21:49:46 -06:00
Travis Ralston d52fcdacfa Add M_NOT_FOUND definition for deleting non-existent aliases
Fixes https://github.com/matrix-org/matrix-doc/issues/1675
2019-05-26 21:36:31 -06:00
Travis Ralston 221d9f24fd Clarify that logging out deletes devices too
Fixes https://github.com/matrix-org/matrix-doc/issues/1651
2019-05-26 21:30:55 -06:00
Travis Ralston 1d33adf62d Add rationale for UIA on change password, and how access tokens behave
Fixes https://github.com/matrix-org/matrix-doc/issues/680
2019-05-26 21:21:58 -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
Travis Ralston 17a9524cad changelog 2019-05-26 15:40:29 -06:00
Travis Ralston 5c268ef21f
Merge pull request #2020 from matrix-org/travis/1.0/msc1930-tombstone-notif
Add a .m.rule.tombstone default push rule for room upgrades
2019-05-25 09:03:34 -06:00
Travis Ralston ceaccffdf7 Add a .m.rule.tombstone default push rule for room upgrades
As per [MSC1930](https://github.com/matrix-org/matrix-doc/pull/1930)

There are no known changes to this proposal since it was accepted.
2019-05-24 17:14:23 -06:00
Travis Ralston 3c38956510 Remove prev_content from the redaction essential keys list
As per [MSC1954](https://github.com/matrix-org/matrix-doc/pull/1954)

No known changes since the proposal was accepted.
2019-05-24 11:57:22 -06:00
Travis Ralston 9c2a789d34 Add missing changelogs and make existing ones match conventions
The conventions are not set in stone, however the changelog should not be a mixed bag of voices.
2019-05-23 22:13:57 -06:00
Travis Ralston ba18a6e9fa
Merge pull request #1992 from matrix-org/anoa/missing_punctuation3
Add missing period
2019-05-07 23:12:47 -06:00
Travis Ralston 00b7b70c06
Create 1992.clarification 2019-05-07 23:09:39 -06:00
Travis Ralston 7e093e95fc
Merge pull request #1991 from matrix-org/anoa/missing_punctuation2
Add missing punctuation
2019-05-07 23:08:23 -06:00
Travis Ralston c54a5fc3df
Merge pull request #1989 from matrix-org/anoa/typo2
Add missing 'as'
2019-05-07 23:06:46 -06:00
Andrew Morgan 713e4401b4 Add changelogs 2019-05-07 19:54:38 -07:00
Andrew Morgan abd770419b Add changelog 2019-05-07 19:52:38 -07:00
Andrew Morgan 20d2fdc288 Add changelog 2019-05-07 19:51:42 -07:00
Richard van der Hoff 14715468bb Make thumbnail dimensions mandatory
Fixes #1883
2019-04-26 14:41:19 +01:00
Vikingat-RAGE 76ee13b9bb Fixed bad spacing. 2019-03-18 21:54:56 +00:00
Travis Ralston c08d223cfe
Merge pull request #1889 from ma1uta/push_rules
Fix for the #1865
2019-02-28 13:31:56 -07:00
Anatoly Sablin 5303ba54b7 Add a clarification changelog. 2019-02-28 21:04:23 +03:00
Travis Ralston adb721bc0b Fix unrelated changelog entry's RST representation 2019-02-24 21:55:57 -07:00
Travis Ralston baf8948eb5 Describe M_UNSUPPORTED_ROOM_VERSION on invite and createRoom endpoints
Spec for MSC1866: https://github.com/matrix-org/matrix-doc/pull/1866
2019-02-24 21:55:04 -07:00
Travis Ralston 49119ed345
Merge pull request #1875 from matrix-org/travis/clarify-upgrades
Clarify the recommendations for "transferable state"
2019-02-18 06:14:43 -07:00
Travis Ralston 72242e4ebb
Merge pull request #1879 from matrix-org/travis/fix-capabilities
Correctly nest the capabilities response object
2019-02-11 21:45:02 -07:00
Travis Ralston d31d2f5e57 Correctly nest the capabilities response object
Everything is contained in a "capabilities" property, which is not represented by the schema. The example was correct.
2019-02-11 20:31:48 -07:00
Andrew Morgan 48569c2156
Merge pull request #1853 from matrix-org/anoa/3pid_typos
Replace "3pid" with "3PID"
2019-02-11 15:11:28 +00:00
Travis Ralston 26810bccef
Merge pull request #1873 from matrix-org/travis/spec/get-account-data
Add routes for retrieving account data
2019-02-11 08:02:34 -07:00
Andrew Morgan df7223f992 Add changelogs 2019-02-11 10:02:05 +00:00
Travis Ralston f67782230a changelog 2019-02-10 19:35:23 -07:00
Travis Ralston 5721712eae Add M_RESOURCE_LIMIT_EXCEEDED
Original proposal: https://github.com/matrix-org/matrix-doc/issues/1504

No changes from the original proposal or implementations have been made intentionally here.
2019-02-10 17:47:17 -07:00
Travis Ralston 6bbf22cd04 Add routes for retrieving account data
Original proposal: https://github.com/matrix-org/matrix-doc/issues/1339

This contains no known differences to what was ultimately decided upon and implemented.
2019-02-10 17:07:47 -07:00
Travis Ralston 85578f9842 Fix spelling mistake: endponts -> endpoints
Fixes https://github.com/matrix-org/matrix-doc/issues/1677
2019-02-06 22:19:47 -07:00
Travis Ralston e27c83d9f8
Merge pull request #1817 from matrix-org/neilj/remove_presence_lists
remove references to presence lists
2019-02-01 08:37:08 -07:00
Travis Ralston ccce6c196d Specify how capabilities work in the c2s API
Original proposals:
* https://github.com/matrix-org/matrix-doc/pull/1753
* https://github.com/matrix-org/matrix-doc/pull/1804

Implementation proof:
* https://github.com/matrix-org/synapse/pull/4472
* https://github.com/matrix-org/matrix-js-sdk/pull/830

There is one change to MSC1753 which is included in this commit. MSC1804 remains unchanged. In the original proposal, the change password capability being present was an indication that password changes were possible. It was found that this doesn't really communicate the state very well to clients in that lack of a capability (or a 404, etc) would mean that users would erroneously not be able to change their passwords. A simple boolean flag was added to assist clients in detecting this capability.
2019-01-30 19:43:55 -07:00
Travis Ralston 4437c383bb
Merge pull request #1790 from matrix-org/travis/spec/login-redirect
Add a mechanism for redirecting clients after login
2019-01-30 13:33:03 -07:00