Commit graph

2487 commits

Author SHA1 Message Date
Mark Haines c83e8480e8 Fix JSON syntax 2015-07-24 15:55:21 +01:00
Mark Haines 6597aaa448 Start describing the plaintext payload format for encrypted messages, add the exact URLs used for key queries from clients and for key queries for federation 2015-07-24 11:21:14 +01:00
Mark Haines 41d204e72c Name the key 'ciphertext' rather than 'ciphertexts' 2015-07-24 09:43:46 +01:00
Mark Haines 6f69707c71 Update e2e spec: Group ciphertext by device key rather than device id, add return to docs for /keys/upload, Use "m.room.encrypted" for now, rather than trying to add an encrypted content to arbitrary event types 2015-07-17 19:30:36 +01:00
Mark Haines 42ad1f8612 Add a link to signing JSON section of the spec. Fixup the markup a bit 2015-07-14 09:38:08 +01:00
Mark Haines 01927cee9b Rename "take" to "claim". Hyphenate "one-time". 2015-07-14 09:21:25 +01:00
Mark Haines 36e035c79e Add some specification for end-to-end 2015-07-13 19:31:11 +01:00
Matthew Hodgson f08588bf7e typo 2015-07-09 23:17:38 +01:00
Paul "LeoNerd" Evans 5f391b5617 Also document the directory server federation API 2015-07-09 20:28:48 +01:00
Paul "LeoNerd" Evans fc1e01f373 Add a small note about the meaning of the 'target' field 2015-07-09 19:52:34 +01:00
Paul "LeoNerd" Evans af1616ba9a Merge branch 'master' into paul/fixes 2015-07-09 19:52:03 +01:00
Mark Haines c998666e56 Merge pull request #22 from matrix-org/paul/small-fixes
Bugfix to embedded sign_json() python code
2015-07-06 15:28:46 +01:00
Paul "LeoNerd" Evans 28894ac1b7 Bugfix to embedded sign_json() python code 2015-07-03 20:11:27 +01:00
Paul "LeoNerd" Evans 9b046cbc04 Tiny fix to embedded YAML fragment 2015-06-08 18:21:11 +01:00
Kegan Dougal e572cc662a Restructure the first few sections.
Remove unecessary sections; put presnece/profile sections on the right level.
Move Living Standard warning to the top of the Introduction section.
2015-06-02 16:27:52 +01:00
Kegan Dougal 71e200a063 Remove version section. 2015-06-02 16:12:23 +01:00
Kegan Dougal c42bfabaad Order the status API before presence lists because it is more important. 2015-06-02 16:12:23 +01:00
Matthew Hodgson 25563281d9 alas clarify the room link 2015-06-02 16:11:27 +01:00
Kegan Dougal e10859a887 Replace presence API with new template. 2015-06-02 16:01:26 +01:00
Kegan Dougal 334e10468d Add presence swagger and template. 2015-06-02 15:10:44 +01:00
Kegan Dougal ec631c60d4 Add link to github commit for the spec as per request. 2015-06-02 13:48:52 +01:00
Kegan Dougal 876a3d2bbc Add package.json 2015-06-02 13:32:22 +01:00
Kegan Dougal 3d70404b94 Update swagger validator to support directories.
This will be used with Jenkins.
2015-06-02 13:28:58 +01:00
Kegan Dougal 14d004146b Implement nested tables for HTTP APIs. It even works(!) 2015-06-02 12:03:10 +01:00
Kegan Dougal 0275c2ffa0 Add sync API yaml. Add template for sync_http_api. 2015-06-02 11:44:27 +01:00
Kegan Dougal bb9537b824 Add a CHANGELOG. Modify table CSS.
Hook up templating system to read the CHANGELOG for version and changelog info.
Modified nature.css to make it clearer on table headings/sub-headings. Use the
full _matrix/client path on title links to make it clear it is for v1.
2015-06-01 17:48:16 +01:00
Kegan Dougal 8a676a2b9d Add sortFn for profile HTTP API. Add combined profile HTTP API. 2015-06-01 16:29:19 +01:00
Kegan Dougal 704cd14030 Add in response format for APIs. Standardise on 'key' rather than 'name'. 2015-06-01 15:54:16 +01:00
Kegan Dougal f6c98f41e9 Use table subsections for param locations instead of an extra column. 2015-06-01 15:26:48 +01:00
Kegan Dougal ba6ce16509 Modify how descriptions are shown. Add profile API descriptions. 2015-06-01 14:34:13 +01:00
Kegan Dougal 862f5a3a53 Add structure for adding examples to HTTP APIs.
Use 'x-example' to add examples to parameters which are not in 'body' (swagger
doesn't define that currently). Add profile API examples. Add necessary glue
and templates to make it all work.
2015-06-01 14:20:24 +01:00
Kegan Dougal c75fd6bcae Add HTTP API wip template. 2015-06-01 12:03:42 +01:00
Kegan Dougal 5795e1ceda Add profile API examples and extract examples for template usage. 2015-06-01 10:44:03 +01:00
Kegan Dougal fe7ffafc15 Factor out json schema object processing since swagger uses it too. Hook swagger up. 2015-05-29 17:19:45 +01:00
Kegan Dougal d090389d01 Start pre-processing swagger APIs before passing to sections. 2015-05-29 16:50:22 +01:00
Kegan Dougal 1dc3d82664 Load swagger APIs as templating units. Check sections return strings. 2015-05-29 15:58:33 +01:00
Kegan Dougal 99dfe64d5c Add rate-limiting on APIs which rate limit. More descriptions. 2015-05-29 15:48:48 +01:00
Kegan Dougal f72319e256 Add profile API. Add error definition to definitions folder.
The tool used for validating swagger 2.0 schemata does not currently
support deep-nested definitions from other files. Until it does, keep
the definitions in a separate file each in a definitions folder. This
will be replaced with a definitions.yaml in the future.
2015-05-29 15:37:44 +01:00
Kegan Dougal aeaa43811c Add security definitions for directory API. 2015-05-29 15:18:09 +01:00
Kegan Dougal 870d1b8944 Add Swagger 2 directory API. 2015-05-29 14:31:05 +01:00
Kegan Dougal caa84c1dc1 Add Swagger 2 docs for content repo. Add Swagger 2 CLI validator. 2015-05-29 12:15:24 +01:00
Kegan Dougal f9710a6e17 Add help blurb to gendoc.py 2015-05-28 14:16:57 +01:00
Kegan Dougal f134728268 Link to msgtypes from the description of m.room.message. 2015-05-28 11:57:44 +01:00
Kegan Dougal 9901d4f695 Fix RST 2015-05-28 11:45:52 +01:00
Kegan Dougal 886453a2e4 Test break RST 2015-05-28 11:44:30 +01:00
Kegan Dougal c3a298a5df Fix sort order for VoIP events. 2015-05-28 11:35:18 +01:00
Kegan Dougal 51df65bb49 Remove old power level references. Link to m.room.power_levels. 2015-05-28 11:30:48 +01:00
Kegan Dougal ac7ccfa622 Add {{presence_events}}. Factor out common code in MatrixSections. 2015-05-28 10:45:00 +01:00
Kegan Dougal 9abadaf7af Add {{presence_events}} template. 2015-05-28 10:36:02 +01:00
Kegan Dougal e046402a4a Shift msgtype section order to have common (implemented) types first. 2015-05-27 16:51:07 +01:00