Commit Graph

280 Commits (df695167e8cdbb0b25e9ddd37c707d43a601213d)

Author SHA1 Message Date
Andrew Morgan 28596a6c74 Add missing changelog for #2204. 5 years ago
Travis Ralston 62f7a4f82c Fix/add changelogs
The push spec one was missed in https://github.com/matrix-org/matrix-doc/pull/2151
5 years ago
Alexey Andreyev 9ed19a37ad
Client-server: Fix upload keys example request
Contributes to #1733

Signed-off-by: Alexey Andreyev <aa13q@ya.ru>
5 years ago
J. Ryan Stinnett 9208c5cd13 Add changelog 5 years ago
Andrew Morgan e88a074c9f Add changelog 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.
6 years ago
Jimmy Cuadra 8246383330 Fix typos in changelog entry. 6 years ago
Travis Ralston 204601d9a4
Merge pull request #2133 from matrix-org/travis/fix-olm-2
Fix link to Olm signing specification
6 years ago
Travis Ralston c63b5aff69
Create 2136.clarification 6 years ago
Travis Ralston 33ca891e71 Fix link to Olm signing specification
See https://github.com/matrix-org/matrix.org/issues/478
6 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
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.
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 2dd0da7d50 Fix typo in key verification framework section.
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 1ca60bf5d7 Client-Server r0.5.0 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 8ac555f870
Merge pull request #2083 from matrix-org/travis/1.0/key-object
Clarify the key object definition for the key management API
6 years ago
Travis Ralston 19f017f9bd
Merge pull request #2035 from matrix-org/travis/1.0/msc688-msc1227-lazy-loading
Spec lazy-loading room members
6 years ago
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
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 c1c26859e2
Merge pull request #2096 from matrix-org/travis/1.0/read-notifs
Clarify how notification counts are calculated in /sync
6 years ago
Travis Ralston 39b79fe453
Merge pull request #2088 from matrix-org/travis/1.0/duplicate-state-endpoint
Merge GET/PUT /state/:event_type endpoints
6 years ago
Andrew Morgan 572d29348c
Update changelogs/client_server/newsfragments/2101.breaking
Co-Authored-By: Travis Ralston <travpc@gmail.com>
6 years ago
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
6 years ago
Travis Ralston f047e235df Merge branch 'master' into travis/1.0/event-ids 6 years ago
Travis Ralston 7fe7d365e2
Merge pull request #2089 from matrix-org/travis/1.0/cors
Clarify when and where CORS headers should be returned
6 years ago
Andrew Morgan 0f82056ca2 Highlight breaking change 6 years ago
Andrew Morgan ab0c1bc054 Add changelog, update imperative check, rename sid.yaml 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 906d3cd447
Merge pull request #2055 from matrix-org/travis/1.0/registration-clarification
Clarify guest accounts and `auth` usage on /register
6 years ago
Travis Ralston f4e85853d4
Merge pull request #2054 from matrix-org/travis/1.0/uia-clarifications
Clarify that UIA stages cannot be attempted twice
6 years ago
Travis Ralston 9cf03325b9
Merge pull request #2046 from matrix-org/travis/1.0/msc1915-unbind
Spec 3PID unbind API
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 cd6b012523 Clarify what a "module" is and update feature profiles for clients
Fixes https://github.com/matrix-org/matrix-doc/issues/2009
6 years ago
Travis Ralston f0eb495cee Clarify how notification counts are calculated in /sync
Fixes https://github.com/matrix-org/matrix-doc/issues/2015
6 years ago
Travis Ralston e1266b859f
Merge pull request #2030 from matrix-org/travis/1.0/bind-msisdn
Spec MSISDN UIA support
6 years ago
Travis Ralston 976f32fcab Clarify that /register must produce valid Matrix User IDs
Fixes https://github.com/matrix-org/matrix-doc/issues/1793
6 years ago
Travis Ralston 79bbb47d9f Clarify when authorization and rate-limiting are not applicable
Fixes https://github.com/matrix-org/matrix-doc/issues/1971
6 years ago
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
6 years ago
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
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 a19eb59f13 Clarify the key object definition for the key management API
Fixes https://github.com/matrix-org/matrix-doc/issues/1907


One too far
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 aa110b2be2
Merge pull request #2025 from matrix-org/travis/1.0/3rdpartysigned
Fix third party signed definitions for join APIs
6 years ago
Travis Ralston e8d6a57a2e
Merge pull request #2052 from matrix-org/travis/1.0/pushrules-kind
Change reference for definition of push rule condition kinds
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 042455d954
Update changelog to appease style guidelines 6 years ago
Bruno Windels 8b28972a2d PR feedback 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 ff768ec75f
Merge pull request #2036 from matrix-org/travis/1.0/wk-fail-error
Clarify that FAIL_ERROR is not limited to just homeservers.
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 a2f955b50d
Merge pull request #2053 from matrix-org/travis/1.0/required-urls
Make url required for m.file-like messages
6 years ago
Travis Ralston ff33b470a4
Merge pull request #2039 from matrix-org/travis/1.0/more-changelogs
Fix more changelog entries
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 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
6 years ago
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.
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 792bb8faa4 Renumber changelog to match PR 6 years ago
Travis Ralston f9472bae41 Change reference for definition of push rule condition kinds
Fixes https://github.com/matrix-org/matrix-doc/issues/1970
6 years ago
Travis Ralston d2232aca97
Merge pull request #2042 from matrix-org/travis/1.0/ordered-flows
Clarify that login flows must be completed in order
6 years ago
Travis Ralston c25afa663e Use consistent event examples throughout the Client-Server API
Fixes https://github.com/matrix-org/matrix-doc/issues/1968
6 years ago
Travis Ralston 4452ebf371
Merge pull request #2041 from matrix-org/travis/1.0/upload-mime-example
Fix example Content-Type for /media/upload request
6 years ago
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.
6 years ago
Travis Ralston a8f61697d1
Merge pull request #2032 from matrix-org/travis/1.0/redaction-effects
Clarify how redactions affect room state
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 bf86b4b83c Fix incorrect PR reference on changelog 6 years ago
Travis Ralston 4e58414b26 Clarify that clients should not ack their own messages
Fixes https://github.com/matrix-org/matrix-doc/issues/567
6 years ago
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
6 years ago
Travis Ralston 62890d21b2 Fix example Content-Type for /media/upload request
Fixes https://github.com/matrix-org/matrix-doc/issues/1770
6 years ago
Travis Ralston 10648aa9e8 Clarify that FAIL_ERROR is not limited to just homeservers.
Fixes https://github.com/matrix-org/matrix-doc/issues/1735
6 years ago
Travis Ralston bf8ca3abba
Merge pull request #2026 from matrix-org/travis/1.0/msc1452-server-notices
Add server notices support
6 years ago
Travis Ralston b1dccda49d changelog 6 years ago
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
6 years ago
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
6 years ago
Travis Ralston 23ab1c527a Clarify how redactions affect room state
Fixes https://github.com/matrix-org/matrix-doc/issues/1726
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 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.
6 years ago
Travis Ralston d52fcdacfa Add M_NOT_FOUND definition for deleting non-existent aliases
Fixes https://github.com/matrix-org/matrix-doc/issues/1675
6 years ago
Travis Ralston 221d9f24fd Clarify that logging out deletes devices too
Fixes https://github.com/matrix-org/matrix-doc/issues/1651
6 years ago
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
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
Travis Ralston 17a9524cad changelog 6 years ago
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
6 years ago
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.
6 years ago
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.
6 years ago
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.
6 years ago
Travis Ralston ba18a6e9fa
Merge pull request #1992 from matrix-org/anoa/missing_punctuation3
Add missing period
6 years ago
Travis Ralston 00b7b70c06
Create 1992.clarification 6 years ago
Travis Ralston 7e093e95fc
Merge pull request #1991 from matrix-org/anoa/missing_punctuation2
Add missing punctuation
6 years ago
Travis Ralston c54a5fc3df
Merge pull request #1989 from matrix-org/anoa/typo2
Add missing 'as'
6 years ago
Andrew Morgan 713e4401b4 Add changelogs 6 years ago
Andrew Morgan abd770419b Add changelog 6 years ago
Andrew Morgan 20d2fdc288 Add changelog 6 years ago
Richard van der Hoff 14715468bb Make thumbnail dimensions mandatory
Fixes #1883
6 years ago
Vikingat-RAGE 76ee13b9bb Fixed bad spacing. 6 years ago