0
0
Fork 0
Commit Graph

303 Commits

Author SHA1 Message Date
Mark Haines ebc0237109 Add the missing titles to the schema 2015-11-03 19:35:44 +00:00
Paul "LeoNerd" Evans 30a4f17420 Don't mark 'aliases' on m.room.canonical_alias as required, because it isn't. 2015-11-03 16:15:36 +00:00
Mark Haines d53814097f Add example content to the tags in example tag events 2015-11-03 15:57:06 +00:00
Mark Haines fba3c04e42 Apparently the spec generator breaks if the title in a schema is too long 2015-11-03 15:48:30 +00:00
Mark Haines bcb8fac53c Add a description for the tag event 2015-11-03 15:46:01 +00:00
Mark Haines 52f55e0542 Allow room tags to have asssociated content, and return that content in the m.tag events 2015-11-02 13:31:25 +00:00
Daniel Wagner-Hall 9f4d81308d Pull out separate invite_room_state example 2015-10-30 16:21:50 +00:00
Daniel Wagner-Hall 810922bb38 Fix schema validator for multiple examples 2015-10-28 15:06:44 +00:00
Daniel Wagner-Hall 176f919fc8 Show multiple examples where present 2015-10-28 15:00:53 +00:00
Daniel Wagner-Hall b92a0f2b4d Remove extra trailing comma 2015-10-28 14:49:41 +00:00
Daniel Wagner-Hall 81a60a25cc Update 3pid spec based on new implementation 2015-10-28 14:46:10 +00:00
Mark Haines 12e33a3b09 Document a v2 api for setting tags on rooms 2015-10-26 16:14:24 +00:00
Daniel Wagner-Hall 67880686d5 Allow history to be noted as world-readable
SPEC-237
2015-10-23 14:02:53 +01:00
Kegsay 074c7d480c Merge pull request #113 from matrix-org/invite-room-state
Add invite_room_state to spec
2015-10-21 09:37:44 +01:00
Daniel Wagner-Hall a9a9067d7e Merge pull request #114 from matrix-org/daniel/3pidtosigned
Update 3pid invite section to reflect signed property
2015-10-19 15:52:50 +01:00
Kegan Dougal bbd3f8072c Review comments 2015-10-19 13:28:44 +01:00
Daniel Wagner-Hall b7355b0fa5 Merge pull request #117 from matrix-org/daniel/jenkins
Give useful error if z-schema is missing
2015-10-19 13:24:00 +01:00
Daniel Wagner-Hall b2aae762fc Give useful error if z-schema is missing 2015-10-19 12:36:49 +01:00
Daniel Wagner-Hall f51e031066 Fix JSON 2015-10-19 12:36:10 +01:00
Kegan Dougal ae90d15b3c Add m.room.avatar 2015-10-19 10:46:07 +01:00
Daniel Wagner-Hall a38e0862cf Fix required field names 2015-10-16 18:56:07 +01:00
Daniel Wagner-Hall 6161a920b6 Update 3pid invite section to reflect signed property 2015-10-16 18:29:20 +01:00
Kegan Dougal 83d21484df Oopsie 2015-10-16 16:54:40 +01:00
Kegan Dougal a8d8412068 Add invite_room_state example. 2015-10-16 16:48:18 +01:00
Kegan Dougal d39a9082a0 Add invite_room_state to spec. Flesh out info. 2015-10-16 16:43:33 +01:00
Kegsay 604e268add Merge pull request #105 from matrix-org/spec-177-events-max-len
Add in size limits as per SPEC-222
2015-10-15 11:08:28 +01:00
Kegsay c5dc383668 Merge pull request #85 from matrix-org/module-im
Instant messaging module
2015-10-15 10:59:41 +01:00
Kegan Dougal 6a0595bc46 Add in size limits as per SPEC-222 2015-10-14 16:15:55 +01:00
Kegan Dougal 4170dbd5cf Review comments 2015-10-13 11:29:54 +01:00
Daniel Wagner-Hall dc3c02aff5 Review comments 2015-10-08 10:08:38 -05:00
Daniel Wagner-Hall 21a40b317d Merge branch 'master' into daniel/threepidinvites-2 2015-10-08 09:41:17 -05:00
Kegan Dougal 8e5c832ff9 Flesh out more of the IM module 2015-10-05 13:45:23 +01:00
Erik Johnston 3b4c3522e6 Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/disable_federation 2015-10-05 09:17:28 +01:00
Kegsay ead79614ff Merge pull request #78 from matrix-org/module-typing2
Typing module
2015-10-02 14:36:30 +01:00
Daniel Wagner-Hall 9d8dc7971d Review comments 2015-10-02 08:33:12 -05:00
Daniel Wagner-Hall 9cda004848 Fix ref 2015-10-01 22:27:19 -05:00
Daniel Wagner-Hall fdccf35c47 Banish more tabs 2015-10-01 22:23:24 -05:00
Daniel Wagner-Hall e996933a29 Banish the tabs 2015-10-01 22:21:34 -05:00
Daniel Wagner-Hall af7d2ca9fc Update 3pid invite spec
This takes into account:
 1) That finding the existing servers of a room is hard
 2) Federation
2015-10-01 22:19:11 -05:00
Kegan Dougal 1520f3647f Merge branch 'master' into module-typing2
Conflicts:
	specification/modules/typing_notifications.rst
2015-10-01 15:47:46 +01:00
Kegan Dougal c972dad8b3 Flesh out receipts module. Add receipts swagger
Add templating support for v2 apis.
2015-10-01 15:41:54 +01:00
Kegan Dougal 365a9076b9 Add nested dict template support; Add x-pattern
For cases where event schema specify `patternProperties` it would be nice
to give that pattern a "human-readable" form rather than a raw regex. This
is now supported by specifying `x-pattern` in the value part of the specified
pattern e.g. `patternProperties:{ "^.*":{ x-pattern: "$THING", ... } }`

Templating had limited record type descriptions limited to value primitives
e.g. `{string: integer}`. It now supports inspecting the values recursively
if the value is `object`.

Updated `m.receipt` to take both these points into account to make it read
better. Tweak receipt module text.
2015-10-01 12:11:26 +01:00
Erik Johnston 9964dd1401 Make explicit the state event only includes some keys 2015-09-30 16:11:34 +01:00
Kegan Dougal 2b7e02c080 Add sections for typing. Add swagger, JSON schema and example m.typing event 2015-09-30 15:51:04 +01:00
Erik Johnston 7b4c8a9f68 Indicate default for m.federate key 2015-09-29 16:19:27 +01:00
Erik Johnston affc2cfc92 Add 'm.federate' flag to 'm.room.create; 2015-09-28 16:39:54 +01:00
Erik Johnston d7d9f406a6 Bundle some state into invites 2015-09-25 14:21:50 +01:00
Mark Haines 2efadea583 Merge branch 'master' into markjh/document_v1_rooms_api 2015-09-21 16:35:31 +01:00
Mark Haines 8974b2b67b Skip files that start with ".", e.g. vim swp files. 2015-09-21 15:05:10 +01:00
Mark Haines 6ba9b29b3b Report all the errors in schemas/check_examples, not just the first error. 2015-09-21 15:04:03 +01:00
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.
2015-09-21 13:02:37 +01:00
Mark Haines 6a2c4d27fc Update the docs for room v1 api 2015-09-18 17:58:44 +01:00
Mark Haines f33c0846c3 Merge remote-tracking branch 'origin/master' into markjh/document_v1_rooms_api 2015-09-18 17:38:03 +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
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
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 c49338006a replace definitions/*event.yaml with symlinks to /event-schemas/ 2015-09-17 13:09:35 +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
Kegsay 3011823c51 Merge pull request #27 from matrix-org/receipts
Document receipts
2015-09-10 16:18:19 +01:00
Erik Johnston 500b4eb32d Typo 2015-09-08 16:54:14 +01:00
Erik Johnston 53756cfd73 More commas 2015-09-08 16:52:43 +01:00
Erik Johnston 5157c2f52e More escapes 2015-09-08 16:51:08 +01:00
Erik Johnston e58f816ad3 Add m.receipt schema 2015-09-08 16:49:14 +01:00
Kegsay 5e7665054e Merge pull request #28 from matrix-org/history_visibility
Document m.room.history_visibility
2015-09-04 13:33:51 +01:00
Erik Johnston b4c2cba406 State key should be empty 2015-09-04 13:31:51 +01:00
Erik Johnston 1e3d9a6a50 Typo 2015-09-04 13:30:11 +01:00
Erik Johnston c6d143447b Add schemas 2015-09-04 13:27:01 +01:00
Erik Johnston 40f037da55 Get the right type 2015-09-04 11:54:53 +01:00
Erik Johnston 3aabb77cb4 Capitilasation matters 2015-09-04 11:53:07 +01:00
Erik Johnston 61f1424124 No trailing commas 2015-09-04 11:51:13 +01:00
Erik Johnston 03b8c7a12b Document the canonical alias event 2015-09-04 11:43:11 +01:00
Kegan Dougal c3a298a5df Fix sort order for VoIP events. 2015-05-28 11:35:18 +01:00
Kegan Dougal 9abadaf7af Add {{presence_events}} template. 2015-05-28 10:36:02 +01:00
Kegan Dougal 59f856c7e6 Factor out ImageInfo into a core type. Refer to that in other msgtypes.
Add templating for msgtypes. ImageInfo core type is not referred to for
m.image in order for the ImageInfo table to render for it.
2015-05-27 16:30:11 +01:00
Kegan Dougal 59168df363 Add schema/example files for all specced msgtypes. 2015-05-27 15:32:22 +01:00
Kegan Dougal 06177740d4 Tweak how constants are represented. 2015-05-26 17:39:38 +01:00
Kegan Dougal 9d7f2baf5c Mention that knock/private on join_rules are not implemented. 2015-05-26 11:21:20 +01:00
Kegan Dougal 003ca35bf6 Spell 'overridden' correctly. 2015-05-26 10:08:05 +01:00
Kegan Dougal 86be22dc35 s/0-length/zero-length/g 2015-05-21 16:04:52 +01:00
Kegan Dougal 6dcbc40b63 Add common event field descriptions and template. 2015-05-21 15:41:34 +01:00
Kegan Dougal 73d84f3722 Add descriptions to state_keys. Add it into the template. 2015-05-21 13:31:08 +01:00
Kegan Dougal 6a41bd9b82 Add descriptions to event fields 2015-05-21 12:02:07 +01:00
Kegan Dougal a42a22028c Add event table template. Also inspect arrays for objects. 2015-05-21 10:39:54 +01:00
Kegan Dougal 0899e0b772 Update event schema parsing.
The templating system now parses event schemas into a form which
can be easily dumped into multiple tables (for nested object types)
2015-05-21 09:46:14 +01:00
Kegan Dougal bfb6d920d2 Add missing m.call descriptions 2015-05-20 17:40:14 +01:00
Kegan Dougal d2fd1baab2 Add descriptions to m.call schemas 2015-05-20 16:19:17 +01:00
Kegan Dougal 66bbc30893 Update check.sh now that z-schema returns 1 on error (v3.10.2+) 2015-05-20 14:36:54 +01:00
Kegan Dougal e8d11e8321 Add check.sh to automatically run z-schema over all schema files and test against examples. 2015-05-20 13:17:51 +01:00
Kegan Dougal e62e7b95cd Rename msgtype examples to have # separator 2015-05-20 12:52:52 +01:00
Kegan Dougal 75e7d09fc8 Remove newlines from json: move line wrapping to the template files. 2015-05-20 12:41:25 +01:00
Kegan Dougal 8f448a1764 Produce valid JSON (escape \n), add indent filter 2015-05-20 11:49:10 +01:00
Kegan Dougal c61223fb27 Add title/desc to lots of event schemas, add missing keys (e.g. avatar_url, displayname), add required keys section to spec. 2015-05-19 16:49:20 +01:00
Kegan Dougal 9fd57c6fe6 Namespace all the things to v1. 2015-05-19 15:28:08 +01:00
Kegan Dougal b4d245bce3 Add m.call.invite/candidates/answer/hangup 2015-05-18 17:54:17 +01:00
Kegan Dougal 6f842da227 Add redaction, feedback and presence events. 2015-05-18 17:28:38 +01:00
Kegan Dougal c78088cfd1 Add m.room.aliases/create/join_rules/member/power_levels 2015-05-18 17:10:11 +01:00
Kegan Dougal 5216b1ac8a Add m.room.topic. Add title/descs. Add 'type' key checking. 2015-05-18 16:52:03 +01:00
Kegan Dougal 809ec63b9c Dump schema in a subdir for purity. 2015-05-18 16:23:32 +01:00
Kegan Dougal 8ec10bbdf2 Add m.room.name and state_key core schema. 2015-05-18 16:21:09 +01:00
Kegan Dougal a8af9bef29 Add example events.
These can be used for assertions as well as drop ins for the spec.
2015-05-18 16:13:41 +01:00
Kegan Dougal c370599a17 Add README 2015-05-18 16:00:26 +01:00
Kegan Dougal f0188a46d1 Add event-schema directory and m.room.message schema. 2015-05-18 15:48:46 +01:00