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

382 commits

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