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

114 commits

Author SHA1 Message Date
Kegsay
616f3990aa Merge pull request #87 from matrix-org/module-push 
Push Module
 2015-10-12 17:51:44 +01:00
Kegan Dougal
8f5c796884 Linkify 'pushers' 2015-10-12 17:50:46 +01:00
Mark Haines
d42c3195e6 Use 'true' rather than '1' for archived flag 2015-10-08 18:06:52 +01:00
Mark Haines
241096dc81 Add a flag to initial sync to indicate we want rooms that the user has left 2015-10-08 17:25:38 +01:00
Kegan Dougal
f2a6950cc3 Minor tweaks; allow objects without props/parents if a title is set 
This allows us to do things like {Tweaks} where Tweaks is defined somewhere
else.
 2015-10-08 16:21:26 +01:00
Kegan Dougal
9c95ee5c1f Modify wording and formatting 2015-10-08 15:36:03 +01:00
Kegan Dougal
befa23624e It's dangerous to go alone, take this. 2015-10-08 13:41:47 +01:00
Kegan Dougal
65504db7bb Display nested keys on arrays of objects. Make it valid swagger. 2015-10-08 13:40:21 +01:00
Kegan Dougal
31ae4b3859 Swaggerify push notification API 
Edit units.py to support nested JSON request keys
 2015-10-08 13:08:21 +01:00
Kegan Dougal
a9618a981b Swaggerify the /enabled endpoint 2015-10-08 11:16:42 +01:00
Kegan Dougal
56ce432399 Get profile tag keys displaying correctly. 2015-10-08 10:14:05 +01:00
Kegan Dougal
f6da9d7760 Give valid swagger. Split out rule/ruleset to separate definitions. 2015-10-08 09:57:40 +01:00
Kegan Dougal
db25276856 Start adding in push definitions 
This is going to be painful to represent due to how the push API allows
mixed types (strings or objects) and mixed top-level keys ("content" rule kind
allowing "pattern" as a top-level key). We may wish to re-visit the design
of this API for v2.
 2015-10-07 17:44:05 +01:00
Kegan Dougal
9540069acd Use valid JSON 2015-10-07 16:06:11 +01:00
Kegan Dougal
c5edc60c4c Add push YAML for pushers endpoint. 
Also display "required" text on required JSON body request params. Also
increase the size of the request param column to support longer param names
present in the pushers API.
 2015-10-07 16:01:36 +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
Kegsay
ead79614ff Merge pull request #78 from matrix-org/module-typing2 
Typing module
 2015-10-02 14:36:30 +01:00
Mark Haines
a73cc50aa9 s|client/api/v2_alpha|client/v2_alpha| 2015-10-02 13:03:39 +01:00
Kegan Dougal
09ac367847 Merge branch 'master' into module-content-repo 
Conflicts:
	templating/matrix_templates/units.py
 2015-10-02 10:46:46 +01:00
Kegan Dougal
3d9dbe42e6 Bump to swagger-parser 3.2.1 - remove x- keys on headers 
Removed x- keys due to https://github.com/BigstickCarpet/swagger-parser/issues/23
 2015-10-02 10:21:48 +01:00
Kegan Dougal
87b6dd845e Flesh out content repo; modify templating to support headers 
Edit content-repo.yaml to include examples and headers.
Restructure content module to conform to the module template.
Adjust the HTTP API template to give 1 more char to the response
param to fit "Content-Disposition" correctly.
Edit the templating system to support displaying enums for
swagger APIs (before it was just JSON schema). Also add support
for introspecting headers from swagger. Finally, replace - with
_ when forming the {{ template_var }} else things whine.
 2015-10-01 17:55:16 +01:00
Kegsay
8aad238cda Merge pull request #80 from matrix-org/module-receipts 
Receipts module
 2015-10-01 17:33:38 +01:00
Kegan Dougal
da2be7eae4 Merge branch 'master' into module-voip 
Conflicts:
	specification/modules/voip_events.rst
 2015-10-01 15:48:42 +01:00
Kegan Dougal
1520f3647f Merge branch 'master' into module-typing2 
Conflicts:
	specification/modules/typing_notifications.rst
 2015-10-01 15:47:46 +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
Kegan Dougal
e82661413e Add /turnServer endpoint 2015-10-01 11:04:42 +01:00
Erik Johnston
abe5d08ac6 Merge pull request #64 from matrix-org/erikj/invite_state 
Bundle some state into invites
 2015-10-01 09:25:06 +01:00
Kegan Dougal
2b7e02c080 Add sections for typing. Add swagger, JSON schema and example m.typing event 2015-09-30 15:51:04 +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
Erik Johnston
50e1b4c3a7 Fix up rst 2015-09-29 09:17:33 +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