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

465 commits

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