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

697 commits

Author SHA1 Message Date
Kegan Dougal
8c4d7f5051 Do not try to parse non-json request examples as json 2015-10-01 18:03:34 +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
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
Erik Johnston
8c22b715ca Add title 2015-09-28 09:29:07 +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
Erik Johnston
37ccddb308 Typo 2015-09-25 14:25:07 +01:00
Erik Johnston
d7d9f406a6 Bundle some state into invites 2015-09-25 14:21:50 +01:00
Daniel Wagner-Hall
cd6f15f627 Remove obsolete comment 2015-09-25 13:34:24 +01:00
Daniel Wagner-Hall
0c1eb50ef4 Merge pull request #26 from matrix-org/macaroons 
Spec macaroons and token refresh
 2015-09-25 13:18:27 +01:00
Daniel Wagner-Hall
6c1491b3ba Respond to some review comments 2015-09-25 13:17:11 +01:00
Daniel Wagner-Hall
5c4398c181 Remove superfluous comma 2015-09-25 13:10:49 +01:00
Daniel Wagner-Hall
fc87f4cdb0 Remove unused keys 2015-09-25 13:10:15 +01:00
Daniel Wagner-Hall
6c89e6ea67 Wrap refresh_token in `s 2015-09-25 13:03:46 +01:00
Mark Haines
f34722485f Check the request example JSON matches the schema 2015-09-24 16:50:27 +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
Mark Haines
385b6c4759 Only validate a file if it ends with ".yaml". 
Otherwise we try to validate vim .swp files.
 2015-09-24 13:37:32 +01:00
Mark Haines
98d91d0c2b Make the example room id more "random" so that people are less likely to think that it is supposed to be human readable 2015-09-21 17:31:35 +01:00
Mark Haines
f60190086a Describe the behaviour of /rooms/{roomId}/member when the user has left the room 2015-09-21 17:30:10 +01:00
Mark Haines
ba6c7d267c SPEC-216: Document the behaviour of the room getters when the user has left the room 2015-09-21 17:21:01 +01:00
Mark Haines
615a9575cb SPEC-216: Clarify when the room getters will return 403 2015-09-21 17:12:29 +01:00
Mark Haines
cb41adee70 Fix the swagger host to be "localhost:8008" so that it can be used in a "Try it now" setup against localhost 2015-09-21 17:10:23 +01:00
Mark Haines
6a2c4d27fc Update the docs for room v1 api 2015-09-18 17:58:44 +01:00
Mark Haines
f33c0846c3 Merge remote-tracking branch 'origin/master' into markjh/document_v1_rooms_api 2015-09-18 17:38:03 +01:00