wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
468 commits 4 branches 0 tags 17 MiB
Commit graph

68 commits

Author SHA1 Message Date
Kegsay
cf3475515e Merge pull request #33 from matrix-org/daniel/threepidinvites 
Spec /room/{roomId}/join
 2015-09-09 16:56:43 +01:00
Daniel Wagner-Hall
d399e5b93b Use an alias object rather than flat fields 2015-09-09 13:16:46 +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
d53943c8c2 Spec /room/{roomId}/join 
This is just replacing the existing spec with a swagger version.

Subsequent pull requests will add 3pid join to this, as well as specing
the invite, leave, ban, and kick endpoints.
 2015-09-08 16:35:08 +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
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
c42bfabaad Order the status API before presence lists because it is more important. 2015-06-02 16:12:23 +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
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
f134728268 Link to msgtypes from the description of m.room.message. 2015-05-28 11:57:44 +01:00
Kegan Dougal
c3a298a5df Fix sort order for VoIP events. 2015-05-28 11:35:18 +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
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
d3dca1f357 Sort keys alphabetically in tables. Sort event types alphabetically in sections. 2015-05-26 11:15:37 +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
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