Commit Graph

608 Commits (2c3d7b168212893ecd38c0ccf984098fba3599bd)

Author SHA1 Message Date
Travis Ralston 74b627ac0b Fix the response format of the `/send` endpoint
Fixes https://github.com/matrix-org/matrix-doc/issues/2236
5 years ago
Travis Ralston 3875d50de8 Add missing changelog 5 years ago
Travis Ralston 0e771c7b07
Merge pull request #2547 from matrix-org/travis/spec/1802-fix-200
Spec v2 send_join and send_leave endpoints
5 years ago
Travis Ralston c2d5516517 Clobber changelogs 5 years ago
Nicolas Werner a7e7496cd6 Fix some numbers in the spec text.
Odds were not written as an exponent.
Special tag names count was not updated.

Fixes #2550

Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
5 years ago
Dominic Fischer c3582e5fc6
Add changelog 5 years ago
Travis Ralston a2a1694c35 Spec v2 send_join and send_leave endpoints
MSC: https://github.com/matrix-org/matrix-doc/pull/1802

Fixes https://github.com/matrix-org/matrix-doc/issues/2541

This also adds the v2 invite endpoint to the ACL protected list as that appears to be an omission.
5 years ago
Travis Ralston bd26a41114 off by one error 5 years ago
Travis Ralston d24f15a3a9 Spec soft-logout per MSC1466
MSC: https://github.com/matrix-org/matrix-doc/issues/1466
5 years ago
Travis Ralston 05228bf40b ``s -> s`` 5 years ago
Travis Ralston 9599c3bc99 changelog 5 years ago
Hubert Chathi f97b394591 add changelogs 5 years ago
Travis Ralston 3556b8457f Add changelog for 2527 5 years ago
Travis Ralston 10293d6951
Merge pull request #2532 from matrix-org/clokep/sso-login
Add MSC2454 to the specification.
5 years ago
Patrick Cloke 78f8d1322f Add MSC2454 to the specification. 5 years ago
Hubert Chathi 0d2924841b
Merge pull request #2524 from uhoreg/e2e_misc_fixes_202005
misc fixes in e2ee spec
5 years ago
Hubert Chathi 6ede023b35 make the changelog match others so they get combined 5 years ago
Hubert Chathi 9980b83dd4 add changelog 5 years ago
Travis Ralston b0e8fd648d
Apply suggestions from code review 5 years ago
Damir Jelić 3054ac572f changelogs: Fragment for the event id when putting room events clarification. 5 years ago
Patrick Cloke 0c582ea8c7
Apply suggestions from code review
Co-authored-by: Travis Ralston <travpc@gmail.com>
5 years ago
Patrick Cloke 958e1b4a2e Make the spec changes for MSC 2457. 5 years ago
Travis Ralston 411b3f432b Update changelog 5 years ago
David Vo b8efb5ac47 Add changelog for 2519
Signed-off-by: David Vo <david@vovo.id.au>
5 years ago
Travis Ralston 97b23da9f6 Update changelog entry for 2510 clarification 5 years ago
Rudi Floren 2bc798dcfa
Add changelog newsfragment 5 years ago
Travis Ralston b908b8e777 Add changelog 5 years ago
Travis Ralston f7ce75d36c Support a 'removed endpoints' changelog type 5 years ago
Travis Ralston 4f0ac741a2
Update changelogs/server_server/newsfragments/2470.removal 5 years ago
Patrick Cloke 9944decacf Add changelog entry. 5 years ago
Travis Ralston 7666b9fea7 Add changelog for name correction
https://github.com/matrix-org/matrix-doc/pull/2453
5 years ago
Örjan Fors e151ba96ac Fix typo for upgrade
Signed-off-by: Örjan Fors <orion@29k.org>
5 years ago
Travis Ralston f823118a69
Merge pull request #2434 from matrix-org/travis/spec/2313-moderation-policies
Spec moderation policy rooms (MSC2313)
5 years ago
Travis Ralston 7a878bb6c3 Fix location of changelog entries and synergize them 5 years ago
Travis Ralston da047523e3 Changelog 5 years ago
Nicolas Werner 6911171e83 Fix key export format example
Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
5 years ago
Isaiah Inuwa 715d2d674b Add changelog for spelling. 5 years ago
Travis Ralston 912b3cbc95 Move auth events selection to a more appropriate section of the spec
This was pretty buried, and feels like a common question.
5 years ago
Hubert Chathi 90bf2b3b46 add changelog 5 years ago
Travis Ralston 21b50d749a
Merge pull request #2369 from iinuwa/token-auth-doc-tweaks
Rename nonce to txn_id. Reorganize for clarity.
5 years ago
Travis Ralston 7cfc4b09a6 Changelog 5 years ago
Travis Ralston 4d0bd5b9e2 Changelog 5 years ago
Travis Ralston d93d8fe9b5 Add a changelog 5 years ago
Travis Ralston 11a7d799a3
Merge pull request #2349 from matrix-org/identity_service/release-r0.3.0
Identity Service r0.3.0 release
5 years ago
Travis Ralston 5b6d6fe498
Update changelogs/client_server.rst
Co-Authored-By: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
5 years ago
Travis Ralston f361c756d2 Client Server r0.6.0 release 5 years ago
Travis Ralston df202dd493 Identity Service r0.3.0 release 5 years ago
Travis Ralston 14d609e766
Merge pull request #2344 from matrix-org/travis/spec/fix-2338
Add filter query param to /context
5 years ago
Travis Ralston 8e6e47ae7d
Merge pull request #2343 from matrix-org/travis/spec/fix-2120
Recommend that clients don't preview URLs in encrypted rooms
5 years ago
Travis Ralston ef957b990d
Merge pull request #2341 from matrix-org/travis/spec/fix-2298
Clarify that submit_url is without authentication
5 years ago
Travis Ralston a50e828509
Merge pull request #2342 from matrix-org/travis/spec/fix-1982
Clarify what format the `country` is on phone number inputs
5 years ago
Travis Ralston 3d954f93b5 Clarify that the room ID is the object key in /sync responses
Fixes https://github.com/matrix-org/matrix-doc/issues/2269
5 years ago
Travis Ralston 021c056efc Add filter query param to /context
This was missed as part of lazy-loading.

Fixes https://github.com/matrix-org/matrix-doc/issues/2338
5 years ago
Travis Ralston b662a33081 Recommend that clients don't preview URLs in encrypted rooms
Any stronger of a recommendation would probably require a MSC due to the behaviour change. 

Fixes https://github.com/matrix-org/matrix-doc/issues/2120
5 years ago
Travis Ralston 284b15495b Clarify what format the `country` is on phone number inputs
Fixes https://github.com/matrix-org/matrix-doc/issues/1982
5 years ago
Travis Ralston 1dfe2ade08 Changelog 5 years ago
Travis Ralston 156fbfb4c7
Merge pull request #2311 from matrix-org/travis/fix-changelog-again
Fix client-server typos changelog
5 years ago
Travis Ralston 3d60e04c6a
Merge pull request #2310 from matrix-org/travis/spec/2263-deprecate-id-server
Deprecate id_server and make it optional
5 years ago
Travis Ralston b59998fd2b Fix client-server typos changelog
Note: .misc is not a valid changelog entry.
5 years ago
Travis Ralston 2e84465c13 Changelog 5 years ago
Kitsune Ral 6b37bb1dd9 Merge remote-tracking branch 'remotes/origin/master' into kitsune-map-to-enum-support 5 years ago
Kitsune Ral 79f16d40a9
Add a full stop
Co-Authored-By: Travis Ralston <travpc@gmail.com>
5 years ago
Travis Ralston 5cb7599196 Changelog 5 years ago
Travis Ralston 2c88f02daa
Merge pull request #2287 from matrix-org/travis/spec/lookup-v2
Spec the v2 lookup API
5 years ago
Travis Ralston b3e2326d8b changelog 5 years ago
Travis Ralston 30a9de7e02 Merge branch 'master' into travis/spec/is-unbind 5 years ago
Travis Ralston a24bcc2c0a
Merge pull request #2258 from matrix-org/travis/spec/is-terms
Spec IS terms of service
5 years ago
Travis Ralston f7e00b19e9
Merge pull request #2255 from matrix-org/travis/spec/is-auth
Spec the v2 IS auth APIs
5 years ago
Travis Ralston 185c564a13 Spec client-server IS unbind API
As per [MSC2140](https://github.com/matrix-org/matrix-doc/pull/2140)

Note: this modifies the endpoint in MSC2140 to be more in line with the remainder of the proposal.
5 years ago
Travis Ralston 2d784d93ef Merge branch 'master' into travis/spec/is-auth 5 years ago
Travis Ralston 6ec7d4cd89 changelog 5 years ago
Travis Ralston caf46db6e7 Changelog 5 years ago
Travis Ralston afd5018494 Spec the terms of service handling for identity servers
Part of MSC2140

Convert status codes to strings if there is a string status code. Fixes a build error when we mix 4xx and 403 in the same definition. We also have to correct stringified numbers to pass the build.
5 years ago
Travis Ralston fad9974383 Add missed changelog from prior PR 5 years ago
Travis Ralston aa98137514 Add changelog 5 years ago
Damir Jelić 35eb1993d9 Add a changelog fragment for the room key request action fix. 5 years ago
Kitsune Ral 31c132ec82 Add changelog 5 years ago
Andrew Morgan 92c6f4c38e
Add M_USER_DEACTIVATED to list of error codes (#2234)
Spec PR for [MSC 2181](https://github.com/matrix-org/matrix-doc/pull/2181).

Adds the `M_USER_DEACTIVATED` error code and a short description to the client-server API.
5 years ago
Travis Ralston a171d5f6fd Check for a state_key on the tombstone push rule
This is an oversight from the proposal.
5 years ago
Dominic Fischer a63fab20ee Fix some typos
Signed-off-by: Dominic Fischer <dominicfischer7@gmail.com>
5 years ago
Andrew Morgan 28596a6c74 Add missing changelog for #2204. 5 years ago
Travis Ralston d4ce3a0181
Merge pull request #2201 from matrix-org/push_gateway/release-r0.1.1
Push r0.1.1 release
5 years ago
Travis Ralston cfc502a2f1
Merge pull request #2202 from matrix-org/application_service/release-r0.1.2
Appservices r0.1.2 release
5 years ago
Travis Ralston 26c2ce8a92 Server-server r0.1.3 changelog 5 years ago
Travis Ralston 0b49112399 Appservices r0.1.2 changelog 5 years ago
Travis Ralston 40e6f82cbd Push r0.1.1 changelog 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
Travis Ralston 7b0f5ea77b
Merge pull request #2159 from jimmycuadra/reference-hash-purpose
Clarify the purpose of reference hashes.
5 years ago
Andrew Morgan 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.
5 years ago
Jimmy Cuadra 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>
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 d09af5b191 Identity r0.2.1 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
Matthew Hodgson aadf1cc733
Merge pull request #2131 from jimmycuadra/e2ee-easier-typo
Fix typo in key verification framework section.
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
Travis Ralston cac72ff873
Merge pull request #2126 from matrix-org/travis/403-id-unbind
Add 403 error to IS unbind
6 years ago
Travis Ralston a9297f9e6c
Merge pull request #2125 from jimmycuadra/m.notice-format
Add missing format fields to m.room.message$m.notice schema.
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 67ea3b9ce8 Add 403 error to IS unbind
Fixes https://github.com/matrix-org/matrix-doc/issues/2117
6 years ago
Travis Ralston b8f1f37927 Remove incorrect id_server param from IS spec
Fixes https://github.com/matrix-org/matrix-doc/issues/2118
6 years ago
Travis Ralston 98c9d93b20
Merge pull request #2113 from matrix-org/client_server/release-r0.5.0
Client-Server r0.5.0
6 years ago
Travis Ralston 497c6875ac
Merge pull request #2112 from matrix-org/server_server/release-r0.1.2
Federation r0.1.2
6 years ago
Travis Ralston 67d12165e8
Merge pull request #2111 from matrix-org/identity_service/release-r0.2.0
Identity r0.2.0
6 years ago
Travis Ralston 1ca60bf5d7 Client-Server r0.5.0 6 years ago
Travis Ralston 8e6ccf0a0e Federation r0.1.2 6 years ago
Travis Ralston 34ad81e81b Identity r0.2.0 6 years ago
Travis Ralston 4f915f2760 Appservice r0.1.1 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 6d60258e25
Merge pull request #2080 from matrix-org/travis/1.0/msc2076-msc2077-v5-rooms
Spec v5 rooms: Key validity
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 b7378a860a
Merge pull request #2097 from matrix-org/travis/1.0/common-themes
Specify some of the common concepts for Matrix in the index
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 00588efd3f
Merge pull request #2086 from matrix-org/travis/1.0/fed-content-type
Clarify that the default s2s transport is JSON over HTTP
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 6a4a6db1bd
Merge pull request #2081 from matrix-org/travis/1.0/pdu-signatures
Clarify which servers are supposed to sign events
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 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.
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 9bf0103ef3 Clarify how many PDUs are in a given transaction object
Fixes https://github.com/matrix-org/matrix-doc/issues/2093
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 500f3d3bf1 Clarify that the default s2s transport is JSON over HTTP
Fixes https://github.com/matrix-org/matrix-doc/issues/1713
6 years ago