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

632 commits

This branch
This branch
All branches
Author SHA1 Message Date
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
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
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)
 2015-09-22 16:01:22 +01:00
Kegan Dougal
0c0ac3e814 Fix common event fields template to use subtitle char 2015-09-22 14:07:23 +01:00
Kegan Dougal
e8cdfcbba2 Rename spec files to not have numbers everywhere; update targets.yaml 2015-09-22 14:01:55 +01:00
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.
 2015-09-22 13:08:15 +01:00
Mark Haines
98d91d0c2b Make the example room id more "random" so that people are less likely to think that it is supposed to be human readable 2015-09-21 17:31:35 +01:00
Mark Haines
f60190086a Describe the behaviour of /rooms/{roomId}/member when the user has left the room 2015-09-21 17:30:10 +01:00
Kegan Dougal
067363c629 Get the desired title levels right; print out the actual level used to stdout 2015-09-21 17:21:08 +01:00
Mark Haines
ba6c7d267c SPEC-216: Document the behaviour of the room getters when the user has left the room 2015-09-21 17:21:01 +01:00
Mark Haines
615a9575cb SPEC-216: Clarify when the room getters will return 403 2015-09-21 17:12:29 +01:00
Mark Haines
cb41adee70 Fix the swagger host to be "localhost:8008" so that it can be used in a "Try it now" setup against localhost 2015-09-21 17:10:23 +01:00
Kegan Dougal
d5e0115e42 Merge branch 'master' into spec-restructure-modules 2015-09-21 16:55:24 +01:00
Kegan Dougal
65ce95249f cat the spec according to the build target. Remove old checks as they are now obsolete since we don't care about the filename 2015-09-21 16:54:30 +01:00
Mark Haines
2efadea583 Merge branch 'master' into markjh/document_v1_rooms_api 2015-09-21 16:35:31 +01:00
Kegan Dougal
8590cc84b5 Process and extract targets in gendoc.py 2015-09-21 15:33:28 +01:00
Kegsay
83ee385543 Merge pull request #55 from matrix-org/markjh/codehighlighting 
Turn on code highlighting for HTTP api responses
 2015-09-21 15:23:13 +01:00
Mark Haines
a64125772f Merge pull request #58 from matrix-org/markjh/jenkins 
Add the jenkins command to git so that we can update it
 2015-09-21 15:22:38 +01:00
Mark Haines
2c31731262 Add the jenkins command to source control so that we can update 
it without having to fiddle with the jenkins UI.

It also allow us to move files without breaking the CI since we
won't be hard coding the locations of scripts in the jenkins UI.
 2015-09-21 15:19:09 +01:00
Mark Haines
738b24d028 Merge pull request #57 from matrix-org/markjh/example_checker 
Python script for checking that the examples match the event schema.
 2015-09-21 15:07:57 +01:00
Mark Haines
8974b2b67b Skip files that start with ".", e.g. vim swp files. 2015-09-21 15:05:10 +01:00