wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
651 commits 4 branches 0 tags 17 MiB
Commit graph

651 commits

This branch
This branch
All branches
Author SHA1 Message Date
Kegsay
f74cb4d54c Merge pull request #76 from matrix-org/speculator-speedup 
Modify how speculator uses git repos
 2015-09-30 15:53:25 +01:00
Kegsay
e5fecbb87f Merge pull request #75 from matrix-org/continuserv-speedup 
Speed up continuserv
 2015-09-30 15:42:29 +01:00
Kegan Dougal
b6f0b67da6 Speed up continuserv 
Ignore .git directory as that shouldn't affect spec generation. Also, when
we receive writes from the OS, wait a bit before re-generating the spec to
clump together multiple writes rather than re-generating one after another
and waiting for no more writes before serving the request.
 2015-09-30 15:21:32 +01:00
Kegan Dougal
ede43fbe9f Modify how speculator uses git repos 
Modified so it has a "master" repo and local A/B repos which pull from the
"master". This saves an extra git clone operation per HTTP request.
 2015-09-30 14:31:26 +01:00
Kegsay
4aad6976fd Merge pull request #73 from matrix-org/paragraphs 
Fix paragraph CSS and adjust where paragraphs are in the RST
 2015-09-30 10:54:23 +01:00
Kegan Dougal
a49d5f67f1 Delete rather than comment out the offending CSS 2015-09-30 10:54:06 +01:00
Kegan Dougal
4e1e82f995 Fix paragraph CSS and adjust where paragraphs are in the RST 
The CSS for `nature.css` was such that it was preventing `p` tags from
having sufficient vertical whitespace. This meant that you couldn't insert
any kind of spacing between lengthy sections (they just appeared as new lines).

This PR fixes this so you can actually have some whitespace between paragraphs.
As a result of this change, some parts of the spec appeared to have too much
whitespace. These were often sections which shouldn't have begun a new
paragraph anyway (e.g. a single sentence being an entire paragraph, `TODO`
blocks resulting in new paragraphs). This PR fixes the most offending areas
where we shouldn't have been inserting new paragraphs.
 2015-09-30 10:43:02 +01:00
Kegsay
c96f02c2b0 Merge pull request #69 from matrix-org/erikj/login_token 
m.login.token
 2015-09-29 13:26:29 +01:00
Kegsay
beafc74f81 Merge pull request #70 from matrix-org/spec-module-format 
Modules format
 2015-09-29 13:22:16 +01:00
Daniel Wagner-Hall
eec021ee8c Merge pull request #72 from matrix-org/daniel/generateathead 
Support viewing the spec at head
 2015-09-29 13:01:17 +01:00
Daniel Wagner-Hall
083a76096f Support viewing the spec at head 2015-09-29 12:41:07 +01:00
Erik Johnston
6e6bc8a5a9 Mandate macaroon 2015-09-28 14:51:44 +01:00
Erik Johnston
ce53a17180 Add txn_id rationale 2015-09-28 14:51:10 +01:00
Kegan Dougal
5abea1f2bc Minor tweaks 2015-09-28 14:07:34 +01:00
Kegan Dougal
70518ae655 Clarify template suffixes 2015-09-28 14:03:54 +01:00
Kegan Dougal
643468e914 Mention swagger. Clarify how event type template vars are formed. 2015-09-28 14:01:54 +01:00
Kegan Dougal
c2fc1a2fb1 Add basic module template. 
This has the core sections for events/server/client/security.
 2015-09-28 13:41:31 +01:00
Erik Johnston
97154cc6b2 s/nonce/txn_id/ 2015-09-28 13:09:54 +01:00
Erik Johnston
4c9f524cab Neaten things up 2015-09-28 09:32:03 +01:00
Erik Johnston
317c2f20d3 Draft login token spec 2015-09-28 09:29:35 +01:00
Kegsay
e5f805c0d5 Merge pull request #67 from matrix-org/unused-template-vars 
Detect unused {{ vars }} and whine loudly.
 2015-09-25 16:33:35 +01:00
Kegsay
4d407c2731 Merge pull request #66 from matrix-org/speculator-htmldiff 
speculator: Add HTML diffing
 2015-09-25 16:33:23 +01:00
Kegan Dougal
9c882ea5e4 Detect unused {{ vars }} and whine loudly. 2015-09-25 16:24:31 +01:00
Daniel Wagner-Hall
2434dfaf1c Merge branch 'master' into speculator-htmldiff 2015-09-25 16:13:23 +01:00
Daniel Wagner-Hall
cd6f15f627 Remove obsolete comment 2015-09-25 13:34:24 +01:00
Daniel Wagner-Hall
0c1eb50ef4 Merge pull request #26 from matrix-org/macaroons 
Spec macaroons and token refresh
 2015-09-25 13:18:27 +01:00
Daniel Wagner-Hall
f5d436bd80 Remove extraneous ) 2015-09-25 13:18:09 +01:00
Daniel Wagner-Hall
6c1491b3ba Respond to some review comments 2015-09-25 13:17:11 +01:00
Daniel Wagner-Hall
5c4398c181 Remove superfluous comma 2015-09-25 13:10:49 +01:00
Daniel Wagner-Hall
fc87f4cdb0 Remove unused keys 2015-09-25 13:10:15 +01:00
Daniel Wagner-Hall
6c89e6ea67 Wrap refresh_token in `s 2015-09-25 13:03:46 +01:00
Kegsay
15308ab435 Merge pull request #62 from matrix-org/markjh/check_request_schema 
Check the request example JSON matches the schema
 2015-09-25 12:56:28 +01:00
Mark Haines
f34722485f Check the request example JSON matches the schema 2015-09-24 16:50:27 +01:00
Kegsay
ca9f30a7fd Merge pull request #61 from matrix-org/markjh/node_swagger_validator 
Only validate a file if it ends with ".yaml".
 2015-09-24 13:42:36 +01:00
Mark Haines
385b6c4759 Only validate a file if it ends with ".yaml". 
Otherwise we try to validate vim .swp files.
 2015-09-24 13:37:32 +01:00
Kegsay
0346568519 Merge pull request #60 from matrix-org/gendoc-logging 
Gendoc logging
 2015-09-23 16:52:24 +01:00
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.
 2015-09-23 15:36:13 +01:00
Kegan Dougal
f1adad5fb3 Add more logging with file prefixes 
This makes the handoff between gendoc and batesian clearer in the logs.
 2015-09-23 15:10:55 +01:00
Kegan Dougal
064a2c9172 Use argparse and log functions for gendoc.py 
gendoc.py has become more complex such that we actually want to pass things
to it like `--verbose`, `--nodelete`, `--target`, so use `argparse` to do this
like we have `build.py`. Pass through `-v` flags to `build.py`.
 2015-09-23 14:59:57 +01:00
Kegsay
14e77b09ab Merge pull request #59 from matrix-org/spec-restructure-modules 
Add spec build targets; restructure spec
 2015-09-23 14:38:25 +01:00
Kegan Dougal
1da64db302 Use relative depths for groups instead of absolute ones 
This means the group can be agnostic to how deeply nested it is,
improving reusability of groups.
 2015-09-23 14:29:37 +01:00
Kegan Dougal
29bae15790 Fix typo 2015-09-23 11:30:07 +01:00
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}}`.
 2015-09-23 10:48:49 +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
Kegan Dougal
b49cb57fe5 Move events sections to CS API 2015-09-22 17:32:31 +01:00
Kegan Dougal
16693a644a Various review fixes 2015-09-22 16:59:49 +01:00
Kegan Dougal
b21859836d Print stdout of build.py in verbose mode 2015-09-22 16:11:16 +01:00
Kegan Dougal
388aeefac0 Remove obsolete key 2015-09-22 16:07:19 +01:00
Kegan Dougal
b0eb985523 Merge branch 'master' into spec-restructure-modules 2015-09-22 16:04:41 +01:00
Kegsay
895ffcfcde Merge pull request #56 from matrix-org/markjh/document_v1_rooms_api 
Document the getters for the /rooms/{roomId} APIs
 2015-09-22 16:03:45 +01:00