Commit graph

1018 commits

Author SHA1 Message Date
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 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
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
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
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
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 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 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 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 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 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