f8ce497bd6
Fix inconsistency: `join_rules` => `join_rule`
...
All other docs do not have `join_rules` but `join_rule`
This PR fix this inconsistency.
Mentioned by @digital:sorunome.de in [#matrix-dev:matrix.org](https://matrix.to/#/!XqBunHwQIXUiqCaoxq:matrix.org/$150142347531959wjGGm:sorunome.de )
7 years ago
750d980bc0
Room member ( #950 )
...
* Fixed an incorrect membership on example
* Added precision on membership upon profile update
* Changed first example into a join
* Changed the state/{eventType}/{stateKey} example with an actual state key
7 years ago
852f4edead
redacts is an eventID not a roomID (! -> $)
7 years ago
c1b375b2ac
Clarify that age is generated on the local HS
...
Signed-off-by: Johannes Löthberg <johannes@kyriasis.com>
8 years ago
d9894aeffd
Make m.notice description use stricter language
...
Signed-off-by: Johannes Löthberg <johannes@kyriasis.com>
8 years ago
6f1c598db8
Make the key orders consistent
8 years ago
05001bcaa6
Fix whitepace
8 years ago
29e33deeb5
Fix m.location example
8 years ago
30f9ea0225
Spelling
8 years ago
5ccf41bafc
Add type: object
8 years ago
6ecb5d0729
re-order thumbnail keys
8 years ago
4349982189
Fix path
8 years ago
2fdca5a995
Add a thumbnail_info common schema, deduplicate m.room.avatar and m.room.message#m.image
8 years ago
1b661b64dc
Move m.location thumbnail_url to be inside info to match m.video
8 years ago
14d05464ee
Move m.file thumbnail_url to be inside info to match m.video
8 years ago
25b41c7551
Move m.image thumbnail_url to be inside info to match m.video
8 years ago
dfbe416490
Better types for additionalProps
...
recurse down the definitions for additionalProps, so that the types are better
8 years ago
4480553bf9
Move m.direct description to the swagger
...
Also change the swagger to yaml so I can put that description in it
without having to figure out how to embed that in json.
8 years ago
b789251f70
More PR feedback
8 years ago
8af90bfc21
Clarify 'this room'
8 years ago
85bc989c02
pr feedback
8 years ago
8fe8bd6a81
Add is_direct to member event spec.
8 years ago
cade909e25
Fix inconsistencies regarding redacted_because
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
1c02ff5249
Specify requirement of origin_server_ts
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
49cd65dd58
Add a license to the spec
...
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
8 years ago
d724b6bf75
Make null m.room.name behaviour explicit
...
PR feedback
8 years ago
be9dccb266
m.room.canonical alias: fix schema syntax
8 years ago
d4194dd24e
Clarify the room-naming behaviour
...
Make behaviour on empty `m.room.name` and `m.room.canonical_alias` events
explicit.
8 years ago
4f37e4ece0
Merge pull request #342 from matrix-org/erikj/presence
...
Fix and correctly document presence's currently_active
9 years ago
c83940750c
Update m.presence
9 years ago
adb5768731
m.room.power_levels: clarify documentation
...
- clarify description and add text for invite, ban, etc.
- the keys aren't required. Document their defaults
- add 'invite' to example
9 years ago
e594132e95
m.room.member: yaml tweak
...
Quote "string" for consistency with "null"
9 years ago
5b12e2cfef
Convert event schemas to yaml
...
We've decided to make the event schemas YAML, so we might as well take
advantage of it.
(This conversion was done mostly automatically, except for:
- s/null/"null"/ in m.room.member
- reformat description in m.room.power_levels
9 years ago
2eebacacfe
Merge pull request #286 from matrix-org/dbkr/default_state_defaults
...
Update spec to say what the default state / events defaults are
9 years ago
33ec8dde88
m.room.power_levels: More newlines
9 years ago
8c3838bc04
Formatting tweaks for m.room.power_levels
9 years ago
df0e070146
Merge pull request #321 from matrix-org/rav/fix_eventschema_readme
...
Update eventschema readme
9 years ago
2e9212af8a
Fix typo in m.room.member schema
...
remove spurious SHOULD
9 years ago
4bc78633a5
We don't support z-schema or other JSON tools for now
9 years ago
d94deb6296
Add event as a parent for all event types
...
Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>
9 years ago
dd6dfa7635
Merge pull request #291 from gergelypolonkai/room-avatar-image-info
...
Update m.room.avatar schema so it references image_info in info
9 years ago
77f495d36f
Remove restrictions on StrippedState
...
Note also that these are purely informational and not things on which to
rely.
SPEC-357
9 years ago
6e2b02a608
Update m.room.avatar schema so it references image_info in info
...
Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>
9 years ago
583c8cbfaf
Add invite key to m.room.power_levels schema
...
Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>
9 years ago
449bb09998
Fix for m.room.third_party_invite schema
9 years ago
65e5a316bd
Update spec to say what the default state / events defaults are, from inspecting the behaviour of synapse (which I'm not sure was intentional).
9 years ago
11c572267e
Add titles where they're missing
9 years ago
ea170e5dca
m.third_party_invite: Allow multiple public keys
9 years ago
c959ca689c
Explain what the room member states mean
9 years ago
9bfe86f474
Add display_name to 3pid invites in m.room.member
9 years ago
f81b967e2d
Make all the schema files yaml
9 years ago
63ca91f353
Move event signing to server-server spec
...
It's *definitely* not a client concern.
It isn't really in the right place at the moment, but s-s is very much a
work in progress whereas c-s is nearly stable.
9 years ago
aa4ed10821
Unify v1 and v2 event schemas
9 years ago
79244e8065
Remove redundant node event schema checker
...
The python one does the same
9 years ago
6c66bfc755
Flatten out v1 and v2_alpha directories
...
As a side effect, I got rid of all of the horrible symlinks and just put
in all of the proper relative paths. Because the horrible symlinks were
horrible.
9 years ago
eb61f018c2
Merge pull request #144 from matrix-org/paul/small-fixes
...
Don't mark 'aliases' on m.room.canonical_alias as required
9 years ago
c5f457cee9
Merge pull request #132 from matrix-org/markjh/room_tags
...
Document a v2 api for setting tags on rooms
9 years ago
4faede73a1
Merge branch 'master' into daniel/multipleexamples
9 years ago
5bae15d47b
Merge branch 'master' into markjh/room_tags
...
Conflicts:
api/client-server/v2_alpha/sync.yaml
9 years ago
3b390bff3c
Merge branch 'master' into markjh/room_tags
...
Conflicts:
api/client-server/v1/rooms.yaml
specification/targets.yaml
9 years ago
4d3175fc8b
Note that invite_room_state is optional
9 years ago
071edcd86e
Merge branch 'master' into daniel/multipleexamples
9 years ago
e72151f2c3
Specify guest room access
...
This was reviewed as PR #150 and merged from daniel/anonymousaccess
9 years ago
2734f9f9f2
Merge branch 'master' into daniel/multipleexamples
...
Conflicts:
specification/modules/third_party_invites.rst
9 years ago
161441fa3a
Update 3pid spec based on new implementation
9 years ago
ebc0237109
Add the missing titles to the schema
9 years ago
30a4f17420
Don't mark 'aliases' on m.room.canonical_alias as required, because it isn't.
9 years ago
d53814097f
Add example content to the tags in example tag events
9 years ago
fba3c04e42
Apparently the spec generator breaks if the title in a schema is too long
9 years ago
bcb8fac53c
Add a description for the tag event
9 years ago
52f55e0542
Allow room tags to have asssociated content, and return that content in the m.tag events
9 years ago
9f4d81308d
Pull out separate invite_room_state example
9 years ago
810922bb38
Fix schema validator for multiple examples
9 years ago
176f919fc8
Show multiple examples where present
9 years ago
b92a0f2b4d
Remove extra trailing comma
9 years ago
81a60a25cc
Update 3pid spec based on new implementation
9 years ago
12e33a3b09
Document a v2 api for setting tags on rooms
9 years ago
67880686d5
Allow history to be noted as world-readable
...
SPEC-237
9 years ago
074c7d480c
Merge pull request #113 from matrix-org/invite-room-state
...
Add invite_room_state to spec
9 years ago
a9a9067d7e
Merge pull request #114 from matrix-org/daniel/3pidtosigned
...
Update 3pid invite section to reflect signed property
9 years ago
bbd3f8072c
Review comments
9 years ago
b7355b0fa5
Merge pull request #117 from matrix-org/daniel/jenkins
...
Give useful error if z-schema is missing
9 years ago
b2aae762fc
Give useful error if z-schema is missing
9 years ago
f51e031066
Fix JSON
9 years ago
ae90d15b3c
Add m.room.avatar
9 years ago
a38e0862cf
Fix required field names
9 years ago
6161a920b6
Update 3pid invite section to reflect signed property
9 years ago
83d21484df
Oopsie
9 years ago
a8d8412068
Add invite_room_state example.
9 years ago
d39a9082a0
Add invite_room_state to spec. Flesh out info.
9 years ago
604e268add
Merge pull request #105 from matrix-org/spec-177-events-max-len
...
Add in size limits as per SPEC-222
9 years ago
c5dc383668
Merge pull request #85 from matrix-org/module-im
...
Instant messaging module
9 years ago
6a0595bc46
Add in size limits as per SPEC-222
9 years ago
4170dbd5cf
Review comments
9 years ago
dc3c02aff5
Review comments
9 years ago
21a40b317d
Merge branch 'master' into daniel/threepidinvites-2
9 years ago
8e5c832ff9
Flesh out more of the IM module
9 years ago
3b4c3522e6
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/disable_federation
9 years ago
ead79614ff
Merge pull request #78 from matrix-org/module-typing2
...
Typing module
9 years ago
9d8dc7971d
Review comments
9 years ago
9cda004848
Fix ref
9 years ago
fdccf35c47
Banish more tabs
9 years ago
e996933a29
Banish the tabs
9 years ago
af7d2ca9fc
Update 3pid invite spec
...
This takes into account:
1) That finding the existing servers of a room is hard
2) Federation
9 years ago
1520f3647f
Merge branch 'master' into module-typing2
...
Conflicts:
specification/modules/typing_notifications.rst
9 years ago
c972dad8b3
Flesh out receipts module. Add receipts swagger
...
Add templating support for v2 apis.
9 years ago
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.
9 years ago
9964dd1401
Make explicit the state event only includes some keys
9 years ago
2b7e02c080
Add sections for typing. Add swagger, JSON schema and example m.typing event
9 years ago
7b4c8a9f68
Indicate default for m.federate key
9 years ago
affc2cfc92
Add 'm.federate' flag to 'm.room.create;
9 years ago
d7d9f406a6
Bundle some state into invites
9 years ago
2efadea583
Merge branch 'master' into markjh/document_v1_rooms_api
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
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
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
654ed9b99e
Remove keys from the m.room.* schema files so that they may be used in the node swagger validator
9 years ago
fd3401fc7a
Remove accidentally committed swp file
9 years ago
d0b018c46e
Fix syntax error in JSON
9 years ago
c49338006a
replace definitions/*event.yaml with symlinks to /event-schemas/
9 years ago
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
3011823c51
Merge pull request #27 from matrix-org/receipts
...
Document receipts
9 years ago
500b4eb32d
Typo
9 years ago
53756cfd73
More commas
9 years ago
5157c2f52e
More escapes
9 years ago
e58f816ad3
Add m.receipt schema
9 years ago
5e7665054e
Merge pull request #28 from matrix-org/history_visibility
...
Document m.room.history_visibility
9 years ago
b4c2cba406
State key should be empty
9 years ago
1e3d9a6a50
Typo
9 years ago
c6d143447b
Add schemas
9 years ago
40f037da55
Get the right type
9 years ago
3aabb77cb4
Capitilasation matters
9 years ago
61f1424124
No trailing commas
9 years ago
03b8c7a12b
Document the canonical alias event
9 years ago
c3a298a5df
Fix sort order for VoIP events.
10 years ago
9abadaf7af
Add {{presence_events}} template.
10 years ago
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.
10 years ago
59168df363
Add schema/example files for all specced msgtypes.
10 years ago
06177740d4
Tweak how constants are represented.
10 years ago
9d7f2baf5c
Mention that knock/private on join_rules are not implemented.
10 years ago
003ca35bf6
Spell 'overridden' correctly.
10 years ago
86be22dc35
s/0-length/zero-length/g
10 years ago
6dcbc40b63
Add common event field descriptions and template.
10 years ago
73d84f3722
Add descriptions to state_keys. Add it into the template.
10 years ago
6a41bd9b82
Add descriptions to event fields
10 years ago
a42a22028c
Add event table template. Also inspect arrays for objects.
10 years ago
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)
10 years ago
bfb6d920d2
Add missing m.call descriptions
10 years ago
d2fd1baab2
Add descriptions to m.call schemas
10 years ago
66bbc30893
Update check.sh now that z-schema returns 1 on error (v3.10.2+)
10 years ago
e8d11e8321
Add check.sh to automatically run z-schema over all schema files and test against examples.
10 years ago
e62e7b95cd
Rename msgtype examples to have # separator
10 years ago
75e7d09fc8
Remove newlines from json: move line wrapping to the template files.
10 years ago
8f448a1764
Produce valid JSON (escape \n), add indent filter
10 years ago
c61223fb27
Add title/desc to lots of event schemas, add missing keys (e.g. avatar_url, displayname), add required keys section to spec.
10 years ago
9fd57c6fe6
Namespace all the things to v1.
10 years ago
b4d245bce3
Add m.call.invite/candidates/answer/hangup
10 years ago
6f842da227
Add redaction, feedback and presence events.
10 years ago
c78088cfd1
Add m.room.aliases/create/join_rules/member/power_levels
10 years ago
5216b1ac8a
Add m.room.topic. Add title/descs. Add 'type' key checking.
10 years ago
809ec63b9c
Dump schema in a subdir for purity.
10 years ago
8ec10bbdf2
Add m.room.name and state_key core schema.
10 years ago
a8af9bef29
Add example events.
...
These can be used for assertions as well as drop ins for the spec.
10 years ago
c370599a17
Add README
10 years ago
f0188a46d1
Add event-schema directory and m.room.message schema.
10 years ago
krombel