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
e115e3439d
Touchups on the s2s swagger definitions
...
Duplicate properties, wrong types, etc.
2019-06-05 22:13:25 -06:00
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
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:
* 00bf99fa62https://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
fc4965f274
Stronger spec words
2019-06-05 10:40:51 -06:00
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
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
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
8b28972a2d
PR feedback
2019-06-04 09:29:12 +02:00
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
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
53aa8fe8ec
clarify the order events in chunk for /messages
2019-06-03 09:47:09 +02:00
dc6d89caca
Split download endpoints back apart
...
Apparently you can't have an optional path parameter.
2019-06-02 21:31:06 -06:00
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
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
237d585e07
Shorten references to StrippedState in s2s spec
2019-06-02 17:59:19 -06:00
b9c4a2561f
Fix examples of StrippedState in s2s spec
2019-06-02 17:50:27 -06:00
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
d7f37f92eb
Merge branch 'master' into travis/1.0/fix-examples
2019-05-30 16:57:51 -06:00
c0c4629993
Slight word change
2019-05-30 12:31:26 +01:00
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
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
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
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
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
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
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
c5fdd5cb0b
Change note style
2019-05-28 13:57:08 -06:00
551806a8ad
Add a reference to the filtering module to /sync
2019-05-28 13:57:08 -06:00
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
699cafe670
v4 is v4, not v3
2019-05-27 21:27:54 -06:00
b3d86f99b9
Add room summary spec
2019-05-27 20:20:00 -06:00
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
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
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
7b266b33da
Add membership params
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1945
2019-05-27 19:26:26 -06:00
ba520df004
Move lazy loading to a section in Filtering
2019-05-27 17:38:11 -06:00
b67161cf97
List the endpoints which are lazy-loading aware
2019-05-27 17:38:11 -06:00
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)
2019-05-27 17:38:11 -06:00
d56df3238c
Generalize wording to fit /messages and /sync
2019-05-27 14:47:46 -06:00
e7ed8a23ce
Move lazy loading filter options to event filter
...
The options also work on /messages
2019-05-27 14:47:46 -06:00
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
a30dbc590d
Clarify that e2e keys are also obliterated
2019-05-26 21:39:09 -06:00
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
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
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
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
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
3c62b90dfb
Add missing punctuation
2019-05-07 16:59:10 -07:00
14715468bb
Make thumbnail dimensions mandatory
...
Fixes #1883
2019-04-26 14:41:19 +01:00
24e0ec4bce
Replace /bind with /3pid/bind
2019-04-14 18:17:44 +02:00
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
d52918a892
Fix #1904 .
2019-02-24 22:26:32 +03:00
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
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
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
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
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
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
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
3dd0601a96
Remove more TLS fingerprint talk
2019-02-04 13:52:20 -07:00
222957157f
Add missing required flags
2019-02-01 13:56:30 -07:00
1d0156ad78
Fix more titles
2019-02-01 13:37:19 -07:00
985d02d95e
Fix titles in schemas
2019-02-01 13:35:38 -07:00
82bed06d3f
The event *format* changes, not the version
2019-02-01 13:19:24 -07:00
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
5d8fa65e6e
De-duplicate state keys
2019-02-01 10:11:39 -07:00
33406e4662
Apply event format warnings to the remainder of the s2s spec
2019-02-01 10:08:30 -07:00
9b214ec16d
Make the backfill response aware of event format changes
2019-02-01 08:40:18 -07:00
e27c83d9f8
Merge pull request #1817 from matrix-org/neilj/remove_presence_lists
...
remove references to presence lists
2019-02-01 08:37:08 -07:00
41e50d553e
Merge pull request #1830 from matrix-org/travis/spec/x509-wk
...
Specify .well-known s2s discovery and X.509 validation
2019-02-01 08:36:55 -07:00
df01acc6e2
Merge pull request #1828 from matrix-org/travis/spec/rooms-v3
...
Add specification for room version 3: Event IDs as hashes
2019-01-31 17:59:31 -07:00
01556e5b17
Clarifications and bug fixes in how v3 rooms work
2019-01-31 16:44:37 -07:00
c888f3f080
Make example strings more legible
2019-01-31 00:09:30 -07:00
0347e873ef
Specify .well-known s2s discovery and X.509 validation
...
Original proposals:
* https://github.com/matrix-org/matrix-doc/pull/1708 (note: the JSON requirements were softened by https://github.com/matrix-org/matrix-doc/pull/1824 )
* https://github.com/matrix-org/matrix-doc/pull/1711
Implementation proofs:
* https://github.com/matrix-org/synapse/pull/4489
* No explicit PRs for MSC1711 could be found, however Synapse is known to implement it.
There are no intentional changes which differ from the proposals in this commit, however the author has relied upon various historical conversations outside of the proposals to gain the required context. Inaccuracies introduced by the author are purely accidental.
2019-01-30 22:11:31 -07:00
9193d57dfd
full stop
2019-01-30 19:47:16 -07:00
ccce6c196d
Specify how capabilities work in the c2s API
...
Original proposals:
* https://github.com/matrix-org/matrix-doc/pull/1753
* https://github.com/matrix-org/matrix-doc/pull/1804
Implementation proof:
* https://github.com/matrix-org/synapse/pull/4472
* https://github.com/matrix-org/matrix-js-sdk/pull/830
There is one change to MSC1753 which is included in this commit. MSC1804 remains unchanged. In the original proposal, the change password capability being present was an indication that password changes were possible. It was found that this doesn't really communicate the state very well to clients in that lack of a capability (or a 404, etc) would mean that users would erroneously not be able to change their passwords. A simple boolean flag was added to assist clients in detecting this capability.
2019-01-30 19:43:55 -07:00
ff75996524
Add specification for room version 3: Event IDs as hashes
...
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1659
Implementation proofs (some traversing of the PR tree may be required to get all of them):
* https://github.com/matrix-org/synapse/pull/4483
* https://github.com/matrix-org/synapse/pull/4499
This doesn't intentionally change anything from the proposal.
**Implementation details**:
The simple part of this is the introduction of a rooms/v3.html document. The somewhat unclear part is the stuff done to the s2s definitions. This pulls `unsigned_pdu` out to `unsigned_pdu_base` (all fields except `event_id`) where it can be reused in `pdu` and `pdu_v3` (for rooms v3). These definitions are further moved into the room version specifications where they can highlight the exact schemas in detail.
Version 1 has been updated to include the pre-existing event format, however the core principles of the room have not been changed. The same applies to room version 2. Room versions have immutable core principles once in the spec, otherwise these format changes would land in a pre-existing version.
The client-server API event formats will need updating, however that is being punted to a different commit to try and keep these changes reviewable.
2019-01-30 17:03:03 -07:00
4437c383bb
Merge pull request #1790 from matrix-org/travis/spec/login-redirect
...
Add a mechanism for redirecting clients after login
2019-01-30 13:33:03 -07:00
afd399d7d4
remove unused schema defs
2019-01-30 11:43:30 +00:00
d2b35e5150
Merge pull request #1821 from matrix-org/travis/spec/rver-make-memberships
...
Specify the room_version response property on /make_{leave|join}
2019-01-29 10:19:13 -07:00
c0039c30f2
Minor wording changes from code review
...
Co-Authored-By: turt2live <travpc@gmail.com>
2019-01-29 09:05:20 -07:00
d12593feea
Specify the room_version response property on /make_{leave|join}
...
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1813
Implementation proof: https://github.com/matrix-org/synapse/pull/4447
There are no changes from the original proposal.
2019-01-28 22:17:51 -07:00
aca9437bf3
Specification for v2 s2s invite API
...
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1794
Implementation proofs:
* https://github.com/matrix-org/synapse/pull/4402
* https://github.com/matrix-org/synapse/pull/4496
There are no changes from the original proposal.
2019-01-28 21:07:00 -07:00
bf2b6e6daa
remove references to presence lists
2019-01-28 15:05:10 +00:00
84a4ca62c3
Merge pull request #1786 from matrix-org/travis/spec/exp-caps
...
Add support for unstable feature advertising via /versions
2019-01-23 19:15:50 -07:00
052d68d83d
Merge pull request #1791 from matrix-org/travis/spec/rver-upgrades
...
Add room version upgrades
2019-01-23 19:04:24 -07:00
413bfaeb68
Add clarification that clients shouldn't use unstable things as stable
2019-01-23 19:03:14 -07:00
f5fa7e5924
Change wording to encourage servers to make reasonable decisions
2019-01-17 14:05:30 -07:00
aeb524ef89
Remove CAS login and reference it against r0.4.0
...
The SSO module should cover what CAS provides, and r0.4.0 is good as a reference for how CAS could be implemented without us repeating it here.
2019-01-16 16:13:53 -07:00
6e8739c989
Fix typo
...
Co-Authored-By: turt2live <travpc@gmail.com>
2019-01-11 08:15:08 -07:00
5cbfafaab7
Fix link to module
2019-01-09 17:17:50 -07:00
b85f7bb248
Add room version upgrades
...
Implements https://github.com/matrix-org/matrix-doc/issues/1501
2019-01-09 17:02:09 -07:00
0eabf108d9
Add a mechanism for redirecting clients after login
...
Implements https://github.com/matrix-org/matrix-doc/pull/1730
2019-01-09 15:05:27 -07:00
3e7a5f5ea4
Initial draft for SSO support
2019-01-09 00:09:38 -07:00
ccc1cdaead
Add support for unstable feature advertising via /versions
...
Incorporates https://github.com/matrix-org/matrix-doc/issues/1497
2019-01-07 14:38:21 -07:00
8f1291a3e7
Merge pull request #1758 from QMatrixClient/kitsune/lazy-loading
...
Spec lazy_load_members and include_redundant_members
2018-12-24 10:29:36 +01:00
8c80669d7a
Add the paragraph for sync.yaml forgotten in the previous commit
2018-12-23 18:58:44 +09:00
1639f27ec5
Describe the actual implication of omitting contains_url
...
Closes #1750
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
2018-12-12 17:07:06 +09:00
6d0def8b4c
Spec lazy_load_members and include_redundant_members
...
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
2018-12-11 19:04:15 +09:00
6782b6399f
Update according to the comments
2018-11-23 17:54:00 +09:00
96d7eed1c6
joining.yaml: add missing response schema details
2018-11-17 19:21:08 +09:00
818b48cbbb
make_leave returns an `event` field too
2018-10-03 14:41:40 +01:00
e17dd12007
make_join returns its event under an `event` key
2018-10-03 14:34:47 +01:00
6dab4b28f8
Merge pull request #1648 from matrix-org/matthew/device_list_update
...
document device list synchronisation over federation.
2018-09-03 16:54:36 +01:00
192a6c2ab9
Use example.org on examples instead of domain.com which is a real domain
...
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
2018-09-02 17:58:21 +03:00
ee5e519885
device list is 2 words
2018-09-02 13:05:15 +01:00
928fc5cbe5
incorporate review
2018-09-01 03:08:53 +01:00
43f2819702
switch to travis' example
2018-09-01 03:06:15 +01:00
49f0a06238
experiment with additionalProperties some more
2018-09-01 03:03:51 +01:00
f6326030ba
backtick asterisk
2018-09-01 03:02:46 +01:00
7430c3b56f
experiment with additionalProperties
2018-09-01 03:01:41 +01:00
337041610f
one slash?
2018-09-01 02:53:15 +01:00
b8608495e9
periods
2018-09-01 02:51:24 +01:00
a842e0433d
try escaping the asterisk
2018-09-01 02:50:32 +01:00
42b11e096f
Review
2018-09-01 02:48:37 +01:00
db302b66ca
revert example which was corect first time; fix rst
2018-09-01 02:44:53 +01:00
2c0b45fd14
fix example?
2018-09-01 02:41:53 +01:00
0f9a23c471
swaggerify to-device
2018-09-01 02:37:31 +01:00
0ee2cf6286
fix device_list_update example hopefully
2018-09-01 02:14:36 +01:00
0afdcc59ea
spell out stream_id and fix todo
2018-09-01 02:10:45 +01:00
d377bedd76
fix path
2018-09-01 01:54:13 +01:00
30d56691b1
document device list synchronisation over federation.
...
untested
closes MSC1212
2018-09-01 01:48:02 +01:00
00578547c0
Merge pull request #1644 from matrix-org/rav/is_token_grammar
...
Spec grammars for IS things
2018-08-31 16:05:23 -06:00
79974b152c
s/identity service/identity server
2018-08-31 22:44:36 +01:00
2af09655ce
Fix the stragglers
2018-08-31 15:44:23 -06:00
21f8898cd8
Merge remote-tracking branch 'origin/master' into rav/is_token_grammar
2018-08-31 22:38:04 +01:00
a544b68298
Merge branch 'master' into rav/is_token_grammar
2018-08-31 22:37:04 +01:00
7d34995ece
It's actually an "identity server implementing the Identity Service API"
...
Also add a note about appservices being special.
2018-08-31 15:35:32 -06:00
7ac76fa27c
Actually we're going with "identity server" afterall
2018-08-31 15:04:00 -06:00
ec248b436f
Identity Service is lowercase
2018-08-31 15:04:00 -06:00
cc0badaaa1
Fix all naming cases of "identity service"
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1396
Includes some "homeserver" fixes too. This commit does not include historical documentation or notes.
2018-08-31 15:04:00 -06:00
683072e624
Merge pull request #1636 from turt2live/travis/c2s/id-server
...
Clean up and flesh out all three editions of the /requestToken API
2018-08-31 14:57:17 -06:00
a1f655e5be
Fix more error wording
2018-08-31 14:53:59 -06:00
1261da209d
Fix wording for the homeserver not allowing a particular 3pid
2018-08-31 14:38:22 -06:00
cb1e687196
spec the format of an IS invite token
2018-08-31 21:16:32 +01:00
69c30ef156
spec the format of a client_secret
2018-08-31 21:11:11 +01:00
dced3d5707
Notes on the format of IS session IDs and tokens
2018-08-31 21:06:51 +01:00
824ce22caa
Add additional clarity to the requestToken errors
2018-08-31 11:41:46 -06:00
5bb7eca8e8
English
2018-08-31 11:37:37 -06:00
60dd9231e0
Don't explain how the IS might accept a 3pid
...
The IS is bound to it's own set of specifications, and if the client chose this API then they should be aware of the risks but not necessarily arbitrary alternatives.
2018-08-31 11:26:28 -06:00
63fdd72f73
Fix error description on /account/3pid/email/requestToken
2018-08-31 11:24:35 -06:00
f6d9e53f5c
Clarify that homeserver must reject clients from setting m.fully_read
2018-08-31 11:13:32 -06:00
679ddabb53
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/read-markers
2018-08-31 10:34:19 -06:00
a4c2b2b905
General clarity and spelling for the requestToken APIs
2018-08-31 10:32:30 -06:00
7f1b94c211
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/id-server
2018-08-31 10:29:09 -06:00
e3ad253dca
A sender is also required for the invite_state
2018-08-31 09:44:29 -06:00
2f824df8dd
Define the real event types on the invite_state
2018-08-31 09:43:29 -06:00
2e3e189ea2
Merge remote matrix-org/master
2018-08-31 09:31:39 -06:00
38ae166e9d
Merge pull request #1505 from turt2live/travis/general/3pid_invite
...
Clarify how third party invites work
2018-08-31 08:38:40 -06:00
Travis Ralston