matrix-spec-proposals

Commit Graph

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	5115346297	Add instant_messaging module; modify batesian section rules Previously, all `m.room.*` events were wodged into `{{room_events}}` which isn't great when you want to pull specific ones out. Batesian had a 1:1 mapping of `render_foo()` to a section `{{foo}}`, and having to constantly add functions for new types is a PITA. Batesian now supports returning a `dict` instead of a section `string` where the keys are the `{{foo}}` and the value is what will be inserted. Also add conflicting section key checks to avoid multiple definitions of the same `{{foo}}`. Define dicts for event schemata and swagger HTTP APIs. Using this new feature, split out the instant messaging stuff from the events section, and replace `{{room_events}}` with a list of specific events e.g. `{{m_room_member_event}}`.	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	388aeefac0	Remove obsolete key	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	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	2efadea583	Merge branch 'master' into markjh/document_v1_rooms_api	9 years ago
Mark Haines	f33c0846c3	Merge remote-tracking branch 'origin/master' into markjh/document_v1_rooms_api	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
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
Daniel Wagner-Hall	59a4e84361	s/registration/login/	9 years ago
Daniel Wagner-Hall	b8e2ac5c1b	Swaggerify /login	9 years ago
Kegsay	3011823c51	Merge pull request #27 from matrix-org/receipts Document receipts	9 years ago
Kegsay	cf3475515e	Merge pull request #33 from matrix-org/daniel/threepidinvites Spec /room/{roomId}/join	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	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.	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	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.	10 years ago
Kegan Dougal	c42bfabaad	Order the status API before presence lists because it is more important.	10 years ago
Kegan Dougal	e10859a887	Replace presence API with new template.	10 years ago
Kegan Dougal	334e10468d	Add presence swagger and template.	10 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	8a676a2b9d	Add sortFn for profile HTTP API. Add combined profile HTTP API.	10 years ago
Kegan Dougal	704cd14030	Add in response format for APIs. Standardise on 'key' rather than 'name'.	10 years ago

1 2

69 Commits (09ac367847201711cd7d34017fadff9a6e18a063)