wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
1664 commits 4 branches 0 tags 17 MiB
Commit graph

362 commits

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