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

1093 commits

Author SHA1 Message Date
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
Travis Ralston 15b8011f63 Add missing aesthetic parameters to /store-invite 
Fixes https://github.com/matrix-org/matrix-doc/issues/2048
 2019-05-29 13:37:58 -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 c5fdd5cb0b Change note style 2019-05-28 13:57:08 -06:00
Travis Ralston 551806a8ad Add a reference to the filtering module to /sync 2019-05-28 13:57:08 -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 699cafe670 v4 is v4, not v3 2019-05-27 21:27:54 -06:00
Travis Ralston b3d86f99b9 Add room summary spec 2019-05-27 20:20:00 -06:00
Travis Ralston e610f085a9
Merge pull request #2019 from matrix-org/travis/1.0/msc1884-msc2002-v4-rooms 
Add version 4 rooms to the spec
 2019-05-27 20:08:12 -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 7b266b33da Add membership params 
Fixes https://github.com/matrix-org/matrix-doc/issues/1945
 2019-05-27 19:26:26 -06:00
Travis Ralston ba520df004 Move lazy loading to a section in Filtering 2019-05-27 17:38:11 -06:00
Travis Ralston b67161cf97 List the endpoints which are lazy-loading aware 2019-05-27 17:38:11 -06:00
Travis Ralston 34d6c1f4ad Clarify wording further for how to handle redundant members 
Note: This makes assumptions on what the TODO comment in Synapse means: e26e6b3230/synapse/handlers/pagination.py (L262)

Due to lack of implementation, it is assumed that using the same filter across multiple calls to /sync OR /messages will result in the redundant members being excluded in the next request. For example, calling /sync, then /messages which returns some members, then /sync again will exclude the members due to them being in /messages.
 2019-05-27 17:38:11 -06:00
Travis Ralston d56df3238c Generalize wording to fit /messages and /sync 2019-05-27 14:47:46 -06:00
Travis Ralston e7ed8a23ce Move lazy loading filter options to event filter 
The options also work on /messages
 2019-05-27 14:47:46 -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 a30dbc590d Clarify that e2e keys are also obliterated 2019-05-26 21:39:09 -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 2b96d73305 Fix third party signed definitions for join APIs 
Fixes https://github.com/matrix-org/matrix-doc/issues/1978
 2019-05-26 15:39:35 -06:00
Travis Ralston 3b0e194ff7 Add version 4 rooms to the spec 
As per [MSC1884](https://github.com/matrix-org/matrix-doc/pull/1884) and [MSC2002](https://github.com/matrix-org/matrix-doc/pull/2002).

No known changes since the proposals were accepted.

Due to being in the area: This fixes https://github.com/matrix-org/matrix-doc/issues/1863
 2019-05-24 15:50:05 -06:00
Andrew Morgan 3c62b90dfb Add missing punctuation 2019-05-07 16:59:10 -07:00
Richard van der Hoff 14715468bb Make thumbnail dimensions mandatory 
Fixes #1883
 2019-04-26 14:41:19 +01:00
aqtusia 24e0ec4bce
Replace /bind with /3pid/bind 2019-04-14 18:17:44 +02: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
Anatoly Sablin d52918a892 Fix #1904. 2019-02-24 22:26:32 +03: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
Travis Ralston ef13aef8c3 Clarify the recommendations for "transferable state" 
Fixes https://github.com/matrix-org/matrix-doc/issues/1843
 2019-02-10 19:33:43 -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 71f251c733
Merge pull request #1855 from matrix-org/travis/fix-wk-fallback 
Fix contradiction in wellknown discovery for servers
 2019-02-06 12:22:59 -07:00
Travis Ralston c8428b1f8b Fix contradiction in wellknown discovery for servers 
Fixes https://github.com/matrix-org/matrix-doc/issues/1854
 2019-02-05 22:39:36 -07:00
Travis Ralston 3dd0601a96 Remove more TLS fingerprint talk 2019-02-04 13:52:20 -07:00
Travis Ralston 222957157f Add missing required flags 2019-02-01 13:56:30 -07:00
Travis Ralston 1d0156ad78 Fix more titles 2019-02-01 13:37:19 -07:00
Travis Ralston 985d02d95e Fix titles in schemas 2019-02-01 13:35:38 -07:00
Travis Ralston 82bed06d3f The event *format* changes, not the version 2019-02-01 13:19:24 -07:00
Travis Ralston 890fb1a019 Fix examples for new schema 
Fix missed example in make_join

Fix state array in response of send_join

Try removing examples from send_join?

Try printing more information about the error

Copy/paste known working examples

Try schema definitions in the response?
 2019-02-01 11:14:42 -07:00
Travis Ralston 5d8fa65e6e De-duplicate state keys 2019-02-01 10:11:39 -07:00
Travis Ralston 33406e4662 Apply event format warnings to the remainder of the s2s spec 2019-02-01 10:08:30 -07:00