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
Kegan Dougal
8e1d6899c2
Start encapsulating Units too. Add debug option which controls logging.
2015-05-26 14:50:45 +01:00
Kegan Dougal
96671ce833
Use the templating system to set {{git_version}}. Restructure sections code.
...
Restructured the sections code to be slightly more encapsulated than before.
This will be expanded to more clearly separate the templating system from
the specific implementation of the spec templates.
2015-05-26 14:33:32 +01:00
Kegan Dougal
9d7f2baf5c
Mention that knock/private on join_rules are not implemented.
2015-05-26 11:21:20 +01:00
Kegan Dougal
d3dca1f357
Sort keys alphabetically in tables. Sort event types alphabetically in sections.
2015-05-26 11:15:37 +01:00
Kegan Dougal
d6943dfbff
Update .gitignore
2015-05-26 11:00:40 +01:00
Kegan Dougal
dc5c01607b
Sort out table layout and rejig where state_key is placed.
2015-05-26 10:40:04 +01:00
Kegan Dougal
003ca35bf6
Spell 'overridden' correctly.
2015-05-26 10:08:05 +01:00
Kegan Dougal
86be22dc35
s/0-length/zero-length/g
2015-05-21 16:04:52 +01:00
Kegan Dougal
ed4ce6950c
Template up common event fields from the 'core' json schema file.
2015-05-21 15:51:23 +01:00
Kegan Dougal
6dcbc40b63
Add common event field descriptions and template.
2015-05-21 15:41:34 +01:00
Kegan Dougal
54783a59c3
Put state_key info on same line as State Event text.
2015-05-21 15:09:46 +01:00
Kegan Dougal
4ea5da44d0
Include enum information.
2015-05-21 14:11:29 +01:00
Kegan Dougal
b6b8971491
Use ~ not - for event sections.
2015-05-21 14:02:32 +01:00
Kegan Dougal
73d84f3722
Add descriptions to state_keys. Add it into the template.
2015-05-21 13:31:08 +01:00
Kegan Dougal
6a41bd9b82
Add descriptions to event fields
2015-05-21 12:02:07 +01:00
Kegan Dougal
989ea02219
s/Key/Content Key/
2015-05-21 11:31:27 +01:00
Kegan Dougal
ea9c6496bb
Account for 'required' text when wrapping desc column.
2015-05-21 11:27:54 +01:00
Kegan Dougal
a7f3d39da2
Use the entire event in the example JSON. Sort keys on JSON.
2015-05-21 11:12:43 +01:00
Kegan Dougal
6d3dd045a5
Line wrap 80 on desc, show the type of items in the array rather '[array]'
2015-05-21 10:43:10 +01:00
Kegan Dougal
a42a22028c
Add event table template. Also inspect arrays for objects.
2015-05-21 10:39:54 +01:00
Kegan Dougal
0899e0b772
Update event schema parsing.
...
The templating system now parses event schemas into a form which
can be easily dumped into multiple tables (for nested object types)
2015-05-21 09:46:14 +01:00
