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

203 commits

Author SHA1 Message Date
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
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
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
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
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
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
Richard van der Hoff
57995a815a Fix a number of untruths in the documentation about /sync. 
Attempts to make the /sync documentation better represent fact as it currently
stands - in particular document the structure of the returned events.
 2015-11-15 23:47:35 +00:00
Richard van der Hoff
3f0262081c Update sync API defn to reflect SPEC-254 changes 
State now corresponds to the start of the timeline, not the end.
 2015-11-15 23:47:35 +00:00
Daniel Wagner-Hall
061105c9dc Guest users are allowed room initialSync 2015-11-11 17:18:58 +00:00
Daniel Wagner-Hall
dcf54e11b1 Specify /publicRooms world_readable and guest_access 
Depends on https://github.com/matrix-org/matrix-doc/pull/154
 2015-11-11 11:53:31 +00:00
Daniel Wagner-Hall
d7357ef9b7 Specify /publicRooms 2015-11-11 11:39:40 +00:00
Daniel Wagner-Hall
24c2036a35 3pid invites: remove mentions of display_name 2015-11-09 17:30:18 +00:00
Daniel Wagner-Hall
e72151f2c3 Specify guest room access 
This was reviewed as PR #150 and merged from daniel/anonymousaccess
 2015-11-06 18:15:21 +00:00
Daniel Wagner-Hall
161441fa3a Update 3pid spec based on new implementation 2015-11-05 18:11:20 +00:00
Daniel Wagner-Hall
232b10b0f6 Merge branch 'master' of github.com:matrix-org/matrix-doc 2015-11-05 13:25:51 +00:00
Mark Haines
b7cc5b1018 Merge pull request #141 from matrix-org/markjh/full_http_api_docs 
Include the full schema for an http API in the docs
 2015-11-04 16:03:22 +00:00
Mark Haines
ebc0237109 Add the missing titles to the schema 2015-11-03 19:35:44 +00:00
Mark Haines
d53814097f Add example content to the tags in example tag events 2015-11-03 15:57:06 +00:00
Mark Haines
e9d361841b Fix tag examples 2015-11-03 15:42:58 +00:00
Daniel Wagner-Hall
2e3a0b4e00 Specify guest accounts 2015-11-02 15:26:06 +00:00
Mark Haines
52f55e0542 Allow room tags to have asssociated content, and return that content in the m.tag events 2015-11-02 13:31:25 +00:00
Mark Haines
f557e69860 Note that m.tag events can appear in v1 initialSync and /events as well as v2 sync. Only add the room_id for v1 /events since it is redundant in v1 /initialSync 2015-11-02 10:13:47 +00:00
Mark Haines
ad86426e95 Add private_user_data to v1 room /initialSync 2015-10-30 16:55:18 +00:00
Mark Haines
b49472e3b0 Add private_user_data to v1 /initialSync 2015-10-30 16:52:34 +00:00
Mark Haines
451801bf38 Add an example of `prev_content in unsigned` to v2 /sync 2015-10-29 18:40:05 +00:00
Matthew Hodgson
6c1df04b4b typo 2015-10-29 02:11:47 +00:00
Richard van der Hoff
ece42688d0 Clarify the interaction between full_state and timeout. 2015-10-26 19:20:58 +00:00
Mark Haines
65066a76b3 Add the m.tags event to a `private_user_data key rather than including it under the ephemeral` key 2015-10-26 18:30:04 +00:00
Mark Haines
12e33a3b09 Document a v2 api for setting tags on rooms 2015-10-26 16:14:24 +00:00
Richard van der Hoff
13eddd456f Proposal for adding full_state param to v2 sync 2015-10-26 15:52:45 +00:00
Kegsay
ade0ad5ed1 Merge pull request #129 from matrix-org/erikj/search_actual 
Add filter param to search API
 2015-10-26 10:20:56 +00:00
Erik Johnston
36634df355 Add filter param 2015-10-26 10:19:48 +00:00
Richard van der Hoff
f47a49de43 Merge pull request #126 from matrix-org/rav/send_events_api 
Add the room send and state APIs to the spec
 2015-10-23 17:05:30 +01:00
Richard van der Hoff
1945697456 Further tweaks to the room send and state APIs 
- fix confusion re empty/absent state_keys
- move 'types of room events' section earlier in the 'Events' section
- remove some redundant anchors
 2015-10-23 16:58:55 +01:00
Mark Haines
1d7cb6937f Merge pull request #123 from matrix-org/markjh/list_formatting 
Fix list formatting
 2015-10-23 16:53:29 +01:00
Mark Haines
637718108e Add newline before list 2015-10-23 16:52:37 +01:00
Richard van der Hoff
28ab643a4e Remove duplicated registration/login APIs 
Currently the spec duplicates all of the account-management APIs. There's still
work to be done here, but the complete duplication is confusing.
 2015-10-23 15:56:48 +01:00
Richard van der Hoff
587a8ba7ce Merge branch 'master' into rav/send_events_api 2015-10-23 13:48:58 +01:00
Richard van der Hoff
d2bbc461e4 mark stateKey as required in room/{id}/state 
Swagger insists that path params be mandatory.
 2015-10-23 13:25:12 +01:00
Richard van der Hoff
d18d406c41 Add the room send and state APIs to the spec 2015-10-23 13:08:42 +01:00