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

686 commits

Author SHA1 Message Date
Travis Ralston bb515d15a4 Clarify which collation to use for user directory searching 2018-08-27 18:55:54 -06:00
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 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 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 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 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 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 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
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
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 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 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 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
Hubert Chathi 292d334509
document new login identifier object (#1390) 2018-08-10 16:19:17 -04: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 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
Andrew Morgan 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
user 5f8967c074 Move TODO. field1, field2... -> fields... 2018-07-30 19:21:54 +01:00
user a2e2ced03b Add reverse-lookup examples. 2018-07-30 11:12:05 +01:00
user d785ac78a3 Remove explode and replace with TODO, require auth on CS 2018-07-30 11:12:05 +01:00
Andrew Morgan 53137a3c53 c/p bug, fix operationIds, move rst docs to md 2018-07-30 11:09:50 +01:00
Andrew Morgan 273acb277c Change fields to use new extended query array syntax 2018-07-30 11:09:50 +01:00
David Baker 5ddf5374db Missing comma 2018-07-27 12:24:29 +01:00
David Baker e4fd088fcc Fix room tags spec 2018-07-27 12:05:30 +01:00
Travis Ralston 05fb94e195 Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 2018-07-18 08:28:16 -06:00
Travis Ralston d2b0b1bbda
Merge pull request #1379 from turt2live/travis/preset-guests 
Document guest_access in /createRoom presets; Make presets a table
 2018-07-13 08:42:23 -06:00
Travis Ralston 1829589d23 Convert 3pn errors to new definition 2018-07-12 12:16:11 -06:00
Travis Ralston 197c36c520 Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 2018-07-12 12:13:07 -06:00
Travis Ralston 91c59e7384
Merge pull request #1353 from matrix-org/anoa/as_thirdparty_lookup 
Thirdparty Entity Lookup API
 2018-07-12 11:19:12 -06:00
Andrew Morgan 291a4dfc76 Third party lookup module. Fix wording 2018-07-12 16:59:30 +01:00
Travis Ralston 6e3993effe Merge remote-tracking branch 'matrix-org/master' into travis/preset-guests 2018-07-12 09:48:52 -06:00
Travis Ralston 84e07a0c10 Convert errors in presence.yaml 2018-07-12 09:31:50 -06:00
Travis Ralston 16125f16f5 Spec retry_after_ms on ratelimit errors 2018-07-12 09:28:30 -06:00
Travis Ralston 8b513b9f8e Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 2018-07-12 09:24:04 -06:00
Andrew Morgan 8999887245 Path -> query params 2018-07-12 14:44:48 +01:00
Andrew Morgan 9bde78ac28 $ref needs to be under a schema: 2018-07-12 14:41:24 +01:00
Andrew Morgan 114bcf1a2e Use $ref, clean up, fix errors, AS is now a C-S module. 2018-07-12 14:31:34 +01:00
Travis Ralston fbee83d5cf Clarify some of the properties on the search result 
Fixes https://github.com/matrix-org/matrix-doc/issues/773
 2018-07-10 15:08:28 -06:00
Travis Ralston d7a979da63 Merge remote-tracking branch 'matrix-org/master' into travis/all-the-auth 2018-07-06 11:33:24 -06:00
Travis Ralston 516000bdc3 Fix error reference in media repo 2018-07-06 08:53:04 -06:00
Travis Ralston ab75fc4b20 Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 2018-07-06 08:46:50 -06:00
Travis Ralston e7a6ff1064
Merge branch 'master' into travis/spec-reason 2018-07-06 07:02:11 -06:00
Travis Ralston 1722734a51
Merge pull request #1364 from turt2live/travis/server-name-join 
Document the server_name query parameter on /join/{roomIdOrAlias}
 2018-07-06 07:00:24 -06:00
Will Hunt ff3c379339
Merge pull request #1189 from Half-Shot/hs/upload-limits 
GET media/config 🎉
 2018-07-06 11:37:35 +00:00
Will Hunt 77f4ac54aa
Wordy intro sentence for description 2018-07-06 10:36:17 +01:00
Will Hunt 2e6cc8045c
Better indent of description 2018-07-06 10:29:05 +01:00
Will Hunt d5ce87e956
Split summary up into description and summary 2018-07-06 10:27:03 +01:00
Travis Ralston bbf63d116c Fix reference to error.yaml in forget room API 2018-07-05 16:55:11 -06:00
Travis Ralston 55c27d6212
Merge branch 'master' into travis/better-errors 2018-07-05 13:40:17 -06:00
Travis Ralston 4485b2f025
Merge branch 'master' into travis/server-name-join 2018-07-05 11:23:13 -06:00
Travis Ralston c1c1f28c79
Merge branch 'master' into travis/dont-forget-to-leave 2018-07-05 10:55:48 -06:00
Travis Ralston 3935861445
Merge pull request #1380 from turt2live/travis/define-roomevent 
Define RoomEvent on /rooms/{roomId}/messages
 2018-07-05 10:54:54 -06:00
Travis Ralston 16860ddd22 De-quote 2018-07-05 10:46:53 -06:00
Andrew Morgan 4c38012122 I can spell 2018-07-05 12:58:42 +01:00
Andrew Morgan e6218b56ab Switch properties to schema 2018-07-05 11:59:10 +01:00
Andrew Morgan a6dad76c01 Fix indentation 2018-07-05 11:56:30 +01:00
Andrew Morgan cc3724b54a fix indentation, error messages. add rest of PR 2018-07-05 11:55:25 +01:00
Kitsune Ral dfdc5f9bef search.yaml: Rename some titles to avoid confusion between request and response schemas 
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
 2018-07-04 20:11:08 -06:00
Travis Ralston 436b410698 Document the error code when someone tries to forget a room they are in 2018-07-04 20:02:30 -06:00
Travis Ralston 9b1f3a1f47 Document guest_access in /createRoom presets; Make presets a table 
Previously the presets ended up being rendered as one long string (the indentation was not respected). This was hard to read and wasn't very clear.

Now that there's a larger amount of information, it makes some sense to put it into a table. Tables don't work nicely when nested in another table, so the preset definitions have been moved into the general route description.

This commit also updates the documentation to reference `preset`, not `presets` given the param is singular.

Fixes https://github.com/matrix-org/matrix-doc/issues/881
 2018-07-04 18:16:24 -06:00
Hubert Chathi ce1e2c0904 incorporate feedback from reviewers 2018-07-04 17:58:37 -04:00
Travis Ralston 9e796192e4 Document that clients must leave before forgetting rooms 
Fixes https://github.com/matrix-org/matrix-doc/issues/1011
 2018-07-04 15:31:23 -06:00
Hubert Chathi 5bc29eb11c remove accidentally-committed backup file 2018-07-04 17:01:35 -04:00
Travis Ralston 05c85fd840 Spec the 403 on GET /presence/{userId}/status 2018-07-04 14:37:21 -06:00
Kitsune Ral 981d1004bc Add a missing $ref 2018-07-04 14:14:52 -06:00
Travis Ralston 442ad99727
Merge pull request #1273 from QMatrixClient/content-repo-use-default 
Add 'default' to formally enforce the description
 2018-07-04 14:01:36 -06:00
Travis Ralston caa6d4d9ad Give all errors a schema reference 
This just helps keep an overall structure
 2018-07-04 13:54:52 -06:00
Travis Ralston 7cd22f5690 Describe the rate limit error everywhere 
Fixes https://github.com/matrix-org/matrix-doc/issues/1153
 2018-07-04 13:45:34 -06:00
Travis Ralston 1f12637d3f Getting presence requires authentication 2018-07-04 12:23:51 -06:00
Travis Ralston a6b0125da6 Our swagger doesn't support explode yet 2018-07-03 16:19:31 -06:00