Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-21 08:58:38 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
5313 commits 29 branches 42 tags 32 MiB
Commit graph

894 commits

Author SHA1 Message Date
Hubert Chathi bd95568c8c remove duplicate key 2020-05-13 19:27:36 -04:00
Hubert Chathi 1bae8ea633 we actually don't support the GET /room_key/versions/ with trailing slash 2020-05-13 19:24:34 -04:00
Kitsune Ral ff59fc1905 /keys/query: Add a title in the response 
The device keys structure in queryKeys is not the same as the one
defined in device_keys.yaml (it adds things on top of it).

Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
 2020-05-08 07:48:28 +02:00
Kitsune Ral 77783b8fc3 Remove extraneous quotes, fix a typo 
filter.yaml: quotes under |- were taken literally.
notifications.yaml: it's a number in the example, not a string
 2020-05-08 07:48:28 +02:00
Hubert Chathi a896729ac2 some more clarifications and indentation fixes 2020-05-06 17:11:41 -04:00
Hubert Chathi 0145191d43 add links to endpoints and add delete endpoint 2020-05-05 20:00:45 -04:00
Hubert Chathi 5f3ee44cfb add more suggestions from review 2020-05-05 18:09:17 -04:00
Hubert Chathi 8ff1c26ef2 fix indentation 2020-05-05 17:28:54 -04:00
Hubert Chathi e0b4a3c912
Apply suggestions from code review 
Co-authored-by: Travis Ralston <travpc@gmail.com>
 2020-05-05 17:02:16 -04:00
Hubert Chathi 0d2924841b
Merge pull request #2524 from uhoreg/e2e_misc_fixes_202005 
misc fixes in e2ee spec
 2020-05-05 16:10:27 -04:00
Damir Jelić 6e33954256 client-server: Mark the event_id when putting room events as required. 2020-05-05 12:11:51 +02:00
Hubert Chathi e89521d195 some fixes (spelling, RST, and naming) 2020-05-04 22:08:22 -04:00
Patrick Cloke 1e330c9423 Clarify revocation behavior. 2020-05-04 16:23:31 -04:00
Patrick Cloke 0c582ea8c7
Apply suggestions from code review 
Co-authored-by: Travis Ralston <travpc@gmail.com>
 2020-05-04 16:21:19 -04:00
Patrick Cloke 958e1b4a2e Make the spec changes for MSC 2457. 2020-05-04 14:36:52 -04:00
Kitsune Ral 202bf8abb1 Cleanup summaries and descriptions 2020-04-29 20:15:06 +02:00
Aaron Axvig 4d808762da Change formatting from italics to code 2020-03-23 12:11:18 -04:00
Örjan Fors e151ba96ac Fix typo for upgrade 
Signed-off-by: Örjan Fors <orion@29k.org>
 2020-02-24 09:45:46 +01:00
Hubert Chathi 41072fcaa9
Apply suggestions from code review 
Co-Authored-By: Matthew Hodgson <matthew@arasphere.net>
 2020-02-07 15:28:19 -05:00
Isaiah Inuwa 8e888b916c Fix spelling mistakes. 2020-01-18 09:09:42 -06:00
Travis Ralston f59aa563dd Add missing tags to push rules endpoints 
Without the tags, the endpoints don't end up in the swagger. No changelog for this because it doesn't affect the spec itself.
 2020-01-01 11:59:37 -07:00
Hubert Chathi a62c817745
Apply suggestions from code review 
Co-Authored-By: Matthew Hodgson <matthew@arasphere.net>
 2019-12-17 11:07:04 -05:00
Hubert Chathi 4cde800ea1 fix validation errors 2019-12-16 17:25:20 -05:00
Hubert Chathi 59e337187b remove duplicated line 2019-12-16 15:54:42 -05:00
Hubert Chathi e658b17070 initial version of spec for key backups 2019-12-16 15:47:03 -05:00
Stuart Mumford c2ffef051f
Clarify description of user directory 
Signed off by Stuart Mumford <stuart@cadair.com>
 2019-12-05 09:27:37 -07:00
Travis Ralston 14d609e766
Merge pull request #2344 from matrix-org/travis/spec/fix-2338 
Add filter query param to /context
 2019-11-06 10:53:21 -07:00
Travis Ralston 9f01850f7a Add some words about where the filter is applied 2019-11-06 10:43:11 -07:00
Travis Ralston a1e5a96cf8
Update api/client-server/event_context.yaml 
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2019-11-06 10:42:08 -07:00
Travis Ralston 8e6e47ae7d
Merge pull request #2343 from matrix-org/travis/spec/fix-2120 
Recommend that clients don't preview URLs in encrypted rooms
 2019-11-06 09:50:36 -07:00
Travis Ralston e59bb20dc3 Try to clarify the filter information on /context 2019-11-05 16:08:15 -07:00
Travis Ralston ef957b990d
Merge pull request #2341 from matrix-org/travis/spec/fix-2298 
Clarify that submit_url is without authentication
 2019-11-05 16:01:20 -07:00
Travis Ralston f012da17a1 Explain why e2e previews are bad 2019-11-05 16:00:55 -07:00
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
 2019-11-04 15:57:58 -07:00
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
 2019-11-04 15:55:20 -07:00
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
 2019-11-04 15:47:25 -07:00
Travis Ralston e95eafb2ba Clarify that submit_url is without authentication 
The request is authorized by its parameters, not by an additional access token.

Fixes https://github.com/matrix-org/matrix-doc/issues/2298
 2019-11-04 15:17:51 -07:00
Travis Ralston 2bca44a2e5 Remove extraneous backwards compatibility note 2019-10-28 14:28:48 -06:00
Travis Ralston f5f12a29e0 Spec MSC2290: 3PID binding split 2019-10-23 19:24:11 -06:00
Travis Ralston 3d60e04c6a
Merge pull request #2310 from matrix-org/travis/spec/2263-deprecate-id-server 
Deprecate id_server and make it optional
 2019-10-04 16:19:53 -06:00
Travis Ralston 48b8a95df6 Deprecate id_server and make it optional 
As per [MSC2263](https://github.com/matrix-org/matrix-doc/pull/2263)
 2019-10-03 09:41:45 -06:00
Kitsune Ral 6b37bb1dd9 Merge remote-tracking branch 'remotes/origin/master' into kitsune-map-to-enum-support 2019-10-03 11:06:27 +09:00
Travis Ralston 642be6c677 Fix unbind wording 2019-09-06 13:06:16 -06:00
Travis Ralston 30a9de7e02 Merge branch 'master' into travis/spec/is-unbind 2019-09-06 13:05:19 -06:00
Travis Ralston 1881a255c2 Clarify that id_access_token is optional for r0.5 2019-09-05 13:53:58 -06:00
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.
 2019-09-04 16:38:15 -06:00
Travis Ralston 2d784d93ef Merge branch 'master' into travis/spec/is-auth 2019-09-04 16:35:50 -06:00
Travis Ralston 001c51a740 /3pid/delete and /deactivate don't take an id_access_token 2019-09-03 15:09:59 -06:00
Travis Ralston 52e6868f50 Remove bind_* params on /register as per MSC2140 
See https://github.com/matrix-org/matrix-doc/pull/2140
See https://github.com/matrix-org/matrix-doc/issues/2253
 2019-09-03 15:03:41 -06:00
Travis Ralston 0408373cf9 Litter the client-server API with id_access_token 2019-08-28 15:47:08 -06:00
Travis Ralston 4d0ea64121 Define authentication, ripping off the client-server API description 2019-08-28 15:46:58 -06:00
Travis Ralston e40d9e296d Split OpenID token info out verbatim 2019-08-28 15:46:58 -06:00
Kitsune Ral 65cd10249c Render enums inside additionalProps as one more table 
Closes #2242.
 2019-08-24 21:56:48 +09:00
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.
 2019-08-15 18:10:38 +01:00
Dominic Fischer a63fab20ee Fix some typos 
Signed-off-by: Dominic Fischer <dominicfischer7@gmail.com>
 2019-08-03 18:07:22 +01:00
Andrew Morgan af60889eee
Clarify that /rooms/{roomId}/event/{eventId}'s 404 should be M_NOT_FOUND (#2204) 
No error code is specified for this endpoint's 404. State that it should be an `M_NOT_FOUND`.
 2019-07-31 15:14:38 +01:00
Alexey Andreyev 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
J. Ryan Stinnett 4c65660b96 Clarify .m.rule.room_one_to_one push rule 
This clarifies the `.m.rule.room_one_to_one` push rule by adding a condition on
event type. Some parts of the spec already had this info, while others were
missing it. Synapse has had this behaviour since the push rule appeared.

Fixes https://github.com/matrix-org/matrix-doc/issues/2150
 2019-07-03 10:59:38 +01:00
Travis Ralston 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
Travis Ralston 8f1f8b4fe5 Fix references to filtering 
We can't have two different backlinks for the same text, so use LL as the label
 2019-06-11 11:28:35 -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 8b7887dfc2 Link to key algorithms section 2019-06-11 09:47:02 -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 56745c76aa Clarify that submit_url being not present only matters for r0.5 2019-06-11 09:22:02 -06:00
Travis Ralston 85f34f942f Fix invalid doc error 
Another annoying case of Swagger fighting us
 2019-06-11 09:18:29 -06:00
Travis Ralston f7aa2adfb4 Fix indentation 2019-06-11 09:16:44 -06:00
Travis Ralston ca8b539b2f humans prefer to be treated as people 2019-06-11 08:47:25 -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 5f24f63338 Better wording 2019-06-10 19:21:14 -04:00
Andrew Morgan 1a22508e15 identity server -> the server 2019-06-10 19:18:58 -04:00
Travis Ralston 1886a2346a Move explanation of notifications to notifications module 2019-06-10 13:38:43 -06:00
Matthew Hodgson 0506d09cf7 incorporate LL review from matthew 2019-06-10 19:38:44 +01:00
Travis Ralston f047e235df Merge branch 'master' into travis/1.0/event-ids 2019-06-10 10:52:34 -06:00
Andrew Morgan 2068cba598 Clients should submit a POST request 2019-06-10 09:14:25 +01:00
Andrew Morgan 7116f9334e More consolidation 2019-06-10 09:09:26 +01:00
Andrew Morgan d1fde0837a Consolidate id_server into ref. id_server/next_link are ignored 2019-06-10 09:06:13 +01:00
Andrew Morgan ab0c1bc054 Add changelog, update imperative check, rename sid.yaml 2019-06-10 08:41:35 +01:00
Andrew Morgan fe23de7d7f A SMS -> An SMS 2019-06-10 05:20:15 +01:00
Andrew Morgan 046a834488 Slight code cleanup 2019-06-09 22:04:58 +01:00
Andrew Morgan 2551ff6ce0 Actually check in code 2019-06-09 20:12:59 +01:00
Andrew Morgan 525bedf8e1 Fix refs 2019-06-09 20:10:44 +01:00
Andrew Morgan fba61941af Move submit_url responses to ref 2019-06-09 20:02:57 +01:00
Andrew Morgan 0ded484276 Address review comments 2019-06-09 16:10:44 +01:00
Andrew Morgan 1776ba28d3 Address review comments 2019-06-08 18:52:38 +01:00
Andrew Morgan a8edb066aa Clear up some wording 2019-06-07 18:00:12 +01:00
Andrew Morgan 8a6ef187db more object! 2019-06-07 17:52:17 +01:00
Travis Ralston a38af2009f
Apply suggestions from code review 
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2019-06-07 10:37:57 -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
Andrew Morgan 62910a28cc Merge branch 'master' into anoa/hs_3pid_tokens 
* master:
  Update example
  Fix 404s in links from room v1 spec
  Provide a more complete example of a "minimally-sized event"
  Revert signature change for redactable event test
  Clarify how many PDUs are in a given transaction object
  Clarify that the server shouldn't process retries for UIA
  Clarify when authorization and rate-limiting are not applicable
  Skip over partial event definitions in examples
  Rename example to invite_room_state
  Shorten references to StrippedState in s2s spec
  Fix examples of StrippedState in s2s spec
  Clarify exactly what StrippedState is
  Clarify that UIA stages cannot be attempted twice
  Fix test vectors with invalid JSON and signature
  Spec 3PID unbind API
  Spec MSISDN UIA support
 2019-06-07 15:55:04 +01:00
Andrew Morgan 3148184052 HS' can send 3PID token. Add a new submit_url field 2019-06-07 15:54:51 +01:00
Travis Ralston a0e8201816
Apply suggestions from code review 
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2019-06-07 08:27:53 -06:00
Travis Ralston 77c4c4b07c Add general clarity 2019-06-07 08:27:18 -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 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 afead2eb1b Clarify LL in /sync a bit more 2019-06-06 14:18:41 -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