Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-29 20:18:37 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
3339 commits 30 branches 42 tags 32 MiB
Commit graph

862 commits

Author SHA1 Message Date
Travis Ralston 9527ce31f5
Merge pull request #1570 from turt2live/travis/c2s/sync-filtering 
Update filtering API documentation
 2018-08-27 18:51:00 -06:00
Travis Ralston f01cfa2c7b Add security definitions to hs->as endpoints 2018-08-27 18:04:14 -06:00
Travis Ralston 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
Travis Ralston 51193cac39 Merge remote-tracking branch 'matrix-org/master' into travis/as/normal-events 2018-08-27 17:53:32 -06:00
Travis Ralston 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
Travis Ralston 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
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
Travis Ralston ebca4c7d86 Merge remote-tracking branch 'matrix-org/master' into travis/s2s/presence 2018-08-17 09:53:57 -06:00
Travis Ralston 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
Travis Ralston 3de50cbc7f Clarify how /isvalid is meant to always be truthful 2018-08-17 09:49:09 -06:00
Travis Ralston c492fe43b5 Add strict typing to the m.receipt EDU; Fix description of event_ids 2018-08-17 09:46:31 -06:00
Travis Ralston 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
Travis Ralston 96896fe5d6 Add a strict type the m.typing EDU 2018-08-17 09:34:50 -06:00
Travis Ralston a53fa9300d Merge remote-tracking branch 'matrix-org/master' into travis/s2s/presence 2018-08-17 09:34:16 -06:00
Travis Ralston 766402a702 Use strict types for the presence EDUs 2018-08-17 09:34:08 -06:00
Travis Ralston 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
Travis Ralston e7aed3da26 Remove poll/unpoll from presence 2018-08-17 09:16:39 -06:00
Travis Ralston 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
Travis Ralston 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
Travis Ralston 5b30d33b89
Simpler language 2018-08-17 02:51:41 -06:00
Travis Ralston c891e4a957 Require the push gateway URL to be of a specific path 2018-08-16 12:39:47 -06:00
Travis Ralston 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
Travis Ralston 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)
* Power level content overrides:
  * 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
Travis Ralston 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
Travis Ralston de961fb7d6 Improve wording on push gateways 2018-08-15 11:59:58 -06:00
Hubert Chathi 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
Hubert Chathi 6a3cf10be9 Merge remote-tracking branch 'origin/master' into well-known 2018-08-14 17:00:56 -04:00
Travis Ralston 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
Travis Ralston a556e33eb9 Spec /3pid/onbind 
Fixes https://github.com/matrix-org/matrix-doc/issues/1422
 2018-08-13 16:59:36 -06:00
Travis Ralston 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
Kitsune Ral b41eb26124 Document OpenAPI extension 
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
 2018-08-12 16:52:07 +09:00
Hubert Chathi cd4fed509c
convert IS endpoints to Swagger (#1427) 2018-08-10 16:21:06 -04:00
Hubert Chathi 292d334509
document new login identifier object (#1390) 2018-08-10 16:19:17 -04:00
Travis Ralston 25c77ab2d0 Define authorization requirements on federation swagger APIs 2018-08-09 08:37:35 -06:00
Travis Ralston 56dbeeb22a
Merge pull request #1469 from turt2live/travis/s2s/backfill 
Improve documentation for backfilling rooms
 2018-08-09 08:00:43 -06:00
Travis Ralston 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
Travis Ralston 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
Travis Ralston e03bfbc47b Document how read receipts work over federation 
Federation format: d69decd5c7/synapse/handlers/receipts.py (L153-L166)

Population of the fields that the above uses to construct the EDU: d69decd5c7/synapse/handlers/receipts.py (L48-L56)
 2018-08-08 08:27:22 -06:00
Travis Ralston 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
Travis Ralston 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
Travis Ralston 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
Travis Ralston 57eeddd849 Remove unused origin and destination on EDUs 2018-08-08 07:43:22 -06:00
Travis Ralston 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
Travis Ralston 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
Travis Ralston cfdbee5fc2 EDU origin and destinations aren't required 2018-08-07 14:21:01 -06:00
Travis Ralston 7ada91787a age_ts isn't real 2018-08-07 14:20:46 -06:00
Travis Ralston 521dcdd5d5 Merge remote-tracking branch 'matrix-org/master' into travis/s2s/backfill 2018-08-07 08:54:25 -06:00
Travis Ralston 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
Travis Ralston 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
Travis Ralston 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
Travis Ralston ef9d766dc3 Remove irrelevant TODO 
We fixed the EDU, so we don't need this comment.
 2018-08-03 14:51:46 -06:00