Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-21 17:08:36 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
4712 commits 30 branches 42 tags 32 MiB
Commit graph

818 commits

Author SHA1 Message Date
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
Travis Ralston d279fdafa6 Document the server_name query parameter on /join/{roomIdOrAlias} 
Fixes https://github.com/matrix-org/matrix-doc/issues/904
 2018-07-03 15:49:16 -06:00
Travis Ralston 7d94aaace8 Explicitly declare that the kick/ban reason will be on the membership event 
Fixes https://github.com/matrix-org/matrix-doc/issues/798
 2018-07-03 14:59:41 -06:00
Travis Ralston 2409c84968 Document the GET version of /login 
Fixes https://github.com/matrix-org/matrix-doc/issues/677
 2018-07-03 13:41:49 -06:00
Hubert Chathi 0dd330962d initial draft of .well-known discovery 2018-07-03 14:14:26 -04:00
Will Hunt a1309d636c
Remove "Clients should handle gracefully" sentence 2018-06-29 09:58:07 +01:00
Will Hunt 41c18bed0f
+repository 2018-06-28 17:53:57 +01:00
Will Hunt 21e957edfb
Better note for /config 2018-06-28 17:23:57 +01:00
Will Hunt 1820df02d9
media => content repository 2018-06-28 17:07:44 +01:00
Will Hunt 091b2a6771
Hard limit on requiring accessToken. Rephrased some sections 2018-06-28 16:42:36 +01:00
Will Hunt eeaf4385d7
Speling is my weakniss 2018-06-28 09:04:01 +01:00
Will Hunt 80935eadcf
Update content-repo.yaml 2018-06-28 00:14:42 +01:00
Will Hunt ddc152347b
Extending words and rate limiting 2018-06-27 20:14:29 +01:00
Terrill Tsang f032d6d1c3
Update keys.yaml 
Fixed an end to end document bug , a format misleading in an claim response
 2018-06-26 17:46:58 +08:00
Will Hunt 1140c0c05b Document StateEvent for /createRoom (#1329) 2018-06-22 16:23:05 +01:00
Will Hunt 6d0a56d190
Suggestions by Travis tend to be sensible ones 2018-06-22 09:38:53 +01:00
Will Hunt 6b9640bcb4
upload_size => m.upload.size 2018-06-20 17:06:17 +01:00
Will Hunt 077cd04a6d
/limits => /config 2018-06-20 16:01:06 +01:00
Michael Telatynski df5455de1f
re-arrange fields in example /search request to make them a valid request. 2018-06-05 10:12:34 +01:00
Michael Telatynski 64f97c5b78
add example of highlights field in /search response 2018-06-05 10:10:24 +01:00
Michael Telatynski 4ff5887c91
spec the highlights field in /search response 2018-06-05 10:06:26 +01:00
Kitsune Ral 42fba1a87e Add 'default' to formally enforce the description 
A quick follow up on #1265.

Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
 2018-06-03 13:12:59 +09:00
Travis Ralston 3dc54b20c6
Merge branch 'master' into travis/clarify-routing-loops 2018-05-31 11:53:04 -06:00
Travis Ralston 8610effad7
Merge branch 'master' into travis/reporting 2018-05-31 10:57:33 -06:00
Travis Ralston 7cc15f3315 Document the allow_remote query param on the media repo 
Fixes https://github.com/matrix-org/matrix-doc/issues/837

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-05-27 12:34:58 -06:00
Travis Ralston 9037f506ac Document how to report content 
Fixes: https://github.com/matrix-org/matrix-doc/issues/739

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-05-27 12:19:30 -06:00
Travis Ralston 4278cd56a4 Document /logout/all 
Fixes https://github.com/matrix-org/matrix-doc/issues/700

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-05-27 11:45:36 -06:00
Florian Jacob cc54a4f8cb /rooms/{roomId}/members: specify access_token requirement 
as the behaviour of which members the users see is user-specific
and therefore requires authentication.

Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
 2018-05-17 18:51:08 +02:00
Richard van der Hoff bb39bea44d
Merge pull request #1169 from mujx/event-id-format 
Use the correct event_id format on examples
 2018-05-17 08:36:09 +01:00
Valentin Deniaud 55b512c968 add delete_devices endpoint 
fix #1041
 2018-05-16 11:50:21 +02:00
Valentin Deniaud 34140a785d fix typo in delete device 2018-05-14 16:02:48 +02:00
Will Hunt ffc8ee298a
a upload > an upload 2018-05-08 11:50:34 +01:00
Will Hunt de6fe1b76e Add note about auth 2018-05-03 18:00:50 +01:00
Will Hunt c9abf36097
size > upload_size 2018-05-03 16:58:22 +01:00
Will Hunt 2783820f98 Initial draft of GET media/limits 2018-05-03 13:54:36 +01:00
Jason Volk 048de9803e Fix typo. 2018-04-22 22:57:40 -07:00
Konstantinos Sideris 7448ef0db0 Use the correct event_id format on examples 
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
 2018-04-03 13:18:29 +03:00
Andrew Morgan cd26c170de Specify token used in /login is not an Access Token (#1155) 
* Specify token used in /login is not an Access Token

While working through the implementation of /login in Dendrite, it was
confusing what the contents of the token attribute in the login request
body referred to. Initially, I thought it was an access token, which led
to further confusion. This commit explicitly states that the token is a
login token, which is separate from an access token, hopefully reducing
confusion for future readers.

Signed-off-by: Andrew Morgan (https://amorgan.xyz) <andrew@amorgan.xyz>
 2018-03-23 10:00:49 +00:00
Richard van der Hoff 2644e5657d
Merge pull request #1152 from turt2live/travis/clarify-whoami 
Improve documentation around /account/whoami
 2018-03-06 22:54:01 +00:00
Travis Ralston 159ab7313f Fix typos in whoami.yaml 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-06 15:50:13 -07:00
Travis Ralston b7f8f20de9 Reword the appservice portion of /account/whoami 
Credit goes to richvdh - suggestions taken with edits.

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-06 15:32:49 -07:00
Travis Ralston 6ba5d7ca92 Reword appservice requirements for /account/whoami 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-06 15:06:10 -07:00
Richard van der Hoff a549baa01d
registration.yaml: fix typo 
it's -> its
 2018-03-06 21:53:16 +00:00
Travis Ralston 2e4e5e25e8 Improve documentation around /account/whoami 
Clarifies: https://github.com/matrix-org/matrix-doc/issues/1135

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-06 13:41:53 -07:00
Travis Ralston 15cdde3f49 Add GET /register/available 
Adds https://github.com/matrix-org/matrix-doc/issues/911

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-06 13:16:07 -07:00
Travis Ralston d88a1308c2 Formatting and remove DELETE /directory/list 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-06 10:05:32 -07:00
Travis Ralston 5cbfa73fe4 Improve documentation of /directory/list 
* 404 for room not found instead of 400
* GET doesn't require an access token
* PUT (and therefore DELETE) can have it's own access control checks
* DELETE is implemented because of synapse

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-06 08:51:57 -07:00
Travis Ralston 595667d15d Spec /directory/list 
Adds https://github.com/matrix-org/matrix-doc/issues/417

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-03 14:46:40 -07:00
Jason Volk de6d2c96fe Minor grammar fix. 2018-02-13 18:55:36 -08:00
Richard van der Hoff f7bbcd1678
Merge pull request #1110 from t3chguy/rooms/event 
Document new rooms/$/event/$ API for fetching a single event (no ctx)
 2018-02-07 12:34:11 +01:00
Michael Telatynski 04eb6c7b65
link to both context and event in depr notice as per review 2018-02-07 08:27:39 +00:00
Michael Telatynski c5816a80af
move /rooms/{roomId}/event/{eventId} and update depr notice 2018-02-07 08:22:37 +00:00
Michael Telatynski 06911d4fab
Merge branch 'master' of https://github.com/matrix-org/matrix-doc into t3chguy/search_defaults 2018-01-30 21:29:06 +00:00
Michael Telatynski a9c3d94f24
Merge branch 'master' of https://github.com/matrix-org/matrix-doc into rooms/event 2018-01-30 21:27:02 +00:00
Michael Telatynski a5374c7df7
Document new rooms/$/event/$ API for fetching a single event (no ctx) 2018-01-30 21:24:39 +00:00
Michael Telatynski dc27323d8b
Document the defaults for the /search API 2018-01-30 14:29:59 +00:00
Richard van der Hoff 59e4c625b3
Merge pull request #1093 from CromFr/guest_can_join 
Add createRoom guest_can_join parameter
 2018-01-24 20:42:08 +00:00
David Baker fa0eb2405f all rooms, not any, and remove extra words 2018-01-17 11:25:09 +00:00
David Baker ca09415e80 Fix /keys/changes response to reflect reality 2018-01-17 11:16:48 +00:00
David Baker bb0bbedb87 indenting 2018-01-10 17:46:25 +00:00
David Baker 1674b0e3b5 Doc /keys/query 'token' param 2018-01-10 17:43:35 +00:00
Michael Telatynski 784adade9b
changes based on Pull Request feedback 2017-12-21 17:45:26 +00:00
Michael Telatynski 3d8fe6e090
merge profiles with user directory into user data, also fix typo 2017-12-18 17:01:52 +00:00
Michael Telatynski 605510e965
Merge branch 'master' into user_directory 2017-12-18 16:56:04 +00:00
Michael Telatynski d219cbc978
apply points from review 2017-12-18 16:54:11 +00:00
Richard van der Hoff 00b28495a6 Explain how to split an mxid 2017-12-18 14:48:56 +00:00
Richard van der Hoff d9a4ddbf65 Mark home_server field deprecated 
This is spelt wrong, and is redundant to user_id, so let's stop people using
it.
 2017-12-18 13:34:26 +00:00
Michael Telatynski 97445195f6
add user_directory 2017-12-17 23:42:44 +00:00
Gergely Polonkai e9622bf9e4 Fix example in email based registration endpoint 
The spec says `send_attempt` should be a number, but the example shows it as a string.

Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>
 2017-12-15 13:14:26 +01:00
Crom (Thibaut CHARLES) b270233549
Add createRoom guest_can_join parameter 2017-12-13 14:12:27 +01:00
Thibaut CHARLES 5e2a48f709
createRoom StateEvent.content should be an object 2017-12-13 00:01:26 +01:00
Kitsune Ral a68b7e1bbd Supply operationId with freshly added operations 
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
 2017-11-15 07:37:02 +09:00
Kitsune Ral b53083732b Merge remote-tracking branch 'remotes/origin/master' 2017-11-15 07:32:44 +09:00
Travis Ralston 0f5a4efce6 Spec URL previews (#1064) 
* Spec URL previews
* Require authentication on /upload and /preview_url
 2017-11-14 14:52:51 +00:00
Travis Ralston 2468c38482 Add required property to whoami 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2017-11-13 18:47:38 -07:00
Travis Ralston 41db12713d Update whoami endpoint 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2017-11-13 14:22:20 -07:00
Travis Ralston 9cf2b59f4e Make it less obvious where this was copy/pasted from 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2017-11-12 23:56:28 -07:00
Travis Ralston b1801ea6db Spec /account/whoami 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2017-11-12 23:49:40 -07:00
Kitsune Ral 66268260c7 Merge remote-tracking branch 'remotes/origin/master' 2017-11-13 07:46:29 +09:00
Kitsune Ral 1d4410b638 operationid -> operationId 
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
 2017-11-13 07:46:03 +09:00
Richard van der Hoff 88fb2e9abd
Merge pull request #1045 from maxidor/max/cs/unknow_filter_status 
Add status for unknown user's filter ID
 2017-11-09 18:29:12 +00:00
Maxime Dor 099a7e90ae Change return code following feedback 2017-11-09 15:32:32 +01:00
Maxime Dor dcaaf84395 Be clear that event_id is not applicable everywhere 2017-11-09 15:28:44 +01:00
Maxime Dor efa9b5a8f1 Add missing required key for sync format 2017-11-09 02:10:23 +01:00
Maxime Dor 0fea380625 Add status for unknown user's filter ID 2017-10-29 12:20:22 +01:00
Richard van der Hoff 628e723483 Move the MXID spec to the appendices 
Also link to them from the /register API doc.
 2017-10-23 00:51:40 +01:00
Richard van der Hoff b4e24d443a Clarify what happens when there is no power_levels event 2017-10-17 16:34:50 +01:00
Richard van der Hoff a8afbfd27d Avoid external link in search swagger 2017-10-15 23:01:54 +01:00
Kitsune Ral 004a4d5148 Added/updated operationIds according to today's updates in the spec 
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
 2017-10-11 02:22:19 +09:00
Kitsune Ral 24afe7987c Add operationId to all endpoints of all APIs 
To facilitate generation of API stubs from the spec.

Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
 2017-10-11 01:58:31 +09:00
Michael Telatynski bf3b49f13c document joined_members and joined_rooms endpoints (#999) 2017-10-10 16:16:27 +01:00
Richard van der Hoff 820704a16a Format examples as raw objects 
According the the openapi spec, examples for responses and schemas should be
raw objects rather than being json strings. (It's unclear what non-json
examples should look like...).

The swagger UI used to support json strings, but no longer does. In short,
let's turn the json strings into their raw formats.
 2017-09-27 08:04:24 +01:00
Richard van der Hoff a84a34ee6c GETting a filter requires auth (#1003) 2017-09-26 14:11:43 +01:00
Richard van der Hoff 1e3f5683c8 Make clear that the /sync timeout is zero by default 2017-08-31 16:56:50 +01:00
Brendan Abolivier fee65dbacb
Fix response format and 404 example for room alias lookup 2017-07-27 17:43:49 +01:00
Brendan Abolivier 750d980bc0 Room member (#950) 
* Fixed an incorrect membership on example
* Added precision on membership upon profile update
* Changed first example into a join
* Changed the state/{eventType}/{stateKey} example with an actual state key
 2017-07-14 15:30:56 +01:00
Richard van der Hoff da6938b818 Key management APIs (#894) 
Spec the e2e key-management APIs.
 2017-04-20 16:51:42 +01:00
Konstantinos Sideris 09a768763d Add missing enum fields for the set_presence parameter 
Signed-off-by: Konstantinos Sideris <siderisk@auth.gr>
 2017-01-14 19:10:35 +02:00
Richard van der Hoff 7adf95b4ad Merge pull request #740 from matrix-org/rav/fix_736 
Set default account 'kind' to 'user'
 2016-11-22 09:52:19 +00:00
Richard van der Hoff c83a556097 Set default account 'kind' to 'user' 
Fixes https://github.com/matrix-org/matrix-doc/issues/736
 2016-11-21 17:54:47 +00:00
Richard van der Hoff c175039a08 Final public_rooms clarifications 
* order by *joined* members
 * clarify pagination direction behaviour
 2016-11-21 13:08:41 +00:00
Richard van der Hoff dca1d0c745 Merge branch 'master' into erikj/public_rooms 2016-11-21 12:22:08 +00:00
Richard van der Hoff 2bf0abcb9d Add missing tag to PUT /devices/{deviceId} 2016-11-09 14:37:34 +00:00
Richard van der Hoff b26c84a290 Fix schema validation fail 2016-11-09 14:33:45 +00:00
Richard van der Hoff 07dbf6fcf6 Add doc for PUT /devices/{deviceId} 
Oops, forgot this.
 2016-11-09 14:25:31 +00:00
Erik Johnston d66792d5ca Mention order of returned results 2016-10-14 10:31:06 +01:00
Richard van der Hoff af515012ea Device management API 2016-10-12 17:26:01 +01:00
Richard van der Hoff 9265b03008 Client device doc 
Document client devices, and the mods to the login and register apis to support
them.
 2016-10-12 17:26:01 +01:00
Erik Johnston a69d6c63c6 Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/public_rooms 2016-10-11 14:31:47 +01:00
Erik Johnston cafa9a01fd Move explanation of lack of direction param 2016-10-11 14:29:20 +01:00
Erik Johnston 71c1fc5ec0 Remove spurious 400 result 2016-10-11 14:28:32 +01:00
Erik Johnston de68c167b6 Add tags for GET endpoint 2016-10-11 14:27:53 +01:00
Erik Johnston 9d0960b206 Better wording 2016-10-11 14:24:46 +01:00
Richard van der Hoff 42616f839c Merge pull request #396 from matrix-org/dbkr/notifs_api 
Spec notifs API
 2016-10-06 17:21:47 +01:00
Richard van der Hoff 909aef2b18 Merge pull request #389 from matrix-org/erikj/create_room_is_direct 
Spec /createRoom is_direct flag, is_direct in member event and m.direct
 2016-10-06 17:19:48 +01:00
David Baker e0a434b248 Aaha, found a syntax that swagger will accept! 2016-10-06 11:20:05 +01:00
David Baker bd753d4bf4 Re-add required flags the correct way 2016-10-05 18:53:08 +01:00
David Baker af2c74c186 Revert requireds 
They're not boolean flags for object fields
 2016-10-05 18:50:14 +01:00
David Baker 14944fe237 More PR feedback 2016-10-05 18:26:42 +01:00
David Baker fd8c1a43c7 ms, not s. Also add required flags 2016-10-05 18:22:03 +01:00
David Baker b789251f70 More PR feedback 2016-10-05 12:59:49 +01:00
David Baker 4a020025bc Make swagger happpy 
These aren't strings, but 'any' causes swagger to break and
leaving it out makes the doc fail to build.
 2016-10-05 11:51:48 +01:00
David Baker b4c89accb2 Params in query, not path 2016-10-05 11:48:14 +01:00
David Baker a463820d83 Typo 2016-10-05 11:21:56 +01:00
David Baker c1fa342b90 Swagger is failing on type 'any' 2016-10-05 11:21:06 +01:00
David Baker 136d5dc9ad Almost valid... 2016-10-05 11:15:33 +01:00
David Baker 595b75f299 Try & make example closer to valid 2016-10-05 10:32:03 +01:00
David Baker 41781e95b2 Attempt valid json 2016-10-05 10:21:29 +01:00
David Baker c16ba9488f Spec notifs API 2016-10-05 10:15:49 +01:00
Richard van der Hoff 37fb1ceb65 Merge pull request #395 from matrix-org/rav/kill_refresh_tokens 
Remove references to refresh tokens and tokenrefresh
 2016-10-04 17:55:38 +01:00
David Baker 1d7531e9a1 Typo 2016-10-04 17:51:35 +01:00
David Baker d39f662df5 PR feedback 2016-10-04 11:57:24 +01:00
Richard van der Hoff 556ced36a4 Merge remote-tracking branch 'origin/master' into rav/store_and_forward 2016-10-04 11:55:05 +01:00
David Baker 8fe8bd6a81 Add is_direct to member event spec. 2016-10-03 17:33:45 +01:00
Richard van der Hoff f4c7fdfd03 Remove references to refresh tokens and tokenrefresh 
refresh tokens are dead.
 2016-10-03 17:05:56 +01:00
David Baker 5fedc64230 double space 2016-10-03 15:52:08 +01:00
David Baker ae1c576648 Merge remote-tracking branch 'origin/master' into erikj/create_room_is_direct 2016-10-03 15:17:55 +01:00
Erik Johnston 069aa86a10 Update wording and add example to filter param 2016-09-30 15:06:11 +01:00
Erik Johnston 7919e8e159 Update wording. 2016-09-30 15:02:27 +01:00
Erik Johnston a5bb182c67 Explicitly mention that directio of pagination is specified by the token 2016-09-30 14:30:13 +01:00
Erik Johnston a66a744c45 Fix typo. Change responses in both places 2016-09-30 14:28:40 +01:00
Erik Johnston 06649b652d Mark booleans as required. Remove mention that things may be null 2016-09-30 14:18:13 +01:00
Erik Johnston b121feebce Comment what the is_direct flag actually does 2016-09-30 11:24:51 +01:00
Erik Johnston e8b21f357f Explicitlty mention total_room_count_estimate 2016-09-29 17:18:34 +01:00
Erik Johnston e854757c98 Mark required fields as required 2016-09-29 17:12:52 +01:00
Erik Johnston 0dc94d5c14 Expand on description of pagination tokens 2016-09-29 16:58:00 +01:00
Erik Johnston 37f6769a3c Spec filter param on /messagse 2016-09-29 13:40:20 +01:00
Erik Johnston 085131b617 Add contains_url filter option 2016-09-29 13:37:08 +01:00
Richard van der Hoff ebaaa7e3b3 Review feedback 
* store-and-forward -> send-to-device
* describe motivation
* device ids are 10 capital chars
* etc
 2016-09-29 13:18:45 +01:00
Erik Johnston 3a5cbd14c3 Add /createRoom is_direct flag 2016-09-29 11:25:12 +01:00
Erik Johnston c05ee18f58 Add title and update description 2016-09-29 11:06:57 +01:00
Erik Johnston 130ea85576 Spec POST /publicRooms 2016-09-29 11:01:36 +01:00
Erik Johnston 877a6cfeb4 Spec new query params for /publicRooms 2016-09-29 10:47:37 +01:00
Erik Johnston d81d0dbd1d Spec canonical alias key 2016-09-29 10:35:04 +01:00
Richard van der Hoff ccd7bb32d5 Specification for direct-to-device messages 2016-09-27 14:27:27 +01:00
Benjamin Saunders cade909e25 Fix inconsistencies regarding redacted_because 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-08-30 21:18:55 -07:00
Richard van der Hoff 7478e7f3cf Add top-level account_data to /sync response 2016-08-30 17:43:20 +01:00
Benjamin Saunders 77b668a5dc Fix some obsolete uses of user_id key in events 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-08-26 23:06:41 -07:00
Matthew Hodgson 978d9ea6dd fix the descriptions of the /room/.../state APIs to not be the wrong way round 2016-08-18 14:04:21 +01:00
Richard van der Hoff c51c4acf7f Clarifications to authentication mechanisms 
* Make the purpose of the `auth` key in /register requests explicit, and say
  that it should be empty at first.

* Restructure the UA-auth section a bit.

* In the UA-auth section, say that clients should submit no `auth` to start
  with, and add 'Stage 0' representing  this to the example.

* s/{stage,login} type/authentication type/ in the UA-auth section. Seems
   clearer to me.

* Try to distinguish the example responses from the example requests by giving
  an HTTP header.
 2016-08-15 10:28:15 +01:00
Richard van der Hoff 4b0e546eeb PR feedback 
Fix some typos, and clarify several aspects of server behaviour.
 2016-08-09 12:02:38 +01:00
Richard van der Hoff 41368dc5a7 document CAS login 
Following the spirit of "document how it is, not how we wish it was", document
the CAS login bits.
 2016-08-08 17:33:48 +01:00
Mark Haines d2fe2f1ff6 Fix jenkins 2016-08-02 13:59:46 +01:00
Mark Haines 618f94699b Document the optional parameter for specifying a filename to download an attachment as 2016-08-02 13:49:54 +01:00
Richard van der Hoff 8328e485ea Clean up the pushrules API doc 
* make it clearer which fields go in which parts of the rule
* the example given appeared to be for a content rule, so use a content rule
  consistently through the examples.
 2016-07-27 13:54:35 +01:00
Richard van der Hoff 7ac2f51e4a /upload: fix example for filename 
The example shouldn't be encoded, else it will be double-encoded by swagger.
 2016-07-25 09:07:42 +01:00
Benjamin Saunders 3e2dea4c52 Document filename query parameter for uploads 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-07-24 23:27:56 -07:00
Richard van der Hoff ec20f15407 /tokenrefresh should expire the access token 
It's possible for clients to call /tokenrefresh before the access_token has
expired, potentially leading to a proliferation of valid access_tokens.
 2016-07-19 09:17:14 +01:00
Richard van der Hoff 2370a4c970 Spell out the state algorithm for createRoom 
Fixes https://matrix.org/jira/browse/SPEC-429.

Synapse currently follows the specified ordering, but does *not* give the
specified error when the state is invalid (instead it creates the room anyway
but gives a 403 M_FORBIDDEN). Still, I don't think that should be a real
problem for any real clients, and nothing would break if we changed this in
synapse, so it might as well go in the spec anyway.
 2016-07-18 13:01:45 +01:00