b49cb57fe5
Move events sections to CS API
9 years ago
16693a644a
Various review fixes
9 years ago
b21859836d
Print stdout of build.py in verbose mode
9 years ago
388aeefac0
Remove obsolete key
9 years ago
b0eb985523
Merge branch 'master' into spec-restructure-modules
9 years ago
895ffcfcde
Merge pull request #56 from matrix-org/markjh/document_v1_rooms_api
...
Document the getters for the /rooms/{roomId} APIs
9 years ago
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
0c0ac3e814
Fix common event fields template to use subtitle char
9 years ago
e8cdfcbba2
Rename spec files to not have numbers everywhere; update targets.yaml
9 years ago
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
98d91d0c2b
Make the example room id more "random" so that people are less likely to think that it is supposed to be human readable
9 years ago
f60190086a
Describe the behaviour of /rooms/{roomId}/member when the user has left the room
9 years ago
067363c629
Get the desired title levels right; print out the actual level used to stdout
9 years ago
ba6c7d267c
SPEC-216: Document the behaviour of the room getters when the user has left the room
9 years ago
615a9575cb
SPEC-216: Clarify when the room getters will return 403
9 years ago
cb41adee70
Fix the swagger host to be "localhost:8008" so that it can be used in a "Try it now" setup against localhost
9 years ago
d5e0115e42
Merge branch 'master' into spec-restructure-modules
9 years ago
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
9 years ago
2efadea583
Merge branch 'master' into markjh/document_v1_rooms_api
9 years ago
8590cc84b5
Process and extract targets in gendoc.py
9 years ago
83ee385543
Merge pull request #55 from matrix-org/markjh/codehighlighting
...
Turn on code highlighting for HTTP api responses
9 years ago
a64125772f
Merge pull request #58 from matrix-org/markjh/jenkins
...
Add the jenkins command to git so that we can update it
9 years ago
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.
9 years ago
738b24d028
Merge pull request #57 from matrix-org/markjh/example_checker
...
Python script for checking that the examples match the event schema.
9 years ago
8974b2b67b
Skip files that start with ".", e.g. vim swp files.
9 years ago
6ba9b29b3b
Report all the errors in schemas/check_examples, not just the first error.
9 years ago
568982ee2e
Represent nested deps in targets.yaml along with title styles
...
This will allow us to programatically position .rst snippets *anywhere*
which will for once and for all remove the horrid title level mismatch bugs.
We require this in order to allow people to re-shuffle the spec without
having to adjust the spec itself (e.g. 2 targets with different levels of
nesting).
9 years ago
703f913a47
Add a 'targets.yaml' files in /specification
...
We're well beyond the point now where a simple `cat` of .rst files to "build"
the spec is practical. We may want to slice and dice the spec in different
ways to address various cross-cutting concerns. To this end, there is now a
'targets' file which contains the "build targets" for the spec, which contains
the sorting order for the .rst files. For now, we just have a single
target: 'main'.
9 years ago
f520ac9d82
Create a modules folder to group together similar parts of the spec
9 years ago
c77ef1a2cc
Add stub files feature_profiles and modules
9 years ago
f2c952ec58
Reshuffle spec into sections roughly right as per PR #52
9 years ago
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
6a2c4d27fc
Update the docs for room v1 api
9 years ago
f33c0846c3
Merge remote-tracking branch 'origin/master' into markjh/document_v1_rooms_api
9 years ago
6b5b8432b3
Turn on code highlighting for HTTP api responses and add a
...
code highlighting stylesheet for the specification.
9 years ago
d2e39095fe
Merge pull request #54 from matrix-org/markjh/swagger_examples
...
Add script to check the example responses match the schema.
9 years ago
f827765ba1
Make to code to skip checking swagger responses which don't have an
...
application/json example clearer.
9 years ago
9896f98e2b
Search for yaml swagger files if check_examples.py is run without
...
arguments.
9 years ago
7c2ccb1aeb
Merge remote-tracking branch 'origin/master' into markjh/swagger_examples
9 years ago
299a4356d4
Add script to check that the example responses in the swagger matches
...
the examples.
9 years ago
5fbd534713
Merge pull request #51 from matrix-org/daniel/gendoc
...
Print errors to stderr
9 years ago
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
7ac5c3766c
Merge remote-tracking branch 'origin/master' into markjh/event-schema
...
Conflicts:
templating/matrix_templates/units.py
9 years ago
a2cfb89086
Merge pull request #52 from matrix-org/spec-file-structure
...
Spec file structure
9 years ago
cf8abdafd4
Fix PR comments
9 years ago
ba4998a62b
Apparently tabs are A Thing
9 years ago
427e4c8b1b
Log port being listened on
9 years ago
1540b1fe3c
Merge branch 'markjh/swagger' into markjh/event-schema
...
Conflicts:
templating/matrix_templates/units.py
9 years ago
f99a38ce72
Update the hard-coded paths in templating units.py.
...
Replace the hard code paths with global variables.
9 years ago
63f08bace6
Fix the examples in the swagger API documentation to be valid JSON
9 years ago
Kegan Dougal