Commit graph

36 commits

Author SHA1 Message Date
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
Mark Haines c115b4c2f4 Document the valid values for the "set_presence" parameter 2015-09-28 13:47:04 +01:00
Mark Haines 940e22940d Document how the "not_foo" keys interact with the "foo" keys 2015-09-28 13:28:58 +01:00
Mark Haines 41bc09ea22 Split the event_filter into a event_filter and a room_event_filter that
extends it.

So that we don't include "rooms" and "not_rooms" keys for the public_user_data
and private_user_data filters.
2015-09-28 13:20:01 +01:00
Mark Haines 00fd4aac26 s/publically/publicly/ 2015-09-28 13:06:04 +01:00
Mark Haines 3204c2f2b6 Fix spelling 2015-09-28 13:04:37 +01:00
Mark Haines f50e6d4c0a Add x-example fields for v2 /sync 2015-09-28 13:02:52 +01:00
Mark Haines 1aa916d690 s/indicies/indices/ 2015-09-28 12:52:12 +01:00
Mark Haines 393d283139 Add a "limit" to the timeline key in the example filter 2015-09-28 11:22:31 +01:00
Mark Haines c3b3b2df63 Add "set_presence" in the sync parameters 2015-09-25 19:37:41 +01:00
Mark Haines de07586ab7 Rename 'events' to 'timeline' in the sync filter 2015-09-25 19:35:44 +01:00
Mark Haines a0068e1ada Draft documention for the v2 sync api 2015-09-25 18:10:28 +01:00
Mark Haines e1f73f5233 Add a limit to filters 2015-09-25 18:09:17 +01:00
Mark Haines a31a446661 Fix the POST example for the v2 filter API 2015-09-24 16:48:00 +01:00
Mark Haines 69298b9612 Check "v2_alpha" in jenkins 2015-09-24 16:29:51 +01:00
Mark Haines 883105eae6 Document the v2 filter GET API 2015-09-24 16:25:03 +01:00
Mark Haines 2f039a1142 Add swagger docs for the v2 filter POST API 2015-09-24 15:39:17 +01:00