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

66 commits

Author SHA1 Message Date
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
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
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
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
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
Mark Haines
1d7cb6937f Merge pull request #123 from matrix-org/markjh/list_formatting 
Fix list formatting
 2015-10-23 16:53:29 +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
Mark Haines
e3e8026025 Fix list formatting so that we aren't including everything in blockquotes 2015-10-23 10:51:31 +01:00
Kegan Dougal
f450fc1db6 Typo 2015-10-19 13:32:43 +01:00
Kegan Dougal
e0fe3c42c8 Review comments 2015-10-16 14:19:00 +01:00
Kegan Dougal
eca98af896 Swaggerify /register endpoint 
Need to move registration/login/auth sections around once #94 lands.
 2015-10-15 16:38:12 +01:00
Mark Haines
034241eb20 Missing symlink for the v2 swagger APIs 2015-10-06 17:43:04 +01:00
Mark Haines
509d178d58 Fix the receipts API to be valid swagger 2015-10-06 17:40:45 +01:00
Mark Haines
4f606cf3a7 Add the fields required by the templating system to v2 sync 2015-10-06 17:31:05 +01:00
Mark Haines
5a5a6565ff Merge pull request #68 from matrix-org/markjh/v2_sync_api 
Swagger documentation for the v2 sync API
 2015-10-06 16:51:06 +01:00
Mark Haines
0ce533d153 Split the room_map into separate sections based on whether they are 
"joined/invited/archived".

Rename the room_map to rooms and remove the grouping indirection. When we
want groups then we can add them under a separate key, either at the
top-level or as part of the events themselves.
 2015-10-06 13:42:03 +01:00
Mark Haines
0e5b00feaa Fix event type in v2 sync example 2015-10-05 16:10:25 +01:00
Mark Haines
bbb5fa9398 Fix the state_key in the example v2 response, include the "sender" key in the list of keys included with invite_state events 2015-10-05 15:36:01 +01:00
Mark Haines
a7b808c5cd Add a invite_state key for holding the state that is bundled with an 
invite. This is kept separate from the actual state for the room as
it may be derived from an incomplete, unverified copy of the state
that was bundled with an invite event received over federation.
 2015-10-05 15:26:33 +01:00
Mark Haines
ed0f6d3ff3 Typo 2015-10-05 14:22:50 +01:00
Mark Haines
97cdd8106c s|client/api/v2_alpha|/client/v2_alpha| 2015-10-05 14:21:16 +01:00
Mark Haines
047419f2ad Remove the room_id since it is redundent. Remove text about invite event handling till we've thought about it some more. 2015-10-02 16:21:48 +01:00
Mark Haines
bde003fe86 Split the rooms out into a separate top level key. 
Divide the rooms into separate groups in preparation for adding tag
support.

Further subdivide the rooms into "joined/invited/archived" based the
membership of the user in the room because that membership affects what
events the user can view from the room. E.g only users that are joined
to a room may see the ephemeral events for the room.
 2015-10-02 16:14:24 +01:00
Mark Haines
a73cc50aa9 s|client/api/v2_alpha|client/v2_alpha| 2015-10-02 13:03:39 +01:00
Kegan Dougal
c972dad8b3 Flesh out receipts module. Add receipts swagger 
Add templating support for v2 apis.
 2015-10-01 15:41:54 +01:00
Mark Haines
931057accf Add a top level presence key for the presence events and remove the public_user_data/private_user_data for now 2015-09-30 10:30:39 +01:00
Mark Haines
4cb3f78d2b Wrap the "rooms" list inside an object so that we can add keys for pagination later 2015-09-29 19:48:48 +01:00
Mark Haines
218cf94ead Replace the events array with events_map inside the room objects. 
Only use indirection for the state and timeline events.
Use event_ids to reference the state and timeline events.
 2015-09-29 19:10:31 +01:00
Mark Haines
6ad6c40147 List the allowed values for the 'event_format' as an enum 2015-09-28 14:11:45 +01:00
Mark Haines
9dd3b07394 Allow '.' characters in event field names to be escaped with '\' so that 
fields including a '.' can be included in a filter.

I considered replacing '.' with '/'. Since '/' was less likely to appear
in event field names. However if we used '\' to escape a literal '/' we
risk confusing it with the JSON escape '\/'.
 2015-09-28 14:10:57 +01:00
Mark Haines
14b42a41d6 Document wildcard's in filters 2015-09-28 13:58:07 +01:00