Commit graph

772 commits

Author SHA1 Message Date
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
Kegan Dougal 6f330bd879 Gut the old msgtypes section and replace with {{msgtype_events}} 2015-05-27 16:42:01 +01:00
Kegan Dougal 59f856c7e6 Factor out ImageInfo into a core type. Refer to that in other msgtypes.
Add templating for msgtypes. ImageInfo core type is not referred to for
m.image in order for the ImageInfo table to render for it.
2015-05-27 16:30:11 +01:00
Kegan Dougal 59168df363 Add schema/example files for all specced msgtypes. 2015-05-27 15:32:22 +01:00
Kegan Dougal f5059057b3 Update AS API docs (wording/layout tweaks, rationale). 2015-05-27 11:42:51 +01:00
Kegan Dougal 06177740d4 Tweak how constants are represented. 2015-05-26 17:39:38 +01:00
Kegan Dougal 9d532f30e8 Add {{voip_events}}. Add more info on sections when asked via build.py -s 2015-05-26 17:32:51 +01:00
Kegsay 2a02b3494f Minor tweaks 2015-05-26 17:14:50 +01:00
Kegan Dougal 89083b3a86 Add {{spec_version}}. Update build.py module docs. 2015-05-26 17:09:30 +01:00
Kegsay c721bb7e61 Update template readme 2015-05-26 16:47:53 +01:00
Kegan Dougal 5b31c442f5 Completely split up the templating system from the Matrix Spec template code.
The two are now linked together in build.py by specifying the input module.
Updated gendoc.py to specify the right module.
2015-05-26 16:20:15 +01:00