Commit graph

772 commits

Author SHA1 Message Date
Mark Haines d2e39095fe Merge pull request #54 from matrix-org/markjh/swagger_examples
Add script to check the example responses match the schema.
2015-09-18 16:37:07 +01:00
Mark Haines f827765ba1 Make to code to skip checking swagger responses which don't have an
application/json example clearer.
2015-09-18 16:35:27 +01:00
Mark Haines 9896f98e2b Search for yaml swagger files if check_examples.py is run without
arguments.
2015-09-18 16:21:48 +01:00
Mark Haines 7c2ccb1aeb Merge remote-tracking branch 'origin/master' into markjh/swagger_examples 2015-09-18 16:11:26 +01:00
Mark Haines 299a4356d4 Add script to check that the example responses in the swagger matches
the examples.
2015-09-18 16:10:21 +01:00
Kegsay 5fbd534713 Merge pull request #51 from matrix-org/daniel/gendoc
Print errors to stderr
2015-09-18 15:50:56 +01:00
Kegsay f1da162a00 Merge pull request #53 from matrix-org/markjh/event-schema
Allow relative references to schema to work in python and node.
2015-09-18 15:50:13 +01:00
Mark Haines 7ac5c3766c Merge remote-tracking branch 'origin/master' into markjh/event-schema
Conflicts:
	templating/matrix_templates/units.py
2015-09-18 15:49:36 +01:00
Kegsay a2cfb89086 Merge pull request #52 from matrix-org/spec-file-structure
Spec file structure
2015-09-18 15:44:19 +01:00
Kegan Dougal cf8abdafd4 Fix PR comments 2015-09-18 15:42:49 +01:00
Kegan Dougal ba4998a62b Apparently tabs are A Thing 2015-09-18 15:15:55 +01:00
Kegan Dougal 427e4c8b1b Log port being listened on 2015-09-18 15:15:55 +01:00
Mark Haines 1540b1fe3c Merge branch 'markjh/swagger' into markjh/event-schema
Conflicts:
	templating/matrix_templates/units.py
2015-09-18 14:46:20 +01:00
Mark Haines f99a38ce72 Update the hard-coded paths in templating units.py.
Replace the hard code paths with global variables.
2015-09-18 14:43:57 +01:00
Mark Haines 63f08bace6 Fix the examples in the swagger API documentation to be valid JSON 2015-09-18 14:40:48 +01:00
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
2015-09-18 11:43:53 +01:00
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.
2015-09-18 11:39:44 +01:00
Kegan Dougal 06e46c1899 Fix on a better numbering format 2015-09-18 11:20:34 +01:00
Kegan Dougal 91d674b3c7 Merge branch 'spec-edits-cleanup' into spec-file-structure 2015-09-18 11:10:17 +01:00
Kegsay 28f3e61d04 Merge pull request #50 from matrix-org/spec-edits-cleanup
Spec: typo/layout fixes
2015-09-18 11:10:01 +01:00
Kegan Dougal 9ed39665c8 PR feedback 2015-09-18 11:09:04 +01:00
Kegan Dougal ef473b4161 Start enforcing title styles
This depends on the number of the file.
2015-09-18 11:05:48 +01:00
Daniel Wagner-Hall 08defafd98 Print errors to stderr
This means that continuserv will actually display them
2015-09-18 10:26:13 +01:00
Daniel Wagner-Hall 0b183f06f8 Merge pull request #49 from matrix-org/continuserv-logging
Continuserv: Log port being listened on
2015-09-18 10:18:09 +01:00
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(!)
2015-09-18 10:03:58 +01:00
Kegan Dougal 8e7b33ac99 Fix more typos/spelling errors 2015-09-18 09:40:53 +01:00
Kegan Dougal 3f9d183c2a More typo/layout fixes
Split out identity servers to a separate file
2015-09-18 09:25:40 +01:00
Kegan Dougal 620d3dcb26 Test commit 2015-09-17 17:51:44 +01:00
Kegan Dougal faa95e172f More formatting fixes; typos; etc 2015-09-17 17:49:57 +01:00
Mark Haines 46d29e9eea fix the room api swagger to be valid swagger 2015-09-17 16:48:07 +01:00
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.
2015-09-17 16:38:58 +01:00
Kegan Dougal 5b59c67510 Minor formatting fixes. Fix state event templating. 2015-09-17 16:34:20 +01:00
Mark Haines 654ed9b99e Remove keys from the m.room.* schema files so that they may be used in the node swagger validator 2015-09-17 16:00:06 +01:00
Kegan Dougal 9c3a333a6d Apparently tabs are A Thing 2015-09-17 15:49:01 +01:00
Kegan Dougal 9b18fd252e Log port being listened on 2015-09-17 15:46:37 +01:00
Mark Haines 315f97e36b Merge branch 'master' into markjh/document_v1_rooms_api 2015-09-17 15:25:00 +01:00
Kegsay bb441427ac Merge pull request #48 from matrix-org/markjh/swagger
De-duplicate event schema
2015-09-17 15:16:02 +01:00
Mark Haines fd3401fc7a Remove accidentally committed swp file 2015-09-17 14:44:17 +01:00
Mark Haines d0b018c46e Fix syntax error in JSON 2015-09-17 14:43:09 +01:00
Mark Haines 380f186273 Log which file a json parse error occurred in 2015-09-17 14:42:43 +01:00
Mark Haines c49338006a replace definitions/*event.yaml with symlinks to /event-schemas/ 2015-09-17 13:09:35 +01:00
Mark Haines 2cf8da6b20 Update the gendoc script to load the core event schema from
separate files.
2015-09-17 10:28:57 +01:00
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.
2015-09-17 10:09:37 +01:00
Daniel Wagner-Hall cf13701450 Merge branch 'master' into macaroons 2015-09-15 16:47:11 +01:00
Mark Haines 4d302d10c4 Merge pull request #47 from matrix-org/daniel/chdor
Fix chdir path
2015-09-15 16:38:47 +01:00
Daniel Wagner-Hall 21411309e0 Fix chdir path 2015-09-15 16:27:10 +01:00
Daniel Wagner-Hall 2e9d3d283a Swagger refresh tokens 2015-09-15 16:23:19 +01:00
Daniel Wagner-Hall 0f525e18b4 Merge branch 'master' into macaroons
Conflicts:
	specification/10_client_server_api.rst
2015-09-15 15:58:16 +01:00
Mark Haines 7eb8b4fde2 Add new-style docs for the APIs for getting events for a room 2015-09-15 15:52:36 +01:00
Kegsay 7fec98d651 Merge pull request #46 from matrix-org/markjh/gendoc_directory
Set the current directory in gendoc.py to the scripts directory
2015-09-15 11:55:18 +01:00