Mark Haines
f99a38ce72
Update the hard-coded paths in templating units.py.
...
Replace the hard code paths with global variables.
2015-09-18 14:43:57 +01:00
Mark Haines
380f186273
Log which file a json parse error occurred in
2015-09-17 14:42:43 +01:00
Mark Haines
2cf8da6b20
Update the gendoc script to load the core event schema from
...
separate files.
2015-09-17 10:28:57 +01:00
Kegsay
3011823c51
Merge pull request #27 from matrix-org/receipts
...
Document receipts
2015-09-10 16:18:19 +01:00
Daniel Wagner-Hall
d399e5b93b
Use an alias object rather than flat fields
2015-09-09 13:16:46 +01:00
Kegan Dougal
a92fa6392d
Include patternProperties as normal properties (they basically are just patterns instead of keys; we could probably annotate this more nicely in the future)
2015-09-08 17:14:31 +01:00
Daniel Wagner-Hall
64cfc00f50
Remove unused fluff
2015-09-08 17:07:52 +01:00
Daniel Wagner-Hall
90f5dc370b
Populate aliases from canonical endpoint
...
Swagger validates badly if you have endpoints without the full
specification of things, so instead let's generate them the other way
around.
2015-09-08 16:59:18 +01:00
Daniel Wagner-Hall
26ebe3e68b
Add ability to refer to aliases of endpoints
2015-09-08 16:27:20 +01:00
Daniel Wagner-Hall
5031c26f7b
Make res optional, and rename to good_response
2015-09-08 11:25:03 +01:00
Daniel Wagner-Hall
0a9f61029a
Allow for missing responses key
2015-09-08 11:16:48 +01:00
Daniel Wagner-Hall
94b13c0121
Show all responses, not just the successful one
...
This still filters out responses lacking either a description or an
example
2015-09-07 17:14:36 +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
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
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
f134728268
Link to msgtypes from the description of m.room.message.
2015-05-28 11:57:44 +01:00
Kegan Dougal
9abadaf7af
Add {{presence_events}} template.
2015-05-28 10:36:02 +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
06177740d4
Tweak how constants are represented.
2015-05-26 17:39:38 +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
