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

542 commits

Author SHA1 Message Date
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