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.
10 years ago
c75fd6bcae
Add HTTP API wip template.
10 years ago
5795e1ceda
Add profile API examples and extract examples for template usage.
10 years ago
fe7ffafc15
Factor out json schema object processing since swagger uses it too. Hook swagger up.
10 years ago
d090389d01
Start pre-processing swagger APIs before passing to sections.
10 years ago
1dc3d82664
Load swagger APIs as templating units. Check sections return strings.
10 years ago
99dfe64d5c
Add rate-limiting on APIs which rate limit. More descriptions.
10 years ago
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.
10 years ago
aeaa43811c
Add security definitions for directory API.
10 years ago
870d1b8944
Add Swagger 2 directory API.
10 years ago
caa84c1dc1
Add Swagger 2 docs for content repo. Add Swagger 2 CLI validator.
10 years ago
f9710a6e17
Add help blurb to gendoc.py
10 years ago
f134728268
Link to msgtypes from the description of m.room.message.
10 years ago
9901d4f695
Fix RST
10 years ago
886453a2e4
Test break RST
10 years ago
c3a298a5df
Fix sort order for VoIP events.
10 years ago
51df65bb49
Remove old power level references. Link to m.room.power_levels.
10 years ago
ac7ccfa622
Add {{presence_events}}. Factor out common code in MatrixSections.
10 years ago
9abadaf7af
Add {{presence_events}} template.
10 years ago
e046402a4a
Shift msgtype section order to have common (implemented) types first.
10 years ago
6f330bd879
Gut the old msgtypes section and replace with {{msgtype_events}}
10 years ago
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.
10 years ago
59168df363
Add schema/example files for all specced msgtypes.
10 years ago
f5059057b3
Update AS API docs (wording/layout tweaks, rationale).
10 years ago
06177740d4
Tweak how constants are represented.
10 years ago
9d532f30e8
Add {{voip_events}}. Add more info on sections when asked via build.py -s
10 years ago
2a02b3494f
Minor tweaks
10 years ago
89083b3a86
Add {{spec_version}}. Update build.py module docs.
10 years ago
c721bb7e61
Update template readme
10 years ago
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.
10 years ago
8e1d6899c2
Start encapsulating Units too. Add debug option which controls logging.
10 years ago
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.
10 years ago
9d7f2baf5c
Mention that knock/private on join_rules are not implemented.
10 years ago
d3dca1f357
Sort keys alphabetically in tables. Sort event types alphabetically in sections.
10 years ago
d6943dfbff
Update .gitignore
10 years ago
dc5c01607b
Sort out table layout and rejig where state_key is placed.
10 years ago
003ca35bf6
Spell 'overridden' correctly.
10 years ago
86be22dc35
s/0-length/zero-length/g
10 years ago
ed4ce6950c
Template up common event fields from the 'core' json schema file.
10 years ago
6dcbc40b63
Add common event field descriptions and template.
10 years ago
54783a59c3
Put state_key info on same line as State Event text.
10 years ago
4ea5da44d0
Include enum information.
10 years ago
b6b8971491
Use ~ not - for event sections.
10 years ago
73d84f3722
Add descriptions to state_keys. Add it into the template.
10 years ago
6a41bd9b82
Add descriptions to event fields
10 years ago
989ea02219
s/Key/Content Key/
10 years ago
ea9c6496bb
Account for 'required' text when wrapping desc column.
10 years ago
a7f3d39da2
Use the entire event in the example JSON. Sort keys on JSON.
10 years ago
6d3dd045a5
Line wrap 80 on desc, show the type of items in the array rather '[array]'
10 years ago
a42a22028c
Add event table template. Also inspect arrays for objects.
10 years ago
Kegan Dougal