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
5313 commits 30 branches 42 tags 32 MiB
Commit graph

1206 commits

Author SHA1 Message Date
Travis Ralston b0744aa1e9
Merge pull request #1413 from turt2live/travis/s2s/join-swagger 
Convert joins/invites to swagger
 2018-07-26 08:39:26 -06:00
Travis Ralston af0629a520 Full stop 2018-07-26 08:36:12 -06:00
Travis Ralston 9f399a08fe Full stops 
I'm never going to remember these
 2018-07-24 14:41:42 -06:00
Travis Ralston 0d1b82a601 Add the event_id to unsigned PDUs 
This went missing in the swagger conversion. The example already has an event_id.
 2018-07-24 14:40:32 -06:00
Travis Ralston eaf175056f Full stops 2018-07-24 10:58:15 -06:00
Travis Ralston 797aca87bd Update the check_examples.py script to resolve references 
The script previously wasn't chasing down valid references in examples.
 2018-07-24 10:58:15 -06:00
Travis Ralston 7314405904 Update comment 2018-07-24 10:58:15 -06:00
Travis Ralston 45ec8269e6 Fill out the required fields in all the examples 2018-07-24 10:58:15 -06:00
Travis Ralston 9c1c541a38 Remove extra "required" declarations 
"required" is something that is handled as an array, and these are invalid. The `type` in both cases is covered by a required array elsewhere
 2018-07-24 10:58:15 -06:00
Travis Ralston 004998b98f Convert invites to swagger 
The whole section reads like a description for the endpoint, and has been replaced by the swagger definition now (rather than at a later stage). All the same information should be kept.
 2018-07-24 10:58:15 -06:00
Travis Ralston f09c4fd286 Convert joins to swagger 2018-07-24 10:58:15 -06:00
Travis Ralston cb4fcd1d09 Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger 2018-07-24 09:15:36 -06:00
Travis Ralston 88beaf4ad8 Completely remove /pull 
It's not been in use for years - we can safely let it disappear
 2018-07-24 09:13:46 -06:00
Travis Ralston 21c4af70a9 Fix schema definitions (spelling, attributes) 2018-07-24 09:13:15 -06:00
Travis Ralston 2aafde4549
Merge pull request #1419 from turt2live/travis/s2s/3pinvites-swagger 
Convert third party invite exchange to swagger
 2018-07-23 10:33:00 -06:00
Travis Ralston 89384c96c1 Full stops, language. 2018-07-18 11:06:23 -06:00
Travis Ralston e226b60c7f Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger 2018-07-18 10:59:39 -06:00
Travis Ralston bafdcf3640 Full stops, spelling, and operation IDs. 2018-07-18 10:37:56 -06:00
Travis Ralston 7cb918407d Merge remote-tracking branch 'matrix-org/master' into travis/s2s/keys-swagger 2018-07-18 10:32:46 -06: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 272f3d8432 Fix documentation link 2018-07-13 15:49:49 -06:00
Travis Ralston cf93c88337 Convert third party invite exchange to swagger 2018-07-13 15:44:33 -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 e5da1e1741 Improve upon the transaction schema and examples 
Reduces data duplication and makes the objects more reusable for other areas of the spec
 2018-07-12 21:34:52 -06:00
Travis Ralston 51faf8ed2e Convert the general query API to swagger 
Includes "moving" the directory query API into the same area. This will make more sense once the other query types are specified.
 2018-07-12 13:46:42 -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 374ec00046 Convert things that mention "Transaction" to swagger 
There's two kinds of transactions currently: one with EDUs and one without. The one with EDUs is only used on /send, however the schema is still somewhat worth splitting out for simplicity.

The examples are brought apart to make them slightly more reusable for when they get dumped into the relevant sections of the spec (see TODO in server_server_api.rst)

Further, the Transactions stuff introduces tuples to the spec. The units.py has been updated to support this.
 2018-07-11 16:52:27 -06:00
Travis Ralston 3e13ec2841 Fix required properties in POST /query 2018-07-11 13:43:15 -06:00
Travis Ralston 96889f16e9 Split out and fix the /server and /query key APIs 2018-07-11 13:20:44 -06:00
Travis Ralston bd2c0b7c98 Convert server keys to swagger 2018-07-11 13:09:19 -06: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
Andrew Morgan e81e0328c2 Fix single protocol metadata endpoint path, remove 500s 2018-07-05 17:50:34 +01: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
Andrew Morgan d73b247688 3PE lookup service 2018-07-03 14:40:28 +01: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
user 5ab5fe08d1 Small grammatical and stylistic fixes 2018-06-17 15:49:39 +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 e4f7ba70f5
Merge branch 'master' into travis/spec-directory-list 2018-03-05 14:53:06 -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
Maxime Dor c8393306d1 Add IS ping endpoint 2018-02-27 17:54:42 +01: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
Maxime Dor 9d2e18cca1 Adapt paths as per feedback 2017-11-15 18:46:27 +01:00
Maxime Dor d1e64daa10 Fix yaml title for directory api 2017-11-15 18:43:16 +01:00
Maxime Dor 28c09aed62 Properly mark required response keys to pass tests 2017-11-15 13:57:52 +01:00
Maxime Dor 8a6103798e Fix for tests 2017-11-15 13:54:55 +01:00
Maxime Dor bb50ec2e88 Document directory query endpoint 2017-11-15 13:40:55 +01:00
Richard van der Hoff 2128924933
Merge pull request #1072 from maxidor/max/ss/version 
Document federation version endpoint
 2017-11-15 07:05:52 +00:00
Maxime Dor 1045bc721d Document federation version endpoint 2017-11-15 04:16:30 +01:00
Kitsune Ral 828086a86c Supply operationId for freshly added IS and AS operations 2017-11-15 07:53:36 +09: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
Kitsune Ral 868af0a7a1 Provide doc-comments with makeHandler(); cleanup 2017-11-15 07:28:25 +09:00
David Baker 5147a3b975 Fix broken links & grammar 2017-11-14 17:14:56 +00:00
David Baker 45af878e11 Merge remote-tracking branch 'origin/master' into dbkr/is_bulk_lookup 2017-11-14 17:11:39 +00:00
David Baker d728e67751
Merge pull request #1068 from matrix-org/dbkr/threepid_add_msisdn 
Document threepids
 2017-11-14 17:05:39 +00:00
Maxime Dor 836e6c81d1 Fix spelling 2017-11-14 15:15:49 +00:00
David Baker e80675c9e9 Link in markdown, not swagger 2017-11-14 15:03:51 +00:00
David Baker 493b936209 Make these links more specific too 2017-11-14 15:01:58 +00:00
Maxime Dor cdfff67878 Create spec for IS bulk lookup 2017-11-14 14:55:16 +00: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
David Baker 6edb90a08e Document threepids 
Adds the /msisdn' 3pid type and generally fleshes out what a 3pid
is and how they work.

This merges most of the work from Max Dor in https://github.com/matrix-org/matrix-doc/pull/1039
with some tweaks and additions.
 2017-11-14 14:36:38 +00:00
Kitsune Ral 33463e3907 Factor out parser.validate callback 2017-11-14 15:16:42 +09: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 77a9daccec Validation that operationId is present 
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
 2017-11-13 12:11:11 +09: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 56c3e5a627 README.rst: Add notes on how to build the spec 2017-10-25 09:57:02 +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
David Baker 49ee00c361 Use the right path for the identity API 2016-10-07 18:17:45 +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
Erik Johnston a48437ced8 Spec /account/deactivate API 2016-07-14 10:11:38 +01:00
Richard van der Hoff a9d3cfd13c Merge branch 'master' into rav/link_undeprecated_endpoints 2016-07-13 11:09:53 +01:00
Richard van der Hoff d92515bce3 Merge pull request #354 from matrix-org/rav/reorder_deprecated_initialsync 
Move /room/x/initialSync to after the undeprecated APIs
 2016-07-13 11:07:11 +01:00
Richard van der Hoff 7080fd0618 Merge pull request #348 from Ralith/room-messages 
Add missing "to" parameter to /messages
 2016-07-13 11:01:56 +01:00
Benjamin Saunders dc7fc0309e Add missing "to" parameter to /messages 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-07-12 20:38:53 -07:00
Richard van der Hoff 49cd65dd58 Add a license to the spec 
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
 2016-07-12 17:28:30 +01:00
Richard van der Hoff 6bcb1798f5 Mark deprecated endpoints with their replacements 
Fixes https://matrix.org/jira/browse/SPEC-415
 2016-07-12 16:18:48 +01:00
Richard van der Hoff 9d267795e0 Move /room/x/initialSync to after the undeprecated APIs 
It's a bit incongruous to have to read through the deprecated /initialSync to
get to the good stuff. Separate out intialSync so that we can move it later in
the spec.
 2016-07-12 15:03:20 +01:00
David Baker e91214e78e More links 
Also remove now redundant anchor
 2016-07-08 14:26:18 +01:00
David Baker cf13c8997c Merge branch 'dbkr/dont_line_wrap_rst' into dbkr/more_requesttokens 2016-07-08 13:54:30 +01:00
David Baker 7c8651480a Some PR feedback corrections 
Including adding a hyperlink, although this requires a separate fix that I'll do on a different branch
 2016-07-08 11:56:23 +01:00
Richard van der Hoff 19a59bc210 Merge pull request #345 from Ralith/require-prev_batch 
Supply prev_batch unconditionally in timelines
 2016-07-07 21:08:56 +01:00
David Baker c109da5b78 Attempt to make things clearer 2016-07-07 17:07:38 +01:00
David Baker 86db820bb1 Expand on summaries for requestToken endpoints 2016-07-07 16:05:21 +01:00
David Baker 191cb08a3a Add response section otherwise the checker fails 2016-07-07 15:00:27 +01:00
David Baker d74a320edd Stray tab 2016-07-07 14:58:05 +01:00
David Baker ead5648b8c Add requestToken endpoints 
For password reset and 3pid adding
 2016-07-07 14:52:45 +01:00
Benjamin Saunders ee5054fb42 Supply prev_batch unconditionally in timelines 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-07-07 01:37:48 -07:00
David Baker 14ff3862e3 More PR feedback 2016-07-05 15:15:44 +01:00
David Baker e4db7be8e2 Better structure for error response 
& add server not trusted error
 2016-06-30 16:22:01 +01:00
David Baker 3dddc0dcdf Explain why not erroring on dup 3pid is desireable 2016-06-30 16:13:45 +01:00
David Baker a600386c05 Consistent working for error response 
Also format json example better
 2016-06-30 16:12:11 +01:00
David Baker 60293af83a PR feedback 2016-06-30 15:25:09 +01:00
David Baker 6a0c9edb49 Add the id_server param 2016-06-30 15:19:44 +01:00
David Baker b0194a3016 Spec for endpoint-specific 3pid verification token 
As per proposal https://docs.google.com/document/d/13mapDbaOnbob9ZYRDiGm1YbeZhFOBj_R1OvgBA9pA5s/edit?pref=2&pli=1#
 2016-06-30 14:50:17 +01:00
Richard van der Hoff 4f37e4ece0 Merge pull request #342 from matrix-org/erikj/presence 
Fix and correctly document presence's currently_active
 2016-06-29 11:36:55 +01:00
Erik Johnston 0de8ba7f0a currently_active is a param on GET response, not put 2016-06-29 10:35:31 +01:00
Mark Haines 30a3302921 Merge pull request #274 from matrix-org/markjh/default_rules 
Update the predefined push rules in the spec
 2016-06-22 16:14:21 +01:00
Erik Johnston e80e32173f Merge pull request #278 from matrix-org/erikj/presence 
Update presence spec.
 2016-06-22 14:08:44 +01:00
Erik Johnston 2691d4925b s/currently_online/currently_active/ 2016-06-22 14:07:24 +01:00
Richard van der Hoff 7bbb664784 Improve documentation of directory API 2016-06-16 13:58:45 +01:00
Richard van der Hoff 86a81b0450 Fix schema for /logout 
'properties' is a map, not a list
 2016-05-08 22:34:17 +01:00
Richard van der Hoff e7e9f5fa46 Document the /logout api 
We have one, and it's useful, so we really ought to document it
 2016-05-08 22:26:49 +01:00
Richard van der Hoff 3bce28a15c Clarifications to the 'Client authentication' section 
* Use the terminology 'login type' everywhere instead of mixing up 'stage type'
  and 'login type'

* Don't have a separate 'APIs using the User-Interactive Authentication
  mechanism' section, because (a) it doesn't make much sense to organise the
  APIs this way, and (b) it was a set of lies anyway.

* Move '/account/password' definition into registration.yaml so that register
  and password can share a section in the spec; remove duplicate doc for
  /password.

* Write some words on using 3pids for /login
 2016-05-06 17:28:35 +01:00
Richard van der Hoff 2093a6bac9 Merge pull request #332 from matrix-org/rav/update_login_api 
Update the /login API spec
 2016-05-06 17:11:30 +01:00
Richard van der Hoff 959f1ff09f Update the /login API spec 
Note that /login can be used with 3pid creds
 2016-05-06 16:58:04 +01:00
Richard van der Hoff 9efd021f5e Document the user-interactive api params 
Document the parameters and responses on /register and /account/password which
are invoved in the user-interactive auth
 2016-05-06 16:47:49 +01:00
Richard van der Hoff 2d28e5abce Fix basePath on /redact API doc 2016-05-06 12:39:37 +01:00
Richard van der Hoff 432c78f3b5 Fix the swagger for /search so that it works without preprocessing 
Makes the /search swagger work when it is imported directly into the swagger-UI
without preprocessing by dump_swagger
 2016-05-04 14:55:43 +01:00
Richard van der Hoff 5383754a40 Access event-schemas via a symlink 
Swagger gets a bit confused about $refs via '../..', so use a symlink to make
everything nicely relative.
 2016-05-04 14:39:52 +01:00
Richard van der Hoff 1fe00b1517 Reinstate validator.js 
It turns out that validator.js is used by the jenkins build script to, uh,
validate the docs.

This partially reverts commit affb106014.
 2016-05-04 00:19:46 +01:00
Richard van der Hoff 23c4ffbc1b Add securityDefintions to generated swagger JSON 
Also factor out to a common file
 2016-05-03 13:57:16 +01:00
Richard van der Hoff cf87120d78 Fixes to the API docs 
* fix security data for DELETE /user/{userId}/rooms/{roomId}/tags/{tag}

* fix definition for body of PUT /pushrules/{scope}/{kind}/{ruleId}/actions
 2016-05-03 13:52:11 +01:00
Richard van der Hoff affb106014 Remove redundant scripts under api/ 
We now use newer swagger, via scripts/dump-swagger.py
 2016-05-03 12:05:52 +01:00
David Baker 1a856b53f3 Remove redundant info & add backticks 2016-04-13 10:29:57 +01:00
David Baker 4b294b23de Tailor descriptions to GET method 2016-04-12 09:56:24 +01:00
David Baker 4fafe1ab73 Return an object as the root element 
Because otherwise it's impossible to change later
 2016-04-11 17:56:38 +01:00
David Baker 42834340e7 Add title to the pushers array 2016-04-11 17:41:15 +01:00
David Baker 0f6e414eb6 Fix format (array of objects, not object) 2016-04-11 17:35:56 +01:00
David Baker 27113d71ff Fix indentation 2016-04-11 17:31:42 +01:00
David Baker 73d6e901ae Add endpoint for getting a user's pushers 
Also add profile_tag to the set docs as it was missing
 2016-04-11 17:25:36 +01:00
Will Hunt c9ed063a36 Small copy paste error 
'avatar url' should be 'profile information'
 2016-04-11 11:47:40 +01:00
David Baker 1d6c405f62 Fix presumably c+p fail 2016-04-06 21:00:12 +01:00
David Baker cf850b4270 Fix level of counts and devices 
They are actually within the notification object rather than the top level object. Add titles to objects so it works.
 2016-04-06 20:21:08 +01:00
David Baker 89453bfd8c Remove spurious blank line 2016-04-06 19:53:45 +01:00
David Baker 64c6d30f90 hopefully fix rst 2016-04-06 19:52:54 +01:00
David Baker 7faf2cf642 Paragraph breaks & missed word 2016-04-06 19:49:41 +01:00
David Baker 7e1cb9003c Make swagger valid 2016-04-06 18:41:15 +01:00
David Baker 71cb646541 Change id in the push gateway poke to be event_id and spec that it's the Matrix event ID of the message. Correct the spec for badge count pushes which omit fields previously described as mandatory. Add more detail about when to use event_id to suppress dupes. Also add the push gateway doc so it's actually included in the spec. 2016-04-06 18:28:21 +01:00
David Baker 39fe9e3896 Merge pull request #284 from matrix-org/dbkr/notification_counts 
Add notification counts to doc
 2016-03-10 14:10:44 +00:00
Daniel Wagner-Hall fecff8afdc Specify association lookup 2016-03-10 13:59:34 +00:00
Daniel Wagner-Hall e0c55eeccf Add initial identity server spec 
More to come
 2016-03-09 15:49:23 +00:00
Daniel Wagner-Hall 11c572267e Add titles where they're missing 2016-03-02 15:23:48 +00:00
David Baker a78dff3981 Add notification counts to doc 2016-03-01 11:40:52 +00:00
Mark Haines d2c05d64c7 Document an API for setting and getting the actions for a push rule 2016-02-26 13:27:19 +00:00
Mark Haines 254fbe7983 Document GET for /pushrules/{scope}/{kind}/{ruleId}/enabled 2016-02-25 10:51:42 +00:00
David Baker e6143a6596 Merge pull request #281 from matrix-org/dbkr/fix_meta_escaping 
Fix meta-escaping fail
 2016-02-24 14:15:55 +00:00
David Baker 2c5392f1d1 Fix meta-escaping fail 2016-02-24 14:00:57 +00:00
Daniel Wagner-Hall 016ccf4544 Remove signed object which shouldn't exist 2016-02-23 15:19:45 +00:00
Erik Johnston cbe466e572 Update API docs 2016-02-23 11:25:43 +00:00
Daniel Wagner-Hall ccac9e7882 /join accepts a signature for a third party invite 2016-02-22 14:54:23 +00:00
Richard van der Hoff bc83677d98 Define the order for events returned by /context API 2016-02-19 16:52:03 +00:00
Richard van der Hoff 68a4306773 Split room previews into a separate module 
Guest access and room peeking are orthogonal
 2016-02-19 15:26:28 +00:00
Mark Haines 3db6980e0b Remove references to device specific push rules 
Since they weren't implemented on the servers and weren't
used by the clients.
 2016-02-18 16:05:47 +00:00
Oddvar Lovaas b28989b2ad fix for https://github.com/matrix-org/matrix-doc/issues/270 2016-02-16 11:01:04 +00:00
Mark Haines 8a050aebc0 Add a note to the docs for before and after to make it clear that they cannot be used with the predefined rules 2016-02-15 17:17:58 +00:00
David Baker 53a4a563e2 Actually we think they should not be present (which means synapse is buggy). 2016-02-03 14:54:29 +00:00
David Baker 542b17e944 Clarify what profile endpoints return if avatar url / display name isn't set 2016-02-03 13:14:12 +00:00
Richard van der Hoff 58b346e204 s/user_id/sender/ in context example response 2016-02-01 17:50:36 +00:00
Richard van der Hoff b2e0a855cc Add 'event' to event context API 
also link through to the event schemas
 2016-02-01 17:45:45 +00:00
Mark Haines e7f80b7c71 Fix the key name to be three_pid_creds rather than threePidCreds 2016-01-29 13:00:59 +00:00
Daniel Wagner-Hall 2e46b587b8 Require explicit un-banning 2016-01-15 14:08:40 +00:00
David Baker 169cc98101 M_INVALID_USERNAME to be consistent with the name of the parameter 2016-01-15 10:04:29 +00:00
David Baker 2301a792d7 Add an error code for invalid user names. 2016-01-14 17:19:04 +00:00
Matthew Hodgson cfbb695fd3 typoe 2016-01-13 18:25:33 +00:00
Daniel Wagner-Hall 1e2b63763e /join and /room/:roomId/join aren't exact aliases 
Separate them, clarify their differences.

Also, fix some links which weren't being properly populated.
 2016-01-13 15:55:51 +00:00
Richard van der Hoff 6265d6ce06 Merge pull request #254 from matrix-org/rav/filter_spec 
Add some missing titles to the filter upload spec
 2016-01-11 12:59:38 +00:00
Richard van der Hoff 972153be4f Fix endpoint path for /context 
s/api//
 2016-01-08 14:06:53 +00:00
Richard van der Hoff ff26e0dc48 Add some missing titles to the filter upload spec 2016-01-07 18:31:09 +00:00
Daniel Wagner-Hall 0e967edfd9 Fix thinko 2016-01-07 12:38:32 +00:00
Daniel Wagner-Hall 7d9547274c Clarify guest /events and /sync 2016-01-07 11:59:38 +00:00
Daniel Wagner-Hall 48aab7bad9 Return room avatar URLs in /publicRooms 2016-01-06 18:00:21 +00:00
Daniel Wagner-Hall 5e30d75ccb Add /_matrix/versions to spec 2016-01-06 17:43:20 +00:00
Erik Johnston 48f56bfbfb Support 3pid invites in /createRoom 2016-01-05 10:52:47 +00:00
Daniel Wagner-Hall 1eee36e889 Merge pull request #232 from matrix-org/daniel/deprecatestuff 
Deprecated deprecated APIs
 2016-01-05 10:44:41 +00:00
Matthew Hodgson c7d11335cf Merge branch 'master' of git+ssh://github.com/matrix-org/matrix-doc 2016-01-05 02:48:14 +00:00
Matthew Hodgson 691d9ba664 typo :( 2016-01-05 02:47:55 +00:00
Mark Haines 4c43939977 more backticks 2015-12-22 11:48:11 +00:00
Mark Haines 9b4a37f57b backticks 2015-12-22 11:44:05 +00:00
Mark Haines 288c7ed353 Add top level filters for filtering by room id. 2015-12-21 20:44:06 +00:00
Mark Haines 2ea66e9300 Merge branch 'markjh/account_data_filters' into markjh/room_filter 2015-12-21 20:38:50 +00:00
Mark Haines a32ed96a0f Document filtering for account data 2015-12-21 20:31:02 +00:00
Mark Haines e413f05c87 Merge pull request #243 from matrix-org/markjh/wildcards 
Filters don't support wildcards for senders or room ids
 2015-12-21 20:25:26 +00:00
Mark Haines c9349b302a Filters don't support wildcards for senders or room ids 2015-12-21 17:17:28 +00:00
Richard van der Hoff b7c255a887 Tweaks/clarifications to search spec 
Fixes https://matrix.org/jira/browse/SPEC-305
 2015-12-17 13:40:22 +00:00
Daniel Wagner-Hall b6cd3adc2f Merge pull request #233 from matrix-org/daniel/txnid 
Merge pull request #233 from matrix-org/daniel/txnid
 2015-12-17 11:24:07 +01:00
Christine Dodrill 7090e491de fix a typo in the example json for the old sync description 2015-12-11 08:10:37 -08:00
Erik Johnston 7980e65502 Merge pull request #234 from matrix-org/erikj/search_yet_agian 
Note that count is approximate
 2015-12-11 12:47:47 +00:00
Erik Johnston 88b350ca8b Better wording 2015-12-11 11:41:51 +00:00
Erik Johnston a2082e4b38 Note that count is approximate 2015-12-11 10:54:01 +00:00
Daniel Wagner-Hall dbba737135 Explain scope of uniqueness of txnid 2015-12-10 15:47:27 +00:00
Daniel Wagner-Hall 3e086909f1 Deprecated deprecated APIs 2015-12-10 14:47:14 +00:00
Daniel Wagner-Hall a484f04b33 Merge pull request #221 from matrix-org/daniel/pushaway 
Merge pull request #221 from matrix-org/daniel/pushaway
 2015-12-09 14:04:02 +00:00
Mark Haines a33e49fd1e Merge pull request #224 from matrix-org/markjh/filter_inline 
Allow the filter JSON to be passed inline in the /sync request
 2015-12-09 11:53:43 +00:00
Mark Haines c3a1318886 Make it explicit that the JSON filter object is passed as a string 2015-12-09 10:50:02 +00:00
Erik Johnston c96848d1bc Merge pull request #169 from matrix-org/erikj/search_yet_agian 
Search: Document event context, groups and orders.
 2015-12-08 16:11:03 +00:00
Erik Johnston 95255bcdf5 Use rst not html 2015-12-08 16:02:55 +00:00
Erik Johnston e1fda6b6b6 Remove double the 2015-12-08 15:35:59 +00:00
Erik Johnston 9c98c80bde Fix up filter description 2015-12-08 15:26:06 +00:00
Mark Haines ed70bcb180 Add a rationale for allowing both inline filters and passing filters by id. 2015-12-08 14:36:50 +00:00
Mark Haines 878ce2f206 Allow the filter JSON to be passed inline in the /sync request 2015-12-08 14:32:11 +00:00
Erik Johnston 6025569a73 Remove unused 403 stub 2015-12-08 14:10:45 +00:00
Erik Johnston 0fb88e26f0 Add tags 2015-12-08 14:07:08 +00:00
Erik Johnston 4290882034 Remove superfluous quote 2015-12-08 14:06:59 +00:00
Erik Johnston 8e7f6d44f6 Remove v1 references 2015-12-08 14:01:16 +00:00
Erik Johnston 4967b092aa Add description of state response key 2015-12-08 13:37:32 +00:00
Daniel Wagner-Hall a2283f5499 Remove /notify from client-server API 2015-12-08 13:25:31 +00:00
Erik Johnston f4b9433c7b Better wording 2015-12-07 16:33:48 +00:00
Erik Johnston 584104c432 Make example valid event id 2015-12-07 16:32:43 +00:00
Erik Johnston fda07e0d41 Merge remote-tracking branch 'origin/master' into erikj/event_context_api 2015-12-07 16:31:55 +00:00
Erik Johnston 856dd9100e Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian 2015-12-07 16:28:14 +00:00
Erik Johnston 118a6aa040 Reword groupings descriptions 2015-12-07 16:06:25 +00:00
Erik Johnston 1ef9cc37e3 Typo 2015-12-07 15:58:31 +00:00
Erik Johnston fca8e5abe7 Add top level next_batch key to example 2015-12-07 15:54:08 +00:00
Daniel Wagner-Hall f81b967e2d Make all the schema files yaml 2015-12-07 13:56:36 +00:00
Daniel Wagner-Hall 1f5b6271f2 Generate swagger-ui output for client-server API 
Depends on:
https://github.com/matrix-org/matrix-doc/pull/212
https://github.com/matrix-org/matrix-doc/pull/208
https://github.com/matrix-org/matrix-doc/pull/207
for the actual rendered output to not throw javascript errors at runtime.
 2015-12-07 12:45:13 +00:00
Daniel Wagner-Hall c9fee294df Merge pull request #211 from matrix-org/daniel/extractas 
Move application service swagger out of c-s dir
 2015-12-07 12:00:27 +00:00
Daniel Wagner-Hall 97579f15cb Merge pull request #212 from matrix-org/daniel/pushdictification 
Take object, not bool, as param
 2015-12-07 10:39:36 +00:00
Daniel Wagner-Hall 705556634a Add filters 2015-12-04 19:46:45 +00:00
Daniel Wagner-Hall 9c733a45e8 Take object, not bool, as param 
Throughout our API we take objects. And swagger is unhappy with not
doing so.
 2015-12-04 17:36:19 +00:00
Daniel Wagner-Hall 614ee9ea1b Move application service swagger out of c-s dir 2015-12-04 17:34:48 +00:00
Mark Haines 140206ca69 s/archived/leave/ 2015-12-04 17:32:59 +00:00
Mark Haines 79d109f7cc Add an flag to control whether rooms the user has left are included in the sync 2015-12-04 16:44:11 +00:00
Daniel Wagner-Hall e0ebabf8cc Explicitly document /rooms/{roomId}/state/{eventType} without state key 2015-12-04 11:42:19 +00:00
Daniel Wagner-Hall 873b0dcecf Replace version numbers with release numbers 2015-12-04 11:09:35 +00:00
Daniel Wagner-Hall f308b7543c Specify /admin/whois/{userId} 2015-12-03 16:26:45 +00:00
Daniel Wagner-Hall 19ce17cfed Merge pull request #200 from matrix-org/daniel/redact 
Merge pull request #200 from matrix-org/daniel/redact
 2015-12-03 15:57:52 +00:00
Daniel Wagner-Hall 2f3a00fe34 Consistently spell homeserver as homeserver 2015-12-02 19:23:33 +00:00
Daniel Wagner-Hall e072d215cf Specify redaction 2015-12-02 15:27:25 +00:00
Daniel Wagner-Hall 7f07da4b50 Remove obsolete documentation 2015-12-01 17:29:09 +00:00
Daniel Wagner-Hall aa4ed10821 Unify v1 and v2 event schemas 2015-12-01 17:23:58 +00:00
Daniel Wagner-Hall 681c258206 Fix turnServer endpoint 2015-12-01 16:56:28 +00:00
Erik Johnston ca7ef1b536 Update Results description 2015-12-01 15:34:25 +00:00
Erik Johnston 5e8bb34f36 Change the results dict to a list 2015-12-01 15:33:13 +00:00
Erik Johnston 46fd0b252c Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/search_yet_agian 2015-12-01 15:06:13 +00:00
Daniel Wagner-Hall c6e0322a9e Swaggerify /account 2015-12-01 13:53:03 +00:00
Daniel Wagner-Hall 6c66bfc755 Flatten out v1 and v2_alpha directories 
As a side effect, I got rid of all of the horrible symlinks and just put
in all of the proper relative paths. Because the horrible symlinks were
horrible.
 2015-11-30 11:22:57 +00:00
Daniel Wagner-Hall 3951785f19 Fix alias path 2015-11-27 16:23:31 +00:00
Daniel Wagner-Hall bc514dc9c4 Merge pull request #178 from matrix-org/daniel/directory 
Fix and include /directory api docs
 2015-11-27 16:21:15 +00:00
Daniel Wagner-Hall 7f2813354d Swaggerify /ban 2015-11-27 15:42:21 +00:00
Mark Haines a20a49abf6 Merge pull request #168 from matrix-org/markjh/client_config 
Add API for setting client config
 2015-11-27 15:32:21 +00:00
Mark Haines c5f457cee9 Merge pull request #132 from matrix-org/markjh/room_tags 
Document a v2 api for setting tags on rooms
 2015-11-27 15:31:54 +00:00
Daniel Wagner-Hall f0c99a6925 Generate API docs from swagger 2015-11-27 15:03:22 +00:00
Mark Haines c539b208f9 Merge branch 'markjh/room_tags' into markjh/client_config 
Conflicts:
	api/client-server/v2_alpha/sync.yaml
 2015-11-26 16:56:39 +00:00
Mark Haines d39494b6df Fix typo in sync example 2015-11-26 16:55:12 +00:00
Daniel Wagner-Hall 5e30b5b8d7 Remove POST version of /send 
PUT should always be used.
 2015-11-26 16:46:29 +00:00
Daniel Wagner-Hall c25a806cef Fix and include /directory api docs 2015-11-26 15:03:39 +00:00
Mark Haines 5ccc39b850 Say that type is an event type 2015-11-20 18:45:09 +00:00
Mark Haines e76068a2a6 Merge branch 'markjh/room_tags' into markjh/client_config 2015-11-20 18:40:56 +00:00
Mark Haines 5bae15d47b Merge branch 'master' into markjh/room_tags 
Conflicts:
	api/client-server/v2_alpha/sync.yaml
 2015-11-20 18:39:15 +00:00
Erik Johnston 46870da57d Add optional profile info and state in search response 2015-11-20 15:29:36 +00:00
Richard van der Hoff d8dd380dfa Merge pull request #164 from matrix-org/rav/SPEC-254 
Fix /sync documentation, post SPEC-254
 2015-11-20 15:17:55 +00:00
Mark Haines 05c0092664 s/config/account_data/ 2015-11-19 10:38:22 +00:00
Richard van der Hoff d7d59d78e1 /sync: Put state dict back to being a list 
Turning the state into a dict-of-dicts caused more pain than it solved. Put it
back to a list.
 2015-11-18 16:17:29 +00:00
Mark Haines 40f7eab73f s/private_user_data/account_data/ 2015-11-18 15:44:18 +00:00
Mark Haines 24c4b8b095 Merge branch 'markjh/room_tags' into markjh/client_config 
Conflicts:
	api/client-server/v1/rooms.yaml
	api/client-server/v1/sync.yaml
	api/client-server/v2_alpha/sync.yaml
	specification/targets.yaml
 2015-11-18 15:30:16 +00:00
Mark Haines fcbb985073 s/private_user_data/account_data/ 2015-11-18 15:27:26 +00:00
Richard van der Hoff 6653362f31 Unflatten 'unsigned' 
It turns out that flattening 'unsigned' comes with too many downsides. Let's
stick with the status quo.
 2015-11-18 15:15:21 +00:00
Daniel Wagner-Hall 6763317e64 Specify /rooms/:room_id/forget 2015-11-17 10:33:46 -05:00
Daniel Wagner-Hall 8201eaa042 Swaggerify /rooms/:room_id/leave 2015-11-17 15:31:10 +00:00
Erik Johnston ffed14a0cd Add next_batch token 2015-11-17 10:02:02 +00:00
Erik Johnston 8991c4fa78 Fix schema and example 2015-11-16 18:00:48 +00:00
Erik Johnston 5e0e4a8518 Document group and context response keys 2015-11-16 17:22:56 +00:00
Mark Haines 299af673da Specify how ordering of tags is supposed to work 2015-11-16 17:04:19 +00:00
Mark Haines 3b390bff3c Merge branch 'master' into markjh/room_tags 
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
 2015-11-16 16:56:35 +00:00
Mark Haines 8f5783615c Merge branch 'master' into markjh/client_config 
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
 2015-11-16 16:51:45 +00:00
Mark Haines 22b3159a39 Add examples of v1 initialSync and v2 /sync returning the client config 2015-11-16 16:34:39 +00:00
Mark Haines 769c5285ab Add API for setting client config 2015-11-16 16:33:57 +00:00
Erik Johnston e2eb0c7ad9 Add new request options 2015-11-16 16:04:23 +00:00
Richard van der Hoff e1b12a753e Fix typos and missing file 2015-11-16 00:17:22 +00:00
Richard van der Hoff 29bd4d45ee Flatten the response to /sync 
Now that we don't expect there to be duplication betwen the 'timeline' and
'state' results, there's no point in having the state map. (That does mean the
events themselves need event_id fields though).

Also:

- move the contents of the 'unsigned' dictionary into the events themselves
- replace the state list with two layers of dictionary keyed on type and
  state_key
- rename the children of the 'rooms' dict from "joined/invited/archived" to
  "join/invite/leave" to match the membership states
 2015-11-16 00:00:48 +00:00
Richard van der Hoff b41d771c15 Fix typos in /sync example response 2015-11-15 23:58:04 +00:00
Richard van der Hoff 57995a815a Fix a number of untruths in the documentation about /sync. 
Attempts to make the /sync documentation better represent fact as it currently
stands - in particular document the structure of the returned events.
 2015-11-15 23:47:35 +00:00
Richard van der Hoff 3f0262081c Update sync API defn to reflect SPEC-254 changes 
State now corresponds to the start of the timeline, not the end.
 2015-11-15 23:47:35 +00:00
Daniel Wagner-Hall 061105c9dc Guest users are allowed room initialSync 2015-11-11 17:18:58 +00:00
Daniel Wagner-Hall dcf54e11b1 Specify /publicRooms world_readable and guest_access 
Depends on https://github.com/matrix-org/matrix-doc/pull/154
 2015-11-11 11:53:31 +00:00
Daniel Wagner-Hall d7357ef9b7 Specify /publicRooms 2015-11-11 11:39:40 +00:00
Daniel Wagner-Hall 24c2036a35 3pid invites: remove mentions of display_name 2015-11-09 17:30:18 +00:00
Daniel Wagner-Hall e72151f2c3 Specify guest room access 
This was reviewed as PR #150 and merged from daniel/anonymousaccess
 2015-11-06 18:15:21 +00:00
Daniel Wagner-Hall 161441fa3a Update 3pid spec based on new implementation 2015-11-05 18:11:20 +00:00
Daniel Wagner-Hall 232b10b0f6 Merge branch 'master' of github.com:matrix-org/matrix-doc 2015-11-05 13:25:51 +00:00
Mark Haines b7cc5b1018 Merge pull request #141 from matrix-org/markjh/full_http_api_docs 
Include the full schema for an http API in the docs
 2015-11-04 16:03:22 +00:00
Mark Haines ebc0237109 Add the missing titles to the schema 2015-11-03 19:35:44 +00:00
Mark Haines d53814097f Add example content to the tags in example tag events 2015-11-03 15:57:06 +00:00
Mark Haines e9d361841b Fix tag examples 2015-11-03 15:42:58 +00:00
Daniel Wagner-Hall 2e3a0b4e00 Specify guest accounts 2015-11-02 15:26:06 +00:00
Mark Haines 52f55e0542 Allow room tags to have asssociated content, and return that content in the m.tag events 2015-11-02 13:31:25 +00:00
Mark Haines f557e69860 Note that m.tag events can appear in v1 initialSync and /events as well as v2 sync. Only add the room_id for v1 /events since it is redundant in v1 /initialSync 2015-11-02 10:13:47 +00:00
Mark Haines ad86426e95 Add private_user_data to v1 room /initialSync 2015-10-30 16:55:18 +00:00
Mark Haines b49472e3b0 Add private_user_data to v1 /initialSync 2015-10-30 16:52:34 +00:00
Mark Haines 451801bf38 Add an example of `prev_content in unsigned` to v2 /sync 2015-10-29 18:40:05 +00:00
Erik Johnston fa2fe2ddd9 Add event context api swagger 2015-10-29 12:43:36 +00:00
Matthew Hodgson 6c1df04b4b typo 2015-10-29 02:11:47 +00:00
Richard van der Hoff ece42688d0 Clarify the interaction between full_state and timeout. 2015-10-26 19:20:58 +00:00
Mark Haines 65066a76b3 Add the m.tags event to a `private_user_data key rather than including it under the ephemeral` key 2015-10-26 18:30:04 +00:00
Mark Haines 12e33a3b09 Document a v2 api for setting tags on rooms 2015-10-26 16:14:24 +00:00
Richard van der Hoff 13eddd456f Proposal for adding full_state param to v2 sync 2015-10-26 15:52:45 +00:00
Kegsay ade0ad5ed1 Merge pull request #129 from matrix-org/erikj/search_actual 
Add filter param to search API
 2015-10-26 10:20:56 +00:00
Erik Johnston 36634df355 Add filter param 2015-10-26 10:19:48 +00:00
Richard van der Hoff f47a49de43 Merge pull request #126 from matrix-org/rav/send_events_api 
Add the room send and state APIs to the spec
 2015-10-23 17:05:30 +01:00
Richard van der Hoff 1945697456 Further tweaks to the room send and state APIs 
- fix confusion re empty/absent state_keys
- move 'types of room events' section earlier in the 'Events' section
- remove some redundant anchors
 2015-10-23 16:58:55 +01:00
Mark Haines 1d7cb6937f Merge pull request #123 from matrix-org/markjh/list_formatting 
Fix list formatting
 2015-10-23 16:53:29 +01:00
Mark Haines 637718108e Add newline before list 2015-10-23 16:52:37 +01:00
Richard van der Hoff 28ab643a4e Remove duplicated registration/login APIs 
Currently the spec duplicates all of the account-management APIs. There's still
work to be done here, but the complete duplication is confusing.
 2015-10-23 15:56:48 +01:00
Richard van der Hoff 587a8ba7ce Merge branch 'master' into rav/send_events_api 2015-10-23 13:48:58 +01:00
Richard van der Hoff d2bbc461e4 mark stateKey as required in room/{id}/state 
Swagger insists that path params be mandatory.
 2015-10-23 13:25:12 +01:00
Richard van der Hoff d18d406c41 Add the room send and state APIs to the spec 2015-10-23 13:08:42 +01:00
Mark Haines cc14620932 Add a newline before the list 2015-10-23 11:36:07 +01:00
Mark Haines e3e8026025 Fix list formatting so that we aren't including everything in blockquotes 2015-10-23 10:51:31 +01:00
Erik Johnston f0c74a9c83 Merge pull request #96 from matrix-org/erikj/search_actual 
Add search API
 2015-10-23 10:19:36 +01:00
Kegan Dougal f95d19cecd Merge branch 'master' into appservice-swagger 
Conflicts:
	specification/application_service_api.rst
 2015-10-21 09:55:53 +01:00
Kegan Dougal 4c3e1b9ed3 Find replace fail 2015-10-21 09:53:25 +01:00
Kegan Dougal bd539c72b4 More review comments 2015-10-21 09:52:44 +01:00
Erik Johnston 1d01f69c3c Merge remote-tracking branch 'origin/master' into erikj/search_actual 2015-10-19 13:46:58 +01:00
Kegan Dougal 26f27d95fb Merge branch 'master' into registration-swagger 
Conflicts:
	specification/client_server_api.rst
 2015-10-19 13:34:41 +01:00
Kegan Dougal f450fc1db6 Typo 2015-10-19 13:32:43 +01:00
Kegan Dougal 4bb042daeb Review comments round II 2015-10-16 15:22:50 +01:00
Kegan Dougal e0fe3c42c8 Review comments 2015-10-16 14:19:00 +01:00
Kegan Dougal 6770d6b2d6 Review comments 2015-10-16 14:05:18 +01:00
Erik Johnston 716c5b7a8b Add 400 and 429 response codes 2015-10-16 10:26:14 +01:00
Kegan Dougal eca98af896 Swaggerify /register endpoint 
Need to move registration/login/auth sections around once #94 lands.
 2015-10-15 16:38:12 +01:00
Erik Johnston cfca4a6c09 s/creteria/criteria/ 2015-10-15 15:51:02 +01:00
Kegan Dougal f20faa80e5 Swagger validation 2015-10-15 14:58:00 +01:00
Kegan Dougal 55cc5c5bb5 Swaggerify application services 2015-10-15 14:53:03 +01:00
Kegan Dougal 5de63b4f45 Merge branch 'master' into proofing 
Conflicts:
	specification/0-intro.rst
 2015-10-15 11:06:30 +01:00
Kegan Dougal 1f2f14dc08 YAML tweaks 2015-10-14 17:07:25 +01:00
Kegan Dougal 84af5776d7 Newlines 2015-10-14 17:02:39 +01:00
Erik Johnston 2b9484cf48 Spell things correctly 2015-10-14 15:35:39 +01:00
Erik Johnston 392a1c5ad8 Another title 2015-10-14 15:06:16 +01:00
Erik Johnston ca9e44baac Moar titles 2015-10-14 15:01:21 +01:00
Erik Johnston a7a5cb088b Add titles 2015-10-14 14:35:08 +01:00
Erik Johnston e42c8b5b63 Add search API 2015-10-14 14:19:11 +01:00
Richard van der Hoff 4a9db39277 Clean up some untruths in the login api doc 
add "type", and "username" -> "user"
 2015-10-14 13:38:28 +01:00
Kegan Dougal 6f6861a11d Swaggerify the createRoom API 2015-10-14 13:17:51 +01:00
Kegan Dougal 41fb0645a9 Add message pagination API 2015-10-14 11:16:58 +01:00
Kegan Dougal 7bdb71b1c9 Tweak the syncing section 
Bring together disparate sections to make it more cohesive.
 2015-10-14 10:25:39 +01:00
Daniel Wagner-Hall 2502ca7ac6 Merge branch 'master' into daniel/threepidinvites-2 
Conflicts:
	specification/targets.yaml
 2015-10-12 18:11:01 +01:00
Kegsay 616f3990aa Merge pull request #87 from matrix-org/module-push 
Push Module
 2015-10-12 17:51:44 +01:00
Kegan Dougal 8f5c796884 Linkify 'pushers' 2015-10-12 17:50:46 +01:00
Mark Haines d42c3195e6 Use 'true' rather than '1' for archived flag 2015-10-08 18:06:52 +01:00
Mark Haines 241096dc81 Add a flag to initial sync to indicate we want rooms that the user has left 2015-10-08 17:25:38 +01:00
Kegan Dougal f2a6950cc3 Minor tweaks; allow objects without props/parents if a title is set 
This allows us to do things like {Tweaks} where Tweaks is defined somewhere
else.
 2015-10-08 16:21:26 +01:00
Daniel Wagner-Hall dc3c02aff5 Review comments 2015-10-08 10:08:38 -05:00
Daniel Wagner-Hall 21a40b317d Merge branch 'master' into daniel/threepidinvites-2 2015-10-08 09:41:17 -05:00
Kegan Dougal 9c95ee5c1f Modify wording and formatting 2015-10-08 15:36:03 +01:00
Kegan Dougal befa23624e It's dangerous to go alone, take this. 2015-10-08 13:41:47 +01:00
Kegan Dougal 65504db7bb Display nested keys on arrays of objects. Make it valid swagger. 2015-10-08 13:40:21 +01:00
Kegan Dougal 31ae4b3859 Swaggerify push notification API 
Edit units.py to support nested JSON request keys
 2015-10-08 13:08:21 +01:00
Kegan Dougal a9618a981b Swaggerify the /enabled endpoint 2015-10-08 11:16:42 +01:00
Kegan Dougal 56ce432399 Get profile tag keys displaying correctly. 2015-10-08 10:14:05 +01:00
Kegan Dougal f6da9d7760 Give valid swagger. Split out rule/ruleset to separate definitions. 2015-10-08 09:57:40 +01:00
Kegan Dougal db25276856 Start adding in push definitions 
This is going to be painful to represent due to how the push API allows
mixed types (strings or objects) and mixed top-level keys ("content" rule kind
allowing "pattern" as a top-level key). We may wish to re-visit the design
of this API for v2.
 2015-10-07 17:44:05 +01:00
Kegan Dougal 9540069acd Use valid JSON 2015-10-07 16:06:11 +01:00
Kegan Dougal c5edc60c4c Add push YAML for pushers endpoint. 
Also display "required" text on required JSON body request params. Also
increase the size of the request param column to support longer param names
present in the pushers API.
 2015-10-07 16:01:36 +01:00
Mark Haines 034241eb20 Missing symlink for the v2 swagger APIs 2015-10-06 17:43:04 +01:00
Mark Haines 509d178d58 Fix the receipts API to be valid swagger 2015-10-06 17:40:45 +01:00
Mark Haines 4f606cf3a7 Add the fields required by the templating system to v2 sync 2015-10-06 17:31:05 +01:00
Mark Haines 5a5a6565ff Merge pull request #68 from matrix-org/markjh/v2_sync_api 
Swagger documentation for the v2 sync API
 2015-10-06 16:51:06 +01:00
Mark Haines 0ce533d153 Split the room_map into separate sections based on whether they are 
"joined/invited/archived".

Rename the room_map to rooms and remove the grouping indirection. When we
want groups then we can add them under a separate key, either at the
top-level or as part of the events themselves.
 2015-10-06 13:42:03 +01:00
Mark Haines 0e5b00feaa Fix event type in v2 sync example 2015-10-05 16:10:25 +01:00
Mark Haines bbb5fa9398 Fix the state_key in the example v2 response, include the "sender" key in the list of keys included with invite_state events 2015-10-05 15:36:01 +01:00
Mark Haines a7b808c5cd Add a invite_state key for holding the state that is bundled with an 
invite. This is kept separate from the actual state for the room as
it may be derived from an incomplete, unverified copy of the state
that was bundled with an invite event received over federation.
 2015-10-05 15:26:33 +01:00
Mark Haines ed0f6d3ff3 Typo 2015-10-05 14:22:50 +01:00
Mark Haines 97cdd8106c s|client/api/v2_alpha|/client/v2_alpha| 2015-10-05 14:21:16 +01:00
Mark Haines 047419f2ad Remove the room_id since it is redundent. Remove text about invite event handling till we've thought about it some more. 2015-10-02 16:21:48 +01:00
Mark Haines bde003fe86 Split the rooms out into a separate top level key. 
Divide the rooms into separate groups in preparation for adding tag
support.

Further subdivide the rooms into "joined/invited/archived" based the
membership of the user in the room because that membership affects what
events the user can view from the room. E.g only users that are joined
to a room may see the ephemeral events for the room.
 2015-10-02 16:14:24 +01:00
Kegsay ead79614ff Merge pull request #78 from matrix-org/module-typing2 
Typing module
 2015-10-02 14:36:30 +01:00
Mark Haines a73cc50aa9 s|client/api/v2_alpha|client/v2_alpha| 2015-10-02 13:03:39 +01:00
Kegan Dougal 09ac367847 Merge branch 'master' into module-content-repo 
Conflicts:
	templating/matrix_templates/units.py
 2015-10-02 10:46:46 +01:00
Kegan Dougal 3d9dbe42e6 Bump to swagger-parser 3.2.1 - remove x- keys on headers 
Removed x- keys due to https://github.com/BigstickCarpet/swagger-parser/issues/23
 2015-10-02 10:21:48 +01:00
Daniel Wagner-Hall af7d2ca9fc Update 3pid invite spec 
This takes into account:
 1) That finding the existing servers of a room is hard
 2) Federation
 2015-10-01 22:19:11 -05:00
Daniel Wagner-Hall d2c56fb7a3 Merge branch 'master' into daniel/threepidinvites-2 2015-10-01 21:18:50 -05:00
Kegan Dougal 8c4d7f5051 Do not try to parse non-json request examples as json 2015-10-01 18:03:34 +01:00
Kegan Dougal 87b6dd845e Flesh out content repo; modify templating to support headers 
Edit content-repo.yaml to include examples and headers.
Restructure content module to conform to the module template.
Adjust the HTTP API template to give 1 more char to the response
param to fit "Content-Disposition" correctly.
Edit the templating system to support displaying enums for
swagger APIs (before it was just JSON schema). Also add support
for introspecting headers from swagger. Finally, replace - with
_ when forming the {{ template_var }} else things whine.
 2015-10-01 17:55:16 +01:00
Kegsay 8aad238cda Merge pull request #80 from matrix-org/module-receipts 
Receipts module
 2015-10-01 17:33:38 +01:00
Kegan Dougal da2be7eae4 Merge branch 'master' into module-voip 
Conflicts:
	specification/modules/voip_events.rst
 2015-10-01 15:48:42 +01:00
Kegan Dougal 1520f3647f Merge branch 'master' into module-typing2 
Conflicts:
	specification/modules/typing_notifications.rst
 2015-10-01 15:47:46 +01:00
Kegan Dougal c972dad8b3 Flesh out receipts module. Add receipts swagger 
Add templating support for v2 apis.
 2015-10-01 15:41:54 +01:00
Kegan Dougal e82661413e Add /turnServer endpoint 2015-10-01 11:04:42 +01:00
Erik Johnston abe5d08ac6 Merge pull request #64 from matrix-org/erikj/invite_state 
Bundle some state into invites
 2015-10-01 09:25:06 +01:00
Kegan Dougal 2b7e02c080 Add sections for typing. Add swagger, JSON schema and example m.typing event 2015-09-30 15:51:04 +01:00
Mark Haines 931057accf Add a top level presence key for the presence events and remove the public_user_data/private_user_data for now 2015-09-30 10:30:39 +01:00
Mark Haines 4cb3f78d2b Wrap the "rooms" list inside an object so that we can add keys for pagination later 2015-09-29 19:48:48 +01:00
Mark Haines 218cf94ead Replace the events array with events_map inside the room objects. 
Only use indirection for the state and timeline events.
Use event_ids to reference the state and timeline events.
 2015-09-29 19:10:31 +01:00
Erik Johnston 50e1b4c3a7 Fix up rst 2015-09-29 09:17:33 +01:00
Mark Haines 6ad6c40147 List the allowed values for the 'event_format' as an enum 2015-09-28 14:11:45 +01:00
Mark Haines 9dd3b07394 Allow '.' characters in event field names to be escaped with '\' so that 
fields including a '.' can be included in a filter.

I considered replacing '.' with '/'. Since '/' was less likely to appear
in event field names. However if we used '\' to escape a literal '/' we
risk confusing it with the JSON escape '\/'.
 2015-09-28 14:10:57 +01:00
Mark Haines 14b42a41d6 Document wildcard's in filters 2015-09-28 13:58:07 +01:00
Mark Haines c115b4c2f4 Document the valid values for the "set_presence" parameter 2015-09-28 13:47:04 +01:00
Mark Haines 940e22940d Document how the "not_foo" keys interact with the "foo" keys 2015-09-28 13:28:58 +01:00
Mark Haines 41bc09ea22 Split the event_filter into a event_filter and a room_event_filter that 
extends it.

So that we don't include "rooms" and "not_rooms" keys for the public_user_data
and private_user_data filters.
 2015-09-28 13:20:01 +01:00
Mark Haines 00fd4aac26 s/publically/publicly/ 2015-09-28 13:06:04 +01:00
Mark Haines 3204c2f2b6 Fix spelling 2015-09-28 13:04:37 +01:00
Mark Haines f50e6d4c0a Add x-example fields for v2 /sync 2015-09-28 13:02:52 +01:00
Mark Haines 1aa916d690 s/indicies/indices/ 2015-09-28 12:52:12 +01:00
Mark Haines 393d283139 Add a "limit" to the timeline key in the example filter 2015-09-28 11:22:31 +01:00
Erik Johnston 8c22b715ca Add title 2015-09-28 09:29:07 +01:00
Mark Haines c3b3b2df63 Add "set_presence" in the sync parameters 2015-09-25 19:37:41 +01:00
Mark Haines de07586ab7 Rename 'events' to 'timeline' in the sync filter 2015-09-25 19:35:44 +01:00
Mark Haines a0068e1ada Draft documention for the v2 sync api 2015-09-25 18:10:28 +01:00
Mark Haines e1f73f5233 Add a limit to filters 2015-09-25 18:09:17 +01:00
Erik Johnston 37ccddb308 Typo 2015-09-25 14:25:07 +01:00
Erik Johnston d7d9f406a6 Bundle some state into invites 2015-09-25 14:21:50 +01:00
Daniel Wagner-Hall cd6f15f627 Remove obsolete comment 2015-09-25 13:34:24 +01:00
Daniel Wagner-Hall 0c1eb50ef4 Merge pull request #26 from matrix-org/macaroons 
Spec macaroons and token refresh
 2015-09-25 13:18:27 +01:00
Daniel Wagner-Hall 6c1491b3ba Respond to some review comments 2015-09-25 13:17:11 +01:00
Daniel Wagner-Hall 5c4398c181 Remove superfluous comma 2015-09-25 13:10:49 +01:00
Daniel Wagner-Hall fc87f4cdb0 Remove unused keys 2015-09-25 13:10:15 +01:00
Daniel Wagner-Hall 6c89e6ea67 Wrap refresh_token in `s 2015-09-25 13:03:46 +01:00
Mark Haines f34722485f Check the request example JSON matches the schema 2015-09-24 16:50:27 +01:00
Mark Haines a31a446661 Fix the POST example for the v2 filter API 2015-09-24 16:48:00 +01:00
Mark Haines 69298b9612 Check "v2_alpha" in jenkins 2015-09-24 16:29:51 +01:00
Mark Haines 883105eae6 Document the v2 filter GET API 2015-09-24 16:25:03 +01:00