Mark Haines
52640eb205
Add a python script for checking that the examples match the event
...
schema.
Does the same checks as check.sh, but is a *lot* faster making it
suitable for using as a pre-commit hook.
I don't suggest replacing check.sh since it's good to check that the
schema works with multiple implementations of jsonschema.
9 years ago
Mark Haines
6a2c4d27fc
Update the docs for room v1 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
d2e39095fe
Merge pull request #54 from matrix-org/markjh/swagger_examples
...
Add script to check the example responses match the schema.
9 years ago
Mark Haines
f827765ba1
Make to code to skip checking swagger responses which don't have an
...
application/json example clearer.
9 years ago
Mark Haines
9896f98e2b
Search for yaml swagger files if check_examples.py is run without
...
arguments.
9 years ago
Mark Haines
7c2ccb1aeb
Merge remote-tracking branch 'origin/master' into markjh/swagger_examples
9 years ago
Mark Haines
299a4356d4
Add script to check that the example responses in the swagger matches
...
the examples.
9 years ago
Kegsay
5fbd534713
Merge pull request #51 from matrix-org/daniel/gendoc
...
Print errors to stderr
9 years ago
Kegsay
f1da162a00
Merge pull request #53 from matrix-org/markjh/event-schema
...
Allow relative references to schema to work in python and node.
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
Kegsay
a2cfb89086
Merge pull request #52 from matrix-org/spec-file-structure
...
Spec file structure
9 years ago
Kegan Dougal
cf8abdafd4
Fix PR comments
9 years ago
Kegan Dougal
ba4998a62b
Apparently tabs are A Thing
9 years ago
Kegan Dougal
427e4c8b1b
Log port being listened on
9 years ago
Mark Haines
1540b1fe3c
Merge branch 'markjh/swagger' 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
Kegan Dougal
1f6b12b3e8
Modify and enforce the file format/structure used
...
Convert the file format to be of the form ##_##_something.rst where the
first ## is the top-level section number and the second ## is the
second-level section number, e.g. 07_01_push_cs_api.rst means
Section 7.1 - This is now enforced in gendoc.py along with the title line
style that should be used (= for top-level, - for 2nd level) which will
give helpful suggestions if you trip up. This feels much more intuitive
now looking in /specification
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
06e46c1899
Fix on a better numbering format
9 years ago
Kegan Dougal
91d674b3c7
Merge branch 'spec-edits-cleanup' into spec-file-structure
9 years ago
Kegsay
28f3e61d04
Merge pull request #50 from matrix-org/spec-edits-cleanup
...
Spec: typo/layout fixes
9 years ago
Kegan Dougal
9ed39665c8
PR feedback
9 years ago
Kegan Dougal
ef473b4161
Start enforcing title styles
...
This depends on the number of the file.
9 years ago
Daniel Wagner-Hall
08defafd98
Print errors to stderr
...
This means that continuserv will actually display them
9 years ago
Daniel Wagner-Hall
0b183f06f8
Merge pull request #49 from matrix-org/continuserv-logging
...
Continuserv: Log port being listened on
9 years ago
Kegan Dougal
ad26b7f8cb
Fix a subtle rendering bug when catting spec sections
...
Throw in gendoc.py if a spec section doesn't end with \n\n
There needs to be TWO new lines at the end of each spec section else the
title of the next section merges into the last paragraph of the earlier
section. This happens without rst2html producing a warning, and results
in the section heading of a file disappearing(!)
9 years ago
Kegan Dougal
8e7b33ac99
Fix more typos/spelling errors
9 years ago
Kegan Dougal
3f9d183c2a
More typo/layout fixes
...
Split out identity servers to a separate file
9 years ago
Kegan Dougal
620d3dcb26
Test commit
9 years ago
Kegan Dougal
faa95e172f
More formatting fixes; typos; etc
9 years ago
Mark Haines
46d29e9eea
fix the room api swagger to be valid swagger
9 years ago
Kegan Dougal
af32ec194a
Move VoIP events to 22_voip_events
...
20_events is a huge as it is, this makes it easier to find what section
you actually want when editing.
9 years ago
Kegan Dougal
5b59c67510
Minor formatting fixes. Fix state event templating.
9 years ago
Mark Haines
654ed9b99e
Remove keys from the m.room.* schema files so that they may be used in the node swagger validator
9 years ago
Kegan Dougal
9c3a333a6d
Apparently tabs are A Thing
9 years ago
Kegan Dougal
9b18fd252e
Log port being listened on
9 years ago
Mark Haines
315f97e36b
Merge branch 'master' into markjh/document_v1_rooms_api
9 years ago
Kegsay
bb441427ac
Merge pull request #48 from matrix-org/markjh/swagger
...
De-duplicate event schema
9 years ago
Mark Haines
fd3401fc7a
Remove accidentally committed swp file
9 years ago
Mark Haines
d0b018c46e
Fix syntax error in JSON
9 years ago
Mark Haines
380f186273
Log which file a json parse error occurred in
9 years ago
Mark Haines
c49338006a
replace definitions/*event.yaml with symlinks to /event-schemas/
9 years ago
Mark Haines
2cf8da6b20
Update the gendoc script to load the core event schema from
...
separate files.
9 years ago
Mark Haines
6147562d14
Split the "core" definition files into separate files. To
...
make it easier to use the schema files with tools that
don't support deep links.
9 years ago
Daniel Wagner-Hall
cf13701450
Merge branch 'master' into macaroons
9 years ago
Daniel Wagner-Hall
a19e18a4da
Merge branch 'master' into daniel/threepidinvites-2
9 years ago
Mark Haines
4d302d10c4
Merge pull request #47 from matrix-org/daniel/chdor
...
Fix chdir path
9 years ago