Commit Graph

45 Commits (703b782ea1aa9281d5bd5b2d22b7b33e9512a87f)

Author SHA1 Message Date
Richard van der Hoff 93894ebbbe Fix spurious "None" in non-room events
Events like m.direct and m.tag don't inherit from either Message event or State
event, and were getting a "None" where there should have been a type.
8 years ago
Richard van der Hoff 3dd0fcabb3 Render the body of response objects with inheritance 8 years ago
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.
9 years ago
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
9 years ago
Jimmy Cuadra 5b18db9096 Make list of APIs on the index a table. 9 years ago
Daniel Wagner-Hall 902f25ef4a Include newline before table headings 9 years ago
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.
9 years ago
Richard van der Hoff 93eb6fb352 another diff noise fix 9 years ago
Richard van der Hoff 71b6ea8578 Fix a couple of things which were giving noisy diffs 9 years ago
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.
9 years ago
Daniel Wagner-Hall 3e086909f1 Deprecated deprecated APIs 9 years ago
Daniel Wagner-Hall dcd51c39b3 Indent state-key descriptions
Right now two spaces make a <dt> whereas four does the right thing.
9 years ago
Daniel Wagner-Hall 4faede73a1 Merge branch 'master' into daniel/multipleexamples 9 years ago
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.
9 years ago
Daniel Wagner-Hall d7357ef9b7 Specify /publicRooms 9 years ago
Daniel Wagner-Hall 2734f9f9f2 Merge branch 'master' into daniel/multipleexamples
Conflicts:
	specification/modules/third_party_invites.rst
9 years ago
Mark Haines c719946370 Enable syntax highlighting for message type examples 9 years ago
Daniel Wagner-Hall 176f919fc8 Show multiple examples where present 9 years ago
Mark Haines 71874870c8 Enable syntax highlighting for example http requests 9 years ago
Mark Haines 3f1cbb22bb Enable syntax highlighting for the JSON event examples 9 years ago
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.
9 years ago
Kegan Dougal d39a9082a0 Add invite_room_state to spec. Flesh out info. 9 years ago
Kegan Dougal 213cb25290 Wrap correctly 9 years ago
Kegan Dougal 31ae4b3859 Swaggerify push notification API
Edit units.py to support nested JSON request keys
9 years ago
Kegan Dougal 56ce432399 Get profile tag keys displaying correctly. 9 years ago
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.
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 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.
9 years ago
Kegan Dougal 0c0ac3e814 Fix common event fields template to use subtitle char 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 6b5b8432b3 Turn on code highlighting for HTTP api responses and add a
code highlighting stylesheet for the specification.
9 years ago
Daniel Wagner-Hall 26ebe3e68b Add ability to refer to aliases of endpoints 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 14d004146b Implement nested tables for HTTP APIs. It even works(!) 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 ac7ccfa622 Add {{presence_events}}. Factor out common code in MatrixSections. 10 years ago
Kegan Dougal 6f330bd879 Gut the old msgtypes section and replace with {{msgtype_events}} 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 9d532f30e8 Add {{voip_events}}. Add more info on sections when asked via build.py -s 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