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

237 commits

Author SHA1 Message Date
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
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
Daniel Wagner-Hall
5e30b5b8d7 Remove POST version of /send 
PUT should always be used.
 2015-11-26 16:46:29 +00:00
Daniel Wagner-Hall
c25a806cef Fix and include /directory api docs 2015-11-26 15:03:39 +00:00
Mark Haines
5ccc39b850 Say that type is an event type 2015-11-20 18:45:09 +00:00
Mark Haines
e76068a2a6 Merge branch 'markjh/room_tags' into markjh/client_config 2015-11-20 18:40:56 +00:00
Mark Haines
5bae15d47b Merge branch 'master' into markjh/room_tags 
Conflicts:
	api/client-server/v2_alpha/sync.yaml
 2015-11-20 18:39:15 +00:00
Richard van der Hoff
d8dd380dfa Merge pull request #164 from matrix-org/rav/SPEC-254 
Fix /sync documentation, post SPEC-254
 2015-11-20 15:17:55 +00:00
Mark Haines
05c0092664 s/config/account_data/ 2015-11-19 10:38:22 +00:00
Richard van der Hoff
d7d59d78e1 /sync: Put state dict back to being a list 
Turning the state into a dict-of-dicts caused more pain than it solved. Put it
back to a list.
 2015-11-18 16:17:29 +00:00
Mark Haines
40f7eab73f s/private_user_data/account_data/ 2015-11-18 15:44:18 +00:00
Mark Haines
24c4b8b095 Merge branch 'markjh/room_tags' into markjh/client_config 
Conflicts:
	api/client-server/v1/rooms.yaml
	api/client-server/v1/sync.yaml
	api/client-server/v2_alpha/sync.yaml
	specification/targets.yaml
 2015-11-18 15:30:16 +00:00
Mark Haines
fcbb985073 s/private_user_data/account_data/ 2015-11-18 15:27:26 +00:00
Richard van der Hoff
6653362f31 Unflatten 'unsigned' 
It turns out that flattening 'unsigned' comes with too many downsides. Let's
stick with the status quo.
 2015-11-18 15:15:21 +00:00
Daniel Wagner-Hall
6763317e64 Specify /rooms/:room_id/forget 2015-11-17 10:33:46 -05:00
Daniel Wagner-Hall
8201eaa042 Swaggerify /rooms/:room_id/leave 2015-11-17 15:31:10 +00:00
Mark Haines
299af673da Specify how ordering of tags is supposed to work 2015-11-16 17:04:19 +00:00
Mark Haines
3b390bff3c Merge branch 'master' into markjh/room_tags 
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
 2015-11-16 16:56:35 +00:00
Mark Haines
8f5783615c Merge branch 'master' into markjh/client_config 
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
 2015-11-16 16:51:45 +00:00
Mark Haines
22b3159a39 Add examples of v1 initialSync and v2 /sync returning the client config 2015-11-16 16:34:39 +00:00
Mark Haines
769c5285ab Add API for setting client config 2015-11-16 16:33:57 +00:00
Richard van der Hoff
e1b12a753e Fix typos and missing file 2015-11-16 00:17:22 +00:00
Richard van der Hoff
29bd4d45ee Flatten the response to /sync 
Now that we don't expect there to be duplication betwen the 'timeline' and
'state' results, there's no point in having the state map. (That does mean the
events themselves need event_id fields though).

Also:

- move the contents of the 'unsigned' dictionary into the events themselves
- replace the state list with two layers of dictionary keyed on type and
  state_key
- rename the children of the 'rooms' dict from "joined/invited/archived" to
  "join/invite/leave" to match the membership states
 2015-11-16 00:00:48 +00:00
Richard van der Hoff
b41d771c15 Fix typos in /sync example response 2015-11-15 23:58:04 +00:00