Commit Graph

28 Commits

Author SHA1 Message Date
Richard van der Hoff 3dd0fcabb3 Render the body of response objects with inheritance 2016-10-13 17:11:18 +01:00
David Baker d66ea3c3ce Don't line wrap the API descriptions
They are in RST format which is whitespace sensitive and threfore can't be line wrapped without breaking the syntax.

There is more wrapping in other places but some of it is into tables where it does need to be fixed width in order for the RST table to parse correctly.
2016-07-08 11:57:40 +01:00
Richard van der Hoff 6b23598a26 Improve API examples in the spec
* Show response codes even if we don't have examples for them
 * Walk the objects to build param examples if none are given at the top level
2016-05-06 15:42:31 +01:00
Daniel Wagner-Hall 1e2b63763e /join and /room/:roomId/join aren't exact aliases
Separate them, clarify their differences.

Also, fix some links which weren't being properly populated.
2016-01-13 15:55:51 +00:00
Richard van der Hoff 93eb6fb352 another diff noise fix 2016-01-07 22:46:22 +00:00
Richard van der Hoff 71b6ea8578 Fix a couple of things which were giving noisy diffs 2016-01-07 22:32:01 +00:00
Richard van der Hoff c6f5ba09d4 Display POST body parameters as tables
Replace a whole bunch of special-casing for POST body parameters with the same
logic as is used for response objects: represent all but the top-level as
tables.
2016-01-07 22:19:30 +00:00
Daniel Wagner-Hall 3e086909f1 Deprecated deprecated APIs 2015-12-10 14:47:14 +00:00
Richard van der Hoff cc8ef691fb Rewrite the table templates
Allow columns to stretch if they end up with wide content.

Apart from the hassle of having to manually update the calculations, having the
columns wide enough to hold the widest thing they might ever have leads to
tables with lots of whitespace in the results.
2015-11-15 16:58:35 +00:00
Daniel Wagner-Hall d7357ef9b7 Specify /publicRooms 2015-11-11 11:39:40 +00:00
Mark Haines 71874870c8 Enable syntax highlighting for example http requests 2015-10-26 17:25:33 +00:00
Kegan Dougal 3b7585cbda Make nested request objects display correctly (search API)
This now displays search_categories.room_events.filter and co correctly.
Also make arrays of enums display correctly.
2015-10-26 11:17:19 +00:00
Kegan Dougal 213cb25290 Wrap correctly 2015-10-08 16:38:41 +01:00
Kegan Dougal 31ae4b3859 Swaggerify push notification API
Edit units.py to support nested JSON request keys
2015-10-08 13:08:21 +01:00
Kegan Dougal 56ce432399 Get profile tag keys displaying correctly. 2015-10-08 10:14:05 +01:00
Kegan Dougal c5edc60c4c Add push YAML for pushers endpoint.
Also display "required" text on required JSON body request params. Also
increase the size of the request param column to support longer param names
present in the pushers API.
2015-10-07 16:01:36 +01:00
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.
2015-10-01 17:55:16 +01:00
Kegan Dougal 5b134119bd Add presence module; fix relative title bug
If a relative title appeared after an HTTP API table, it
would insert the wrong level because it thought that part
of the table was a title.
2015-09-23 09:59:54 +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
Daniel Wagner-Hall 26ebe3e68b Add ability to refer to aliases of endpoints 2015-09-08 16:27:20 +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 14d004146b Implement nested tables for HTTP APIs. It even works(!) 2015-06-02 12:03:10 +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 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