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

482 commits

Author SHA1 Message Date
Erik Johnston d66792d5ca Mention order of returned results 2016-10-14 10:31:06 +01:00
Richard van der Hoff af515012ea Device management API 2016-10-12 17:26:01 +01:00
Richard van der Hoff 9265b03008 Client device doc 
Document client devices, and the mods to the login and register apis to support
them.
 2016-10-12 17:26:01 +01:00
Erik Johnston a69d6c63c6 Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/public_rooms 2016-10-11 14:31:47 +01:00
Erik Johnston cafa9a01fd Move explanation of lack of direction param 2016-10-11 14:29:20 +01:00
Erik Johnston 71c1fc5ec0 Remove spurious 400 result 2016-10-11 14:28:32 +01:00
Erik Johnston de68c167b6 Add tags for GET endpoint 2016-10-11 14:27:53 +01:00
Erik Johnston 9d0960b206 Better wording 2016-10-11 14:24:46 +01:00
Richard van der Hoff 42616f839c Merge pull request #396 from matrix-org/dbkr/notifs_api 
Spec notifs API
 2016-10-06 17:21:47 +01:00
Richard van der Hoff 909aef2b18 Merge pull request #389 from matrix-org/erikj/create_room_is_direct 
Spec /createRoom is_direct flag, is_direct in member event and m.direct
 2016-10-06 17:19:48 +01:00
David Baker e0a434b248 Aaha, found a syntax that swagger will accept! 2016-10-06 11:20:05 +01:00
David Baker bd753d4bf4 Re-add required flags the correct way 2016-10-05 18:53:08 +01:00
David Baker af2c74c186 Revert requireds 
They're not boolean flags for object fields
 2016-10-05 18:50:14 +01:00
David Baker 14944fe237 More PR feedback 2016-10-05 18:26:42 +01:00
David Baker fd8c1a43c7 ms, not s. Also add required flags 2016-10-05 18:22:03 +01:00
David Baker b789251f70 More PR feedback 2016-10-05 12:59:49 +01:00
David Baker 4a020025bc Make swagger happpy 
These aren't strings, but 'any' causes swagger to break and
leaving it out makes the doc fail to build.
 2016-10-05 11:51:48 +01:00
David Baker b4c89accb2 Params in query, not path 2016-10-05 11:48:14 +01:00
David Baker a463820d83 Typo 2016-10-05 11:21:56 +01:00
David Baker c1fa342b90 Swagger is failing on type 'any' 2016-10-05 11:21:06 +01:00
David Baker 136d5dc9ad Almost valid... 2016-10-05 11:15:33 +01:00
David Baker 595b75f299 Try & make example closer to valid 2016-10-05 10:32:03 +01:00
David Baker 41781e95b2 Attempt valid json 2016-10-05 10:21:29 +01:00
David Baker c16ba9488f Spec notifs API 2016-10-05 10:15:49 +01:00
Richard van der Hoff 37fb1ceb65 Merge pull request #395 from matrix-org/rav/kill_refresh_tokens 
Remove references to refresh tokens and tokenrefresh
 2016-10-04 17:55:38 +01:00
David Baker 1d7531e9a1 Typo 2016-10-04 17:51:35 +01:00
David Baker d39f662df5 PR feedback 2016-10-04 11:57:24 +01:00
Richard van der Hoff 556ced36a4 Merge remote-tracking branch 'origin/master' into rav/store_and_forward 2016-10-04 11:55:05 +01:00
David Baker 8fe8bd6a81 Add is_direct to member event spec. 2016-10-03 17:33:45 +01:00
Richard van der Hoff f4c7fdfd03 Remove references to refresh tokens and tokenrefresh 
refresh tokens are dead.
 2016-10-03 17:05:56 +01:00
David Baker 5fedc64230 double space 2016-10-03 15:52:08 +01:00
David Baker ae1c576648 Merge remote-tracking branch 'origin/master' into erikj/create_room_is_direct 2016-10-03 15:17:55 +01:00
Erik Johnston 069aa86a10 Update wording and add example to filter param 2016-09-30 15:06:11 +01:00
Erik Johnston 7919e8e159 Update wording. 2016-09-30 15:02:27 +01:00
Erik Johnston a5bb182c67 Explicitly mention that directio of pagination is specified by the token 2016-09-30 14:30:13 +01:00
Erik Johnston a66a744c45 Fix typo. Change responses in both places 2016-09-30 14:28:40 +01:00
Erik Johnston 06649b652d Mark booleans as required. Remove mention that things may be null 2016-09-30 14:18:13 +01:00
Erik Johnston b121feebce Comment what the is_direct flag actually does 2016-09-30 11:24:51 +01:00
Erik Johnston e8b21f357f Explicitlty mention total_room_count_estimate 2016-09-29 17:18:34 +01:00
Erik Johnston e854757c98 Mark required fields as required 2016-09-29 17:12:52 +01:00
Erik Johnston 0dc94d5c14 Expand on description of pagination tokens 2016-09-29 16:58:00 +01:00
Erik Johnston 37f6769a3c Spec filter param on /messagse 2016-09-29 13:40:20 +01:00
Erik Johnston 085131b617 Add contains_url filter option 2016-09-29 13:37:08 +01:00
Richard van der Hoff ebaaa7e3b3 Review feedback 
* store-and-forward -> send-to-device
* describe motivation
* device ids are 10 capital chars
* etc
 2016-09-29 13:18:45 +01:00
Erik Johnston 3a5cbd14c3 Add /createRoom is_direct flag 2016-09-29 11:25:12 +01:00
Erik Johnston c05ee18f58 Add title and update description 2016-09-29 11:06:57 +01:00
Erik Johnston 130ea85576 Spec POST /publicRooms 2016-09-29 11:01:36 +01:00
Erik Johnston 877a6cfeb4 Spec new query params for /publicRooms 2016-09-29 10:47:37 +01:00
Erik Johnston d81d0dbd1d Spec canonical alias key 2016-09-29 10:35:04 +01:00
Richard van der Hoff ccd7bb32d5 Specification for direct-to-device messages 2016-09-27 14:27:27 +01:00
Benjamin Saunders cade909e25 Fix inconsistencies regarding redacted_because 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-08-30 21:18:55 -07:00
Richard van der Hoff 7478e7f3cf Add top-level account_data to /sync response 2016-08-30 17:43:20 +01:00
Benjamin Saunders 77b668a5dc Fix some obsolete uses of user_id key in events 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-08-26 23:06:41 -07:00
Matthew Hodgson 978d9ea6dd fix the descriptions of the /room/.../state APIs to not be the wrong way round 2016-08-18 14:04:21 +01:00
Richard van der Hoff c51c4acf7f Clarifications to authentication mechanisms 
* Make the purpose of the `auth` key in /register requests explicit, and say
  that it should be empty at first.

* Restructure the UA-auth section a bit.

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

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

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

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