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
069a2f7481
Split the query user and room APIs out to their own files
2018-08-17 15:22:06 -06:00
5b5b4cfbed
Explicitly say how appservices should detect state events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1014
2018-08-17 13:38:38 -06:00
a4015d5c27
Spelling
2018-08-17 10:58:20 -06:00
750d4f9fda
Rename the presence EDU files to be accurate to their types; Misc cleanup of titles
2018-08-17 10:53:47 -06:00
f5dc0eaed2
document msisdn-related endpoints in IS ( #1507 )
...
* add msisdn endpoints in Identity Server spec
* add in CS endpoints that use the IS msisdn endpoints
2018-08-17 12:00:13 -04:00
ebca4c7d86
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/presence
2018-08-17 09:53:57 -06:00
21dc6f823a
Merge pull request #1484 from turt2live/travis/s2s/read-receipts
...
Document how read receipts work over federation
2018-08-17 09:50:40 -06:00
3de50cbc7f
Clarify how /isvalid is meant to always be truthful
2018-08-17 09:49:09 -06:00
c492fe43b5
Add strict typing to the m.receipt EDU; Fix description of event_ids
2018-08-17 09:46:31 -06:00
8ac6cea58b
Merge pull request #1522 from turt2live/travis/c2s/http-push-gw-required-path
...
Require the push gateway URL to be of a specific path
2018-08-17 09:42:17 -06:00
96896fe5d6
Add a strict type the m.typing EDU
2018-08-17 09:34:50 -06:00
a53fa9300d
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/presence
2018-08-17 09:34:16 -06:00
766402a702
Use strict types for the presence EDUs
2018-08-17 09:34:08 -06:00
549a25cad9
Add a mention about how currently_active works
...
Reference: d69decd5c7/synapse/handlers/presence.py (L66-L68)
2018-08-17 09:33:40 -06:00
e7aed3da26
Remove poll/unpoll from presence
2018-08-17 09:16:39 -06:00
49ec0a36a8
Merge pull request #1481 from turt2live/travis/s2s/authentication
...
Define authorization requirements on federation swagger APIs
2018-08-17 09:01:39 -06:00
4b9922b641
Merge pull request #1494 from turt2live/travis/general/openid
...
Document OpenID in the client-server and server-server APIs
2018-08-17 08:57:33 -06:00
5b30d33b89
Simpler language
2018-08-17 02:51:41 -06:00
c891e4a957
Require the push gateway URL to be of a specific path
2018-08-16 12:39:47 -06:00
2aa0e7b00f
Merge pull request #1483 from turt2live/travis/s2s/typing
...
Document how typing notifications work over federation
2018-08-16 10:09:21 -06:00
45c68e323a
Add general clarity to the /createRoom endpoint
...
This commit does a number of things:
* Minor formatting/alignment changes
* Document the room_alias response key. This could be deprecated now, or forfeited, if needed.
* Remove the guest_can_join parameter - it is not actually supported
* Document the previously undocumented power_level_content_override parameter
* Clarify that the room_id is required on the response
* More clearly spell out which events are created as part of the request
* Clarify how the room alias becomes the canonical alias
* Clarify how the `visibility` may be used to determine a default preset to apply
* Document the `m.federate` creation content parameter, adding an option for the homeserver to define a default value
References:
* Preset being inferred by the visibility: cd32c19a60/synapse/handlers/room.py (L172-L177)https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L198
* https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L335-L359
* Aliases becoming canonical: https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L366-L370
* `m.federate` landing in the create event: https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L311-L315
Fixes https://github.com/matrix-org/matrix-doc/issues/1243
Fixes https://github.com/matrix-org/matrix-doc/issues/1471
Inspired by https://github.com/matrix-org/matrix-doc/issues/1213
2018-08-15 17:25:30 -06:00
fde48e7ee8
Specify how room versioning works
...
This is the spec PR for https://github.com/matrix-org/matrix-doc/issues/1425
Room version upgrades are not part of MSC1425.
Documented aspects:
* room_version on the create event
* creating a room with a specific version (useful for testing)
* make_join behaviour
* error code documentation
* grammar of room versions
Based upon https://docs.google.com/document/d/1urKgReoHqxX8R_XtySB17dPi-DZcKhqTEL2_s895Wz0/edit
2018-08-15 15:12:36 -06:00
de961fb7d6
Improve wording on push gateways
2018-08-15 11:59:58 -06:00
fcca80dad8
various minor fixes
...
- formatting fixes
- add examples to homeserver/identity server discovery schema
- replace DNS name with hostname
2018-08-14 17:58:57 -04:00
6a3cf10be9
Merge remote-tracking branch 'origin/master' into well-known
2018-08-14 17:00:56 -04:00
6ad71f785e
Improve documentation for pushers and push gateways
...
This fixes a number of formatting issues alongside a few documentation problems:
* The push gateway can actually expect less parameters than previously advertised. This is for user privacy.
* Introduction of the `m.email` pusher for email-capable homeservers.
* Fields not being flagged as required on some endpoints.
* Document the `event_id_only` format
Note: this does not attempt to document push rules, just pushers.
Fixes https://github.com/matrix-org/matrix-doc/issues/1374
Fixes https://github.com/matrix-org/matrix-doc/issues/1087
2018-08-14 12:51:50 -06:00
a556e33eb9
Spec /3pid/onbind
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1422
2018-08-13 16:59:36 -06:00
88b35d1be5
Clarify how third party invites work
...
This adds several diagrams to the Client-Server API about how invites
are handled, including what the server is expected to do. This helps
implementors know what they are supposed to do in the common cases,
and infer where needed to get the more complex cases correct.
Although lacking in some areas, this is how third party invites work
today.
A link to the now-improved client-server documentation for third party
invites has been added to the server-server specification. The existing
server-server specification needed no further changes on the subject.
Fixes https://github.com/matrix-org/matrix-doc/issues/1366
2018-08-13 16:29:50 -06:00
b41eb26124
Document OpenAPI extension
...
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
2018-08-12 16:52:07 +09:00
cd4fed509c
convert IS endpoints to Swagger ( #1427 )
2018-08-10 16:21:06 -04:00
292d334509
document new login identifier object ( #1390 )
2018-08-10 16:19:17 -04:00
25c77ab2d0
Define authorization requirements on federation swagger APIs
2018-08-09 08:37:35 -06:00
56dbeeb22a
Merge pull request #1469 from turt2live/travis/s2s/backfill
...
Improve documentation for backfilling rooms
2018-08-09 08:00:43 -06:00
721be47eb1
Describe how get_missing_events actually works
...
The original text wasn't far off, except for being wrong about what the fields actually do. This commit also adds a bit of clarity for how the server is expected to behave.
2018-08-08 08:39:59 -06:00
0a7e670715
Document how typing notifications work over federation
...
Relevant synapse code: d69decd5c7/synapse/handlers/typing.py (L221-L230)
2018-08-08 08:28:52 -06:00
e03bfbc47b
Document how read receipts work over federation
...
Federation format: d69decd5c7/synapse/handlers/receipts.py (L153-L166)d69decd5c7/synapse/handlers/receipts.py (L48-L56)
2018-08-08 08:27:22 -06:00
05a2427c73
Document how presence EDUs work between servers
...
It's worth noting that Synapse does not make use of the `poll` or `unpoll` fields, and therefore the wording has been updated to permit servers to reject users. In the case of synapse, it would automatically reject everyone in the list by nature of ignoring it.
2018-08-08 08:24:09 -06:00
a77975ba68
Merge pull request #1450 from turt2live/travis/s2s/inviting-rooms
...
Improve documentation for how non-third party invites work
2018-08-08 08:19:50 -06:00
0f8954d839
Merge pull request #1463 from turt2live/travis/s2s/pdus-and-edus
...
Improve documentation around EDUs and PDUs
2018-08-08 08:02:37 -06:00
57eeddd849
Remove unused origin and destination on EDUs
2018-08-08 07:43:22 -06:00
dcae88c290
Document OpenID in the server-server API
...
Part of https://github.com/matrix-org/matrix-doc/issues/857
Reference: d69decd5c7/synapse/federation/transport/server.py (L543-L557)
2018-08-07 22:13:21 -06:00
8ffac01efe
Document OpenID in the client-server API
...
Part of https://github.com/matrix-org/matrix-doc/issues/857
Reference: d69decd5c7/synapse/rest/client/v2_alpha/openid.py (L31-L58)
2018-08-07 22:10:11 -06:00
cfdbee5fc2
EDU origin and destinations aren't required
2018-08-07 14:21:01 -06:00
7ada91787a
age_ts isn't real
2018-08-07 14:20:46 -06:00
521dcdd5d5
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/backfill
2018-08-07 08:54:25 -06:00
35f15ba3d8
Merge pull request #1477 from turt2live/travis/s2s/public-rooms
...
Document the /publicRooms endpoint for federation
2018-08-07 08:31:10 -06:00
8724ed99ad
Merge pull request #1480 from turt2live/travis/s2s/swagger-consumes-json
...
Specify which federation swagger APIs consume JSON
2018-08-07 08:30:34 -06:00
e10770ae8b
Merge pull request #1475 from turt2live/travis/s2s/event-auth
...
Document /event_auth and /query_auth
2018-08-07 08:30:22 -06:00
ef9d766dc3
Remove irrelevant TODO
...
We fixed the EDU, so we don't need this comment.
2018-08-03 14:51:46 -06:00
2e6d6e2790
Specify which swagger APIs consume JSON
2018-08-03 14:01:33 -06:00
8dd63388e0
invites consume JSON
2018-08-03 13:58:27 -06:00
13a2b54bf9
query_auth consumes JSON
2018-08-03 13:57:43 -06:00
6ac25d167c
get_missing_events consumes JSON
2018-08-03 13:57:13 -06:00
2ac80d38d7
Document the /publicRooms endpoint for federation
...
This intentionally doesn't document the third party network aspect of the endpoint. This is scheduled for a later area for dealing with third party network/IDs and is reported as https://github.com/matrix-org/matrix-doc/issues/1476
The client-server response has been broken out to a shared file: both the client-server and server-server /publicRoom endpoints return the same thing, with slightly different inputs.
The inputs (and behaviour) are based upon the docstring here: 43ecfe0b10/synapse/federation/transport/server.py (L583-L612)
2018-08-03 11:23:44 -06:00
73958ecbff
Document /event_auth and /query_auth
...
/event_auth is a fairly easy endpoint to determine the use case of. /query_auth is a little harder to investigate and has a fairly interesting purpose: it appears to be used for the sending server to admit defeat and shop around for the right auth chain, correcting it's own perspective as it goes.
/query_auth is based off the following research points in synapse:
* 43ecfe0b10/synapse/handlers/federation.py (L1947-L1990)43ecfe0b10/synapse/handlers/federation.py (L2049-L2187)43ecfe0b10/synapse/handlers/federation.py (L1716-L1761)43ecfe0b10/synapse/federation/federation_server.py (L393-L446)https://github.com/matrix-org/synapse/blob/master/synapse/federation/transport/server.py#L482-L487
2018-08-03 09:27:19 -06:00
6b67d501e4
Merge branch 'master' into travis/s2s/query
2018-08-03 08:55:21 -06:00
3a9fb11c9b
Merge branch 'master' into travis/s2s/backfill
2018-08-03 08:54:40 -06:00
1578da453b
Merge branch 'master' into travis/s2s/get-event
2018-08-03 08:01:43 -06:00
86d7f42173
Merge pull request #1455 from turt2live/travis/s2s/leaving-rooms
...
Document how leaving rooms/rejecting invites over federation works
2018-08-03 08:00:56 -06:00
d48f1e1713
Merge pull request #1461 from turt2live/travis/s2s/transactions
...
Improve documentation on how Transactions work
2018-08-03 07:38:45 -06:00
cda88f3b3d
Document /get_missing_events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1385
2018-08-02 23:18:08 -06:00
e766606f24
join -> leave
2018-08-02 18:54:12 -06:00
0b313dbdd9
Don't explain what a 400 Bad Request is
2018-08-02 18:47:17 -06:00
05bb7e1050
Spelling and word choice
2018-08-02 18:45:59 -06:00
53d4003d3a
manual merge of master into travis/s2s/query
2018-08-02 16:48:32 -06:00
48972addbf
Merge pull request #1428 from turt2live/travis/s2s/joining-rooms
...
Improve the documentation for joining rooms
2018-08-02 16:44:31 -06:00
5596243add
origin is required
2018-08-02 16:43:24 -06:00
8b7bc60367
list -> array
2018-08-02 16:42:03 -06:00
9d474bb819
Document event retrieval endpoints in more detail
...
This also adds a previously-undocumented endpoint: /state_ids
Backfill is technically not part of this section, however it is being left untouched to make the merge with #1469 easier (which moves it out of the file).
Reference material:
* Some calls to synapse on these endpoints with a relatively simple private room.
2018-08-02 12:44:54 -06:00
4b1955f395
Clarify what the auth_events on a PDU are
2018-08-02 12:06:43 -06:00
5aef545128
Improve documentation for backfilling rooms
...
There's not a whole lot to improve here - most of the changes are about reorganization and minor clarifications.
2018-08-01 13:31:23 -06:00
b96ee3e393
Merge pull request #1423 from turt2live/travis/s2s/keys
...
Improve the server key exchange portion of the s2s specification
2018-08-01 07:44:57 -06:00
54a88eebf0
Merge pull request #1414 from matrix-org/anoa/third_party_cleanup
...
Clarification on third party fields
2018-08-01 01:38:01 -07:00
d0e8df8f3f
prev_content is an object
2018-07-31 14:02:04 -06:00
5027a9a59a
Improve documentation around EDUs and PDUs
...
Clarify fields, improve examples, and make the tables in the spec be generated rather than duplicated.
2018-07-31 13:58:23 -06:00
f5af4d2fb5
Merge pull request #1457 from matrix-org/dbkr/fix_room_tags
...
Fix room tags spec
2018-07-30 17:06:54 -06:00
7679b4f1d1
Improve documentation on how Transactions work
...
The response is based upon various sections of the Synapse code in how it generates a response.
There are no new fields added to the transaction. Originally, `previous_ids` and `pdu_failures` were to be documented however neither of these are used in the real world.
2018-07-30 16:58:13 -06:00
5f8967c074
Move TODO. field1, field2... -> fields...
2018-07-30 19:21:54 +01:00
a2e2ced03b
Add reverse-lookup examples.
2018-07-30 11:12:05 +01:00
d785ac78a3
Remove explode and replace with TODO, require auth on CS
2018-07-30 11:12:05 +01:00
53137a3c53
c/p bug, fix operationIds, move rst docs to md
2018-07-30 11:09:50 +01:00
3e4962f211
Document standardized extensions to OpenAPI v2
2018-07-30 11:09:50 +01:00
273acb277c
Change fields to use new extended query array syntax
2018-07-30 11:09:50 +01:00
0ff882fb3b
Field definitions for protocol metadata
2018-07-30 11:09:50 +01:00
346db48588
Revert giving get() a default
...
As per the PR review.
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
2018-07-29 14:04:07 +09:00
c6bfac41c5
Bypass jsonschema references resolver
...
jsonschema's resolver doesn't work with local files on Windows.
resolve_references only works with the local files (on Windows as well)
but that's exactly what's needed for the case (as long as we don't have
remote references, that is).
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
2018-07-29 12:40:19 +09:00
d17ec7f184
Check that path starts with file://, not file:///
...
Because file:/// is not a thing on Windows.
2018-07-29 12:40:18 +09:00
2c9f00d37a
Follow PEP 8
2018-07-29 12:40:17 +09:00
31687608dc
Factor out common code
2018-07-29 12:40:16 +09:00
73b0a03b9b
Remove more padding
2018-07-27 08:39:15 -06:00
5ddf5374db
Missing comma
2018-07-27 12:24:29 +01:00
e4fd088fcc
Fix room tags spec
2018-07-27 12:05:30 +01:00
cafd1a9ab3
Use more modern timestamps
2018-07-26 16:46:33 -06:00
e27f4a69a0
Key versions must be [0-9a-zA-Z_]
2018-07-26 16:46:13 -06:00
bdccfca726
Timestamps should be in milliseconds
2018-07-26 16:43:43 -06:00
cad1db2a14
Unpadded means unpadded
2018-07-26 16:43:16 -06:00
9dbb627d7b
Undo accidental changes to the operation ID
2018-07-26 16:42:40 -06:00
2f71703427
Deprecate key ID querying
2018-07-26 16:42:21 -06:00
9fdd8a6f96
Document how leaving rooms/rejecting invites over federation works
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1401
This is very similar to the joining rooms handshake, and much of it is a near copy/paste of the make_join and send_join API. The major difference is the send_leave API doesn't return anything.
References:
* Handling of make_leave: d69decd5c7/synapse/handlers/federation.py (L1285-L1310)d69decd5c7/synapse/federation/transport/client.py (L267)d69decd5c7/synapse/federation/transport/server.py (L396)d69decd5c7/synapse/handlers/federation.py (L1346)
2018-07-26 14:59:43 -06:00
fcaa299f81
Include information on how invite_room_state works
...
This is completely optional, and the events included are up to the sender.
Sources:
* Structure: d69decd5c7/synapse/handlers/message.py (L896-L904)d69decd5c7/synapse/config/api.py (L30-L40)
2018-07-26 08:44:10 -06:00
Kitsune Ral