Mark Haines
2efadea583
Merge branch 'master' into markjh/document_v1_rooms_api
2015-09-21 16:35:31 +01:00
Mark Haines
f33c0846c3
Merge remote-tracking branch 'origin/master' into markjh/document_v1_rooms_api
2015-09-18 17:38:03 +01:00
Mark Haines
6b5b8432b3
Turn on code highlighting for HTTP api responses and add a
...
code highlighting stylesheet for the specification.
2015-09-18 17:26:10 +01:00
Mark Haines
7c2ccb1aeb
Merge remote-tracking branch 'origin/master' into markjh/swagger_examples
2015-09-18 16:11:26 +01:00
Mark Haines
7ac5c3766c
Merge remote-tracking branch 'origin/master' into markjh/event-schema
...
Conflicts:
templating/matrix_templates/units.py
2015-09-18 15:49:36 +01:00
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
63f08bace6
Fix the examples in the swagger API documentation to be valid JSON
2015-09-18 14:40:48 +01:00
Mark Haines
7f81501762
Allow relative references to schema to work in python and node.
...
Rename "schema/v1/core" to "schema/v1/core-event-schema".
Add self-referential symlinks to schema/v1/core-event-schema
The python json schema libraries expect that relative references are
relative to the file they are in. The node json schema libraries
expect that relateive references are relative to the first file loaded.
To support both kinds we reference the core event schema using
"core-event-schema/event.json". We then symlink the core-event-schema
directory to both the location of the file refering to "event.json" so
that it will work in python and to the location of the top level file
so that it will work in node.
2015-09-18 11:39:44 +01:00
Kegan Dougal
5b59c67510
Minor formatting fixes. Fix state event templating.
2015-09-17 16:34:20 +01:00
Mark Haines
315f97e36b
Merge branch 'master' into markjh/document_v1_rooms_api
2015-09-17 15:25:00 +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
Mark Haines
7eb8b4fde2
Add new-style docs for the APIs for getting events for a room
2015-09-15 15:52:36 +01:00
Daniel Wagner-Hall
59a4e84361
s/registration/login/
2015-09-14 17:10:46 +01:00
Daniel Wagner-Hall
b8e2ac5c1b
Swaggerify /login
2015-09-14 13:49:27 +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
99106bb6fe
Add explanatory comments
...
Also, remove line which was accidentally removed
2015-09-10 13:54:00 +01:00
Daniel Wagner-Hall
f67e27e843
Split on double-newlines not single
...
Otherwise all sorts of tables get horribly broken
2015-09-10 13:20:04 +01:00
Daniel Wagner-Hall
55f33736b2
Preserve newlines in wrapped text
2015-09-10 12:04:12 +01:00
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
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
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
