wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
5313 commits 4 branches 0 tags 17 MiB
Commit graph

1206 commits

Author SHA1 Message Date
Travis Ralston
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
Travis Ralston
32ac81c588 Spelling 2018-08-27 17:41:27 -06:00
Travis Ralston
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
Travis Ralston
8069981252 Add federation /user/* endpoints 
Fixes https://github.com/matrix-org/matrix-doc/issues/1438
 2018-08-27 14:19:10 -06:00
Travis Ralston
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
Travis Ralston
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
Travis Ralston
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
Travis Ralston
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
Travis Ralston
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
Travis Ralston
1cbcaba2c7 Clean up examples in filter.yaml 
Indentation, excess examples.
 2018-08-26 21:21:27 -06:00
Travis Ralston
26a7a341f0 Mark the filter_id in the response of POST /filter as required 2018-08-26 21:21:02 -06:00
Travis Ralston
97e3dd443b Update room_event_filter.yaml to use the OpenAPI allOf definition 
This is just maintenance.
 2018-08-26 21:20:01 -06:00
Travis Ralston
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
Travis Ralston
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
Travis Ralston
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
Travis Ralston
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
Kitsune Ral
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
Travis Ralston
dafea96621 Fix indentation and schema references in the identity service spec 2018-08-24 15:53:27 -06:00
Travis Ralston
4abd618147 Flag response fields in the Identity Service spec as required 2018-08-24 15:53:00 -06:00
Travis Ralston
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
Travis Ralston
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
Travis Ralston
9eda1a6971 Move the third party network API to it's own section 2018-08-24 10:22:19 -06:00
Travis Ralston
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
Travis Ralston
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
Travis Ralston
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
Travis Ralston
3869f68a5c Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions 2018-08-21 12:22:35 -06:00
Travis Ralston
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
Travis Ralston
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
Travis Ralston
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
Travis Ralston
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
Travis Ralston
7e5160c7c2 Merge remote-tracking branch 'matrix-org/master' into travis/as/user-alias-query 2018-08-20 12:37:05 -06:00
Travis Ralston
a320c58e42 A path parameter is obviously URL encoded 2018-08-20 12:36:26 -06:00
Travis Ralston
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
Travis Ralston
8dc6f092ef Define the type of the power_level_content_override field 2018-08-20 12:27:29 -06:00
Travis Ralston
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
Travis Ralston
1fd7c99461 Clarify that the creation event can have other keys in it 2018-08-20 12:21:55 -06:00
Travis Ralston
6c7a93d2f5 Move description about which preset to use when none is specified 2018-08-20 12:21:43 -06:00
Travis Ralston
7d14309b63 Move the power level event schema to where it was 2018-08-20 12:21:19 -06:00
Travis Ralston
c8ba2e098c Wording improvements for appservices 2018-08-20 12:09:17 -06:00
Travis Ralston
8b65da1cf6 Don't try and be fancy about titles 2018-08-20 11:07:10 -06:00
Travis Ralston
e712466dca Improve description for currently_active 2018-08-20 10:44:28 -06:00
Valentin Deniaud
10c3307427 document device_one_time_keys_count in /sync/ response 
fix #1157
 2018-08-18 11:41:45 +02:00
Valentin Deniaud
8afc82c14b fix /keys/claim request example 
It didn't correspond to the example response.
 2018-08-18 11:41:45 +02:00
Valentin Deniaud
ab3272045e add missing v1 to m.olm in /keys/upload 2018-08-18 11:41:45 +02:00
Travis Ralston
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
Travis Ralston
069a2f7481 Split the query user and room APIs out to their own files 2018-08-17 15:22:06 -06:00
Travis Ralston
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
Travis Ralston
a4015d5c27 Spelling 2018-08-17 10:58:20 -06:00
Travis Ralston
750d4f9fda Rename the presence EDU files to be accurate to their types; Misc cleanup of titles 2018-08-17 10:53:47 -06:00
Hubert Chathi
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