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
afa16f1e4e
Merge pull request #1606 from turt2live/travis/c2s/room-tags
...
Update the room tagging documentation
2018-08-31 08:36:40 -06:00
73736d41db
Merge pull request #1569 from turt2live/travis/c2s/user-directory
...
Clarify the homeserver's behaviour for user searching
2018-08-31 08:32:02 -06:00
4bd23a9086
send_attempt is no longer optional
2018-08-30 22:28:50 -06:00
7f719b23e7
Merge pull request #1589 from turt2live/travis/c2s/inhibit-login
...
Document the inhibit_login registration option
2018-08-30 18:21:39 -06:00
dfaed5b525
Clean up and flesh out all three editions of the /requestToken API
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1634
Addresses some of https://github.com/matrix-org/matrix-doc/issues/1396
2018-08-30 18:18:08 -06:00
ce14779af1
Merge pull request #1567 from turt2live/travis/c2s/3pid-binding
...
Document `validated_at`, `added_at`, and POST /3pid/delete
2018-08-30 16:33:24 -06:00
5da3072eef
Wording change ('may not' has a special meaning)
2018-08-30 16:32:14 -06:00
2a08a308f3
device_keys are required
2018-08-30 16:29:24 -06:00
219b27b182
Merge remote matrix-org/master
2018-08-30 16:27:20 -06:00
f923d08078
Add read markers
...
This is the spec for https://github.com/matrix-org/matrix-doc/issues/910
Fixes https://github.com/matrix-org/matrix-doc/issues/910
Some reverse engineering was required to work out the complete details as to how this works. In particular, the 405 for setting account data and the behaviour of m.read.
References:
* 405 for account data: d69decd5c7/synapse/rest/client/v2_alpha/account_data.py (L85-L90)d69decd5c7/synapse/rest/client/v2_alpha/read_marker.py (L45-L52)
2018-08-30 16:21:31 -06:00
0f84c69805
Merge branch 'master' into rav/clarify_event_signing
2018-08-30 22:48:56 +01:00
8bcd7d26e3
/3pid/delete returns an empty object
2018-08-30 15:28:43 -06:00
390f1c16f7
Remove mentions of identity services from /3pid/delete
...
This will be covered by https://github.com/matrix-org/matrix-doc/issues/1194
For now, we can accept that homeservers may try to unbind, however clients should not rely on it.
2018-08-30 15:27:36 -06:00
86c85aea71
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/3pid-binding
2018-08-30 15:23:50 -06:00
d57b977a55
Merge branch 'm-master' into travis/general/3pid_invite
2018-08-30 15:01:31 -06:00
e82c22b060
Merge pull request #1615 from turt2live/travis/is/touchups
...
Touch up more of the identity service specification
2018-08-30 12:23:25 -06:00
f09db16027
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/key-mgmt
2018-08-30 12:19:59 -06:00
49c5677969
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/user-directory
2018-08-30 12:18:35 -06:00
f04afaa9b9
Merge pull request #780 from mujx/missing-enum-fields
...
Add missing enum fields for the set_presence parameter
2018-08-30 11:37:34 -06:00
cc1e496287
Merge pull request #1629 from turt2live/travis/as/route-versions
...
Version all appservice endpoints and provide a fallback
2018-08-30 11:11:25 -06:00
0f2e01f5b5
Merge pull request #1555 from turt2live/travis/as/cleanup
...
Application service spec cleanup; Security definitions; r0 prep
2018-08-30 11:08:10 -06:00
be5c566028
Version all appservice endpoints and provide a fallback
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1616
2018-08-30 11:03:42 -06:00
6b52e1df77
Merge pull request #1587 from turt2live/travis/s2s/clarify-state-ids-inclusion
...
Clarify that the requested event is excluded from /state and /state_ids
2018-08-30 07:44:27 -06:00
55c4307f12
Rewrite the section on signing events
...
... for clarity and de-duplication. And to say a bit about validating the
signatures.
2018-08-30 14:37:24 +01:00
7ecf2406eb
Merge pull request #1590 from turt2live/travis/c2s/403-put-state
...
Document 403 error for sending state events
2018-08-30 06:50:48 -06:00
a5c3924492
Merge remote matrix-org/master
2018-08-29 21:28:24 -06:00
f030d19f3c
Clean up identity service swagger
...
* Add `consumes` (swagger)
* Remove `http` as a supported scheme (the spec specifically says clients MUST use https)
* Clarify various descriptions
* Full stops
* Additional wording
* s/older versions/previous drafts - we haven't had a release yet
* Indentation on examples
2018-08-29 21:02:13 -06:00
684d80c422
Revert changes to 3pid lookup types in the IS spec
...
The validator doesn't know what a "3PID Medium" is, for example, so it throws exceptions. This does reduce clarity in the spec though.
2018-08-29 17:52:02 -06:00
abb91508be
Merge pull request #1556 from turt2live/travis/is/cleanup
...
Identity Service API cleanup
2018-08-29 15:16:53 -06:00
c03f2f8d79
Minor touchups to the room tagging API
...
Fixes some of https://github.com/matrix-org/matrix-doc/issues/1565
2018-08-29 14:53:55 -06:00
9bc1470305
Elaborate the structure of m.tag events
...
...and corresponding structures in tag-related CS API calls
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
2018-08-29 14:47:59 -06:00
f2d02c9559
Take out device management section for now
...
This will be handled by the implementation of https://github.com/matrix-org/matrix-doc/issues/1212
2018-08-29 14:37:30 -06:00
5ff244f06b
More clarification about how /state_ids works
2018-08-29 09:00:46 -06:00
de36d97839
Clarify which event is actually be excluded from /state_ids
2018-08-29 08:53:20 -06:00
5019fb7c49
Merge pull request #1359 from uhoreg/well-known
...
.well-known discovery
2018-08-29 10:40:54 -04:00
7327656965
Merge pull request #1581 from matrix-org/erikj/limit_txn_size
...
Specify a limit on the number of EDUs and PDUs a transaction can contain
2018-08-29 09:48:57 +01:00
d91395cf9f
Document 403 error for sending state events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1399
2018-08-28 19:33:45 -06:00
1051aff108
Document the inhibit_login registration option
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1351
2018-08-28 18:36:07 -06:00
dad037170a
Clarify that the requested event is excluded from /state and /state_ids
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1564
2018-08-28 15:45:50 -06:00
436544b8f8
Clarify behaviour of `?set_presence=unavailable` for /sync
2018-08-28 14:19:55 -06:00
adef7babfa
Merge remote-tracking branch 'matrix-org/master' into mujx/missing-enum-fields
2018-08-28 14:10:17 -06:00
ad068bcd22
Fix the appservice directory visibility type parameter type
2018-08-28 12:11:36 -06:00
e9579a7840
The `rank` in search results is actually a floating point number
...
This was accidentally changed in https://github.com/matrix-org/matrix-doc/pull/1571 and appears to be the only instance.
2018-08-28 11:01:43 -06:00
fc1fdc95af
Specify a limit on the number of EDUs and PDUs a transaction can contain
2018-08-28 17:29:58 +01:00
6cdb463829
Merge pull request #1571 from turt2live/travis/general/number-to-int
...
Replace applicable types of 'number' to 'integer'
2018-08-28 07:40:28 -06:00
f9c7014a65
Merge pull request #1577 from turt2live/travis/c2s/search-filter
...
Specify the type of filter the search API expects
2018-08-27 19:09:19 -06:00
03065b0584
Merge pull request #1572 from turt2live/travis/c2s/sync-left-account-data
...
Add `account_data` to left rooms in /sync
2018-08-27 18:59:58 -06:00
f2332d242a
Add some SHOULDs and MUSTs to the user directory requirements
2018-08-27 18:58:16 -06:00
bb515d15a4
Clarify which collation to use for user directory searching
2018-08-27 18:55:54 -06:00
9527ce31f5
Merge pull request #1570 from turt2live/travis/c2s/sync-filtering
...
Update filtering API documentation
2018-08-27 18:51:00 -06:00
f01cfa2c7b
Add security definitions to hs->as endpoints
2018-08-27 18:04:14 -06:00
17e0ef4b91
Remove empty file and now-empty section from the appservice spec
...
This commit has approval under https://github.com/matrix-org/matrix-doc/pull/1555 although is being included in this branch/PR so the build passes, permitting a merge.
2018-08-27 17:58:47 -06:00
51193cac39
Merge remote-tracking branch 'matrix-org/master' into travis/as/normal-events
2018-08-27 17:53:32 -06:00
87133d8505
Merge pull request #1574 from turt2live/travis/c2s/fix-directory-put
...
Clean up PUT /directory/room
2018-08-27 17:49:05 -06:00
a0b17e6ed6
Merge pull request #1551 from turt2live/travis/c2s/push-rules
...
General improvements to the push rules module
2018-08-27 17:48:01 -06:00
97508d5dc5
Merge pull request #1554 from turt2live/travis/general/appservice-directories
...
Application service room directories (and other third party network things)
2018-08-27 17:47:34 -06:00
32ac81c588
Spelling
2018-08-27 17:41:27 -06:00
5fa6b49365
Specify the type of filter the search API expects
...
Note: This is badly named until https://github.com/matrix-org/matrix-doc/pull/1570 lands
Fixes https://github.com/matrix-org/matrix-doc/issues/598
2018-08-27 15:56:47 -06:00
8069981252
Add federation /user/* endpoints
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1438
2018-08-27 14:19:10 -06:00
e60b44e27f
Clean up PUT /directory/room
...
Fixes https://github.com/matrix-org/matrix-doc/issues/933
The issue references two problems: a `roomInfo` and lack of a `room_id`. It appears the `room_id` has been fixed since reporting, however the `roomInfo` remained (and is now fixed).
2018-08-26 22:27:34 -06:00
55c0b968b5
Fix event schemas for /sync
...
This commit clarifies the required keys for each type of event that appears in sync, fixes the core event schema not declaring 'content' as required, and includes a mention that events may not have a room_id when appearing in /sync.
Fixes https://github.com/matrix-org/matrix-doc/issues/595
Fixes https://github.com/matrix-org/matrix-doc/issues/909
2018-08-26 22:22:36 -06:00
008ebb8c1a
Add `account_data` to left rooms in /sync
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1392
2018-08-26 21:55:30 -06:00
667fa082af
Replace applicable types of 'number' to 'integer'
...
`number` implies/represents a float where `integer` does not.
The only remaining `type: number` in the project appear on power levels: those have been left untouched pending clarification.
Fixes https://github.com/matrix-org/matrix-doc/issues/746
2018-08-26 21:32:44 -06:00
b68ed5d594
Define the default for the contains_url filter param
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1553
2018-08-26 21:21:49 -06:00
1cbcaba2c7
Clean up examples in filter.yaml
...
Indentation, excess examples.
2018-08-26 21:21:27 -06:00
26a7a341f0
Mark the filter_id in the response of POST /filter as required
2018-08-26 21:21:02 -06:00
97e3dd443b
Update room_event_filter.yaml to use the OpenAPI allOf definition
...
This is just maintenance.
2018-08-26 21:20:01 -06:00
7d08ef73d0
Fix naming of the Filter schemas
...
EventFilter !== Filter
Fixes https://github.com/matrix-org/matrix-doc/issues/1509
2018-08-26 21:19:07 -06:00
1bc0f63bfb
Clarify the homeserver's behaviour for user searching
...
The homeserver can implement its own algorithm, but is suggested to ensure the requesting user can reasonably see the other users.
The text is intentionally left vague for whether or not the API is local users only to give the homeserver some flexibility in this area.
General cleanup is also included in this commit.
Fixes https://github.com/matrix-org/matrix-doc/issues/1108
2018-08-26 21:04:02 -06:00
b4be11af42
Document POST /account/3pid/delete
...
Fixes https://github.com/matrix-org/matrix-doc/issues/985
Includes documentation for https://github.com/matrix-org/synapse/pull/3667
Raises https://github.com/matrix-org/matrix-doc/issues/1566
2018-08-26 20:41:34 -06:00
a803d9d077
Document `validated_at` and `added_at` on GET /3pid
...
Fixes https://github.com/matrix-org/matrix-doc/issues/661
2018-08-26 20:39:53 -06:00
c879eb950f
client-server/openid.yaml: Fix a type'o
...
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
2018-08-25 22:49:12 +09:00
dafea96621
Fix indentation and schema references in the identity service spec
2018-08-24 15:53:27 -06:00
4abd618147
Flag response fields in the Identity Service spec as required
2018-08-24 15:53:00 -06:00
017d6db737
Document third party network/protocol directories (for appservices)
...
Fixes https://github.com/matrix-org/matrix-doc/issues/869
2018-08-24 11:07:30 -06:00
2d43ff1234
Update third party network schemas
...
Some information was missed when this was reviewed. This commit adds some additional documentation for how these objects interact with each other.
2018-08-24 10:48:47 -06:00
9eda1a6971
Move the third party network API to it's own section
2018-08-24 10:22:19 -06:00
6a91ea9c85
Specify that application services receive events in the CSAPI format
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1269
This is also supposed to fix the 'age' problem, however that is a larger problem with the event schemas that is reserved for a future PR/commit.
Reference: https://github.com/matrix-org/matrix-doc/issues/1294
Reference: https://github.com/matrix-org/matrix-doc/issues/1524
2018-08-23 13:31:33 -06:00
bbd33c1461
Move appservice transaction API to the right section
...
Part of https://github.com/matrix-org/matrix-doc/issues/1532
2018-08-23 13:29:04 -06:00
7ec3cc4343
General improvements to the push rules module
...
This commit does a few things:
* Add 3 undocumented push rules to the spec for encrypted events and at-room notifications.
* Require unrecognized conditions to not match, ensuring that future conditions do not cause clients to accidentally notify users.
* Clarify that push rules should be enabled when created.
* Document a new condition required for at-room notifications.
Fixes https://github.com/matrix-org/matrix-doc/issues/1163
Fixes https://github.com/matrix-org/matrix-doc/issues/1034
Fixes https://github.com/matrix-org/matrix-doc/issues/676
Fixes https://github.com/matrix-org/matrix-doc/issues/1033
Relates to https://github.com/matrix-org/matrix-doc/issues/1101
2018-08-22 15:21:21 -06:00
3869f68a5c
Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions
2018-08-21 12:22:35 -06:00
6172d5986a
Merge pull request #1537 from turt2live/travis/as/user-alias-query
...
Clean up user and alias querying for application services
2018-08-21 12:14:07 -06:00
e4f5c3d55e
Merge pull request #1518 from turt2live/travis/c2s/create-room-improvements
...
Add general clarity to the /createRoom endpoint
2018-08-21 12:04:56 -06:00
1d7ea314d4
Merge pull request #1482 from turt2live/travis/s2s/presence
...
Document how presence EDUs work between servers
2018-08-21 11:26:32 -06:00
e500e2502a
Document the maximum value for depth
...
Implements the proposal for https://github.com/matrix-org/matrix-doc/issues/1230
2018-08-21 09:38:01 -06:00
7e5160c7c2
Merge remote-tracking branch 'matrix-org/master' into travis/as/user-alias-query
2018-08-20 12:37:05 -06:00
a320c58e42
A path parameter is obviously URL encoded
2018-08-20 12:36:26 -06:00
7ad22b2454
Merge pull request #1533 from turt2live/travis/as/general
...
General/small improvements to the application service API specification
2018-08-20 12:28:38 -06:00
8dc6f092ef
Define the type of the power_level_content_override field
2018-08-20 12:27:29 -06:00
7e6ca5fef8
Take out the room_alias response field
...
The argument is that this isn't really needed at this time.
2018-08-20 12:23:17 -06:00
1fd7c99461
Clarify that the creation event can have other keys in it
2018-08-20 12:21:55 -06:00
6c7a93d2f5
Move description about which preset to use when none is specified
2018-08-20 12:21:43 -06:00
7d14309b63
Move the power level event schema to where it was
2018-08-20 12:21:19 -06:00
c8ba2e098c
Wording improvements for appservices
2018-08-20 12:09:17 -06:00
8b65da1cf6
Don't try and be fancy about titles
2018-08-20 11:07:10 -06:00
e712466dca
Improve description for currently_active
2018-08-20 10:44:28 -06:00
10c3307427
document device_one_time_keys_count in /sync/ response
...
fix #1157
2018-08-18 11:41:45 +02:00
8afc82c14b
fix /keys/claim request example
...
It didn't correspond to the example response.
2018-08-18 11:41:45 +02:00
ab3272045e
add missing v1 to m.olm in /keys/upload
2018-08-18 11:41:45 +02:00
60b8e72a67
Minor text changes to the query APIs; Keep OpenMarket copyright
...
The bulk of these APIs were copied from OpenMarket's work - we should preserve the copyright header.
2018-08-17 15:45:10 -06:00
aqtusia