Commit Graph

48 Commits (481298db83d257466aa24d7433798da8240e58c1)

Author SHA1 Message Date
Kegan Dougal 09ac367847 Merge branch 'master' into module-content-repo
Conflicts:
	templating/matrix_templates/units.py
9 years ago
Kegan Dougal 4dabcd112e Remove redundant info now we have the http api template. Minor tweaks to display of schema with no names but a type 9 years ago
Kegan Dougal 87b6dd845e Flesh out content repo; modify templating to support headers
Edit content-repo.yaml to include examples and headers.
Restructure content module to conform to the module template.
Adjust the HTTP API template to give 1 more char to the response
param to fit "Content-Disposition" correctly.
Edit the templating system to support displaying enums for
swagger APIs (before it was just JSON schema). Also add support
for introspecting headers from swagger. Finally, replace - with
_ when forming the {{ template_var }} else things whine.
9 years ago
Kegan Dougal 560cd7a58f This isn't javascript. s/,/%/ 9 years ago
Kegan Dougal c972dad8b3 Flesh out receipts module. Add receipts swagger
Add templating support for v2 apis.
9 years ago
Kegan Dougal 365a9076b9 Add nested dict template support; Add x-pattern
For cases where event schema specify `patternProperties` it would be nice
to give that pattern a "human-readable" form rather than a raw regex. This
is now supported by specifying `x-pattern` in the value part of the specified
pattern e.g. `patternProperties:{ "^.*":{ x-pattern: "$THING", ... } }`

Templating had limited record type descriptions limited to value primitives
e.g. `{string: integer}`. It now supports inspecting the values recursively
if the value is `object`.

Updated `m.receipt` to take both these points into account to make it read
better. Tweak receipt module text.
9 years ago
Kegan Dougal 6afdfc0771 Add more logging and make logging context clearer
This is now actually useful if you want to debug why your swagger YAML
isn't producing a table you think it should be.
9 years ago
Kegan Dougal b0eb985523 Merge branch 'master' into spec-restructure-modules 9 years ago
Kegan Dougal 056b5eba22 Partially handle representing top-level array responses
If an HTTP API returned a top-level array response, the templating system
would fail to create a table for it. This is now partially fixed by pulling
out the type of the elements (no recursion is done to populate nested tables)
9 years ago
Kegan Dougal f71763b0d3 Implement relative title styles
Templates don't know at what level they will be inserted. Previously, we
hard-coded the title style which is not compatible with the build target
system. Define a set of styles which will be replaced by the gendoc script
when it encounters them:
 '<' : Make this title a sub-heading
 '/' : Make this title a heading at the same level
 '>' : Make this title a super-heading

The build target system is now basically complete and functioning.
9 years ago
Mark Haines f33c0846c3 Merge remote-tracking branch 'origin/master' into markjh/document_v1_rooms_api 9 years ago
Mark Haines 7c2ccb1aeb Merge remote-tracking branch 'origin/master' into markjh/swagger_examples 9 years ago
Mark Haines 7ac5c3766c Merge remote-tracking branch 'origin/master' into markjh/event-schema
Conflicts:
	templating/matrix_templates/units.py
9 years ago
Mark Haines f99a38ce72 Update the hard-coded paths in templating units.py.
Replace the hard code paths with global variables.
9 years ago
Mark Haines 63f08bace6 Fix the examples in the swagger API documentation to be valid JSON 9 years ago
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.
9 years ago
Kegan Dougal 5b59c67510 Minor formatting fixes. Fix state event templating. 9 years ago
Mark Haines 315f97e36b Merge branch 'master' into markjh/document_v1_rooms_api 9 years ago
Mark Haines 380f186273 Log which file a json parse error occurred in 9 years ago
Mark Haines 2cf8da6b20 Update the gendoc script to load the core event schema from
separate files.
9 years ago
Mark Haines 7eb8b4fde2 Add new-style docs for the APIs for getting events for a room 9 years ago
Kegsay 3011823c51 Merge pull request #27 from matrix-org/receipts
Document receipts
9 years ago
Daniel Wagner-Hall d399e5b93b Use an alias object rather than flat fields 9 years ago
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) 9 years ago
Daniel Wagner-Hall 64cfc00f50 Remove unused fluff 9 years ago
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.
9 years ago
Daniel Wagner-Hall 26ebe3e68b Add ability to refer to aliases of endpoints 9 years ago
Daniel Wagner-Hall 5031c26f7b Make res optional, and rename to good_response 9 years ago
Daniel Wagner-Hall 0a9f61029a Allow for missing responses key 9 years ago
Daniel Wagner-Hall 94b13c0121 Show all responses, not just the successful one
This still filters out responses lacking either a description or an
example
9 years ago
Kegan Dougal ec631c60d4 Add link to github commit for the spec as per request. 10 years ago
Kegan Dougal 14d004146b Implement nested tables for HTTP APIs. It even works(!) 10 years ago
Kegan Dougal 0275c2ffa0 Add sync API yaml. Add template for sync_http_api. 10 years ago
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.
10 years ago
Kegan Dougal 704cd14030 Add in response format for APIs. Standardise on 'key' rather than 'name'. 10 years ago
Kegan Dougal f6c98f41e9 Use table subsections for param locations instead of an extra column. 10 years ago
Kegan Dougal ba6ce16509 Modify how descriptions are shown. Add profile API descriptions. 10 years ago
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.
10 years ago
Kegan Dougal c75fd6bcae Add HTTP API wip template. 10 years ago
Kegan Dougal 5795e1ceda Add profile API examples and extract examples for template usage. 10 years ago
Kegan Dougal fe7ffafc15 Factor out json schema object processing since swagger uses it too. Hook swagger up. 10 years ago
Kegan Dougal d090389d01 Start pre-processing swagger APIs before passing to sections. 10 years ago
Kegan Dougal 1dc3d82664 Load swagger APIs as templating units. Check sections return strings. 10 years ago
Kegan Dougal f134728268 Link to msgtypes from the description of m.room.message. 10 years ago
Kegan Dougal 9abadaf7af Add {{presence_events}} template. 10 years ago
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.
10 years ago
Kegan Dougal 06177740d4 Tweak how constants are represented. 10 years ago
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.
10 years ago