Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-22 09:18:38 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
4911 commits 30 branches 42 tags 32 MiB
Commit graph

1136 commits

Author SHA1 Message Date
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 a24bcc2c0a
Merge pull request #2258 from matrix-org/travis/spec/is-terms 
Spec IS terms of service
 2019-09-06 10:29:47 -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 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.
 2019-09-03 14:04:05 -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
Travis Ralston ca4d9d8636 Deprecate the v1 IS API 2019-08-28 14:19:13 -06:00
Travis Ralston a47c5aeb42 v2-ify the v2 api 
Note that ping and pubkey doesn't require auth - see MSC2140 for more information.
 2019-08-28 14:17:51 -06:00
Travis Ralston 5b53b3d0b8 Clone v1 APIs verbatim 2019-08-28 14:01:36 -06:00
Travis Ralston b8a3f970ee Add security definition for access token 2019-08-28 13:40:48 -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
Travis Ralston 2a2dddab94
Merge pull request #2151 from reivilibre/push_id_event_id 
Fix Push Gateway API example: Field renamed to event_id
 2019-07-25 10:31:13 -06: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
reivilibre 8033ab1c86 Fix Push Gateway API example: Field renamed to event_id 
I believe this was forgotten in:
71cb646541
 2019-07-03 10:36:16 +01:00
Travis Ralston 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
Travis Ralston 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
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 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
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 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
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
Travis Ralston cf19f52576 Enforce 7 day validity requirement everywhere 
also misc formatting fixes
 2019-06-10 13:21:24 -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
Travis Ralston 6d62a1b444
Merge pull request #2084 from matrix-org/travis/1.0/s2s-swagger-touchups 
Touchups on the s2s swagger definitions
 2019-06-10 07:22:24 -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 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
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 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
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
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 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 e115e3439d Touchups on the s2s swagger definitions 
Duplicate properties, wrong types, etc.
 2019-06-05 22:13:25 -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 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:
* 00bf99fa62
* https://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
Travis Ralston fc4965f274 Stronger spec words 2019-06-05 10:40:51 -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 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
Bruno Windels 8b28972a2d PR feedback 2019-06-04 09:29:12 +02:00
Travis Ralston 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
Andrew Morgan 0b42a17352
Update api/identity/definitions/request_email_validation.yaml 
Co-Authored-By: Travis Ralston <travpc@gmail.com>
 2019-06-03 09:48:38 +01:00
Bruno Windels 53aa8fe8ec clarify the order events in chunk for /messages 2019-06-03 09:47:09 +02:00
Travis Ralston dc6d89caca Split download endpoints back apart 
Apparently you can't have an optional path parameter.
 2019-06-02 21:31:06 -06: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 0b45f3795b Rename example to invite_room_state 
This is a better representation of what it actually is
 2019-06-02 18:02:22 -06:00
Travis Ralston 237d585e07 Shorten references to StrippedState in s2s spec 2019-06-02 17:59:19 -06:00
Travis Ralston b9c4a2561f Fix examples of StrippedState in s2s spec 2019-06-02 17:50:27 -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
Andrew Morgan c0c4629993
Slight word change 2019-05-30 12:31:26 +01:00
Andrew Morgan 6ae7e49522
Clarify what the client should receiving on email resending 
It was a little unclear what the client should do when asked to send a validation email and provides a `send_attempt` value that is not greater than previous attempts. As this is intended to be for when a client mistakenly sends the request twice, it makes logical sense that the implication was to simply resend a success value so the client doesn't error even when an email may have been sent on the first attempt.

This behaviour was also mimicked in Synapse/Sydent.
 2019-05-30 12:30:43 +01: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 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 d6d74c4cbe Switch to using $ instead of # for sub-types 
# is reserved by the swagger validator as a way to include partial content from a JSON object (eg: "#/path" would include {"test": true} from the object {"path":{"test":true}}). Instead of trying to convince the validator that it is wrong, we'll just use a different character.

Note that our rendering tools do not care about #-style references to objects. It's still somewhat worth changing the character though.
 2019-05-29 15:28:48 -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