ef41b5c2bf
Server ACLs
...
Implements the proposal for https://github.com/matrix-org/matrix-doc/issues/1383
2018-08-22 12:48:37 -06:00
019c290fa2
document m.forwarded_room_key
2018-08-21 21:35:03 +02:00
2d8a321b46
document key sharing and m.room_key_request
2018-08-21 21:35:03 +02:00
3869f68a5c
Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions
2018-08-21 12:22:35 -06:00
f853856f21
add missing m.room.encrypted event properties
2018-08-18 11:41:45 +02:00
6c44233c42
require megolm algorithm in m.room.encryption
2018-08-18 11:41:45 +02:00
661176cb3a
Olm m.room.encrypted example
2018-08-18 11:41:45 +02:00
8732378da2
add required room ids
2018-08-18 11:41:45 +02:00
c60109d235
complete m.room_key documentation
2018-08-18 11:41:45 +02:00
3a8d13df60
add missing m.room.encryption properties
2018-08-18 11:41:45 +02:00
e5005b2d0f
document E2E events
...
This was written by Richard van der Hoff.
2018-08-18 11:41:45 +02:00
57571ea4ce
Merge branch 'master' of github.com:matrix-org/matrix-doc into notifications/room
2018-08-16 23:09:59 +01:00
fde48e7ee8
Specify how room versioning works
...
This is the spec PR for https://github.com/matrix-org/matrix-doc/issues/1425
Room version upgrades are not part of MSC1425.
Documented aspects:
* room_version on the create event
* creating a room with a specific version (useful for testing)
* make_join behaviour
* error code documentation
* grammar of room versions
Based upon https://docs.google.com/document/d/1urKgReoHqxX8R_XtySB17dPi-DZcKhqTEL2_s895Wz0/edit
2018-08-15 15:12:36 -06:00
55e4e90ab1
Document message formats as-is
...
This is likely to later be replaced by mixins, however this is being documented now so clients aren't left in the dark.
Fixes https://github.com/matrix-org/matrix-doc/issues/917
2018-07-10 12:52:11 -06:00
992bc8828a
Merge branches 'master' and 'notifications/room' of github.com:matrix-org/matrix-doc into notifications/room
2018-05-12 09:24:53 +01:00
c305317fa5
explicitly specify @room
2018-04-15 22:41:24 +01:00
60ae73b179
specify default
2018-04-15 22:37:23 +01:00
1e656d836e
spec notifications key on power level event and provide @room in example
2018-04-15 22:35:44 +01:00
8d05f80cec
Sticker messages (m.sticker) ( #1158 )
2018-03-27 10:00:41 +01:00
6e7d264bc7
Add clarity to the m.ignored_user_list
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-06 10:32:18 -07:00
0835612277
Represent the ignored users event correctly
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-06 10:21:38 -07:00
af74790681
Merge remote-tracking branch 'matrix-org/master' into travis/m.ignored_user_list
2018-03-06 10:18:24 -07:00
331e49bd0d
Improve the documentation of ignored users
...
* Fix the event schema to represent the real world
* Add the module to the spec targets
* Remove incomplete thought from the client behaviour
* Link to the account data API
* Minor word choice changes
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-06 09:00:32 -07:00
eb8c3255bf
Remove extraneous comma from m.presence schema
...
This causes the build to fail. Fixes #1146
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-05 18:45:57 -07:00
d37ed0876f
Merge branch 'master' into travis/m.ignored_user_list
2018-03-05 14:52:37 -07:00
a0dda3cae2
Merge branch 'master' into travis/m.tag
2018-03-05 18:58:53 +00:00
e862ef60ae
Spec ignoring users
...
Adds https://github.com/matrix-org/matrix-doc/issues/528
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-03 15:39:10 -07:00
a3f006353c
Tag ordering is defined as a number between 0 and 1, not strings
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-03 12:40:48 -07:00
a488bd5503
Make m.presence match what synapse returns
...
Considering this is the behaviour that is embedded into most client libraries and the most popular homeserver, it should be adopted as the standard.
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-03 12:12:47 -07:00
57e5e1e331
Document default room creator PL ( #1081 )
2017-11-20 16:22:30 +00:00
e5e249dce1
Remove redundant 'Required' annotations from event fields
2017-11-03 17:17:59 +00:00
23e2f8986c
Merge pull request #1026 from matrix-org/rav/power_levels_doc
...
Clarify what happens when there is no power_levels event
2017-10-17 20:54:18 +01:00
b4e24d443a
Clarify what happens when there is no power_levels event
2017-10-17 16:34:50 +01:00
a1265a274b
Add spec for m.room.pinned_events
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
2017-09-29 11:59:27 -06:00
0b74492d67
Fix membership on third-party invite upgrade ( #995 )
2017-09-26 14:57:51 +01:00
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 )
2017-07-31 12:04:24 +02:00
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
2017-07-14 15:30:56 +01:00
852f4edead
redacts is an eventID not a roomID (! -> $)
2017-07-05 16:18:49 +01:00
c1b375b2ac
Clarify that age is generated on the local HS
...
Signed-off-by: Johannes Löthberg <johannes@kyriasis.com>
2016-11-30 23:12:47 +01:00
d9894aeffd
Make m.notice description use stricter language
...
Signed-off-by: Johannes Löthberg <johannes@kyriasis.com>
2016-11-30 00:59:51 +01:00
6f1c598db8
Make the key orders consistent
2016-11-07 14:54:59 +00:00
05001bcaa6
Fix whitepace
2016-11-07 14:32:48 +00:00
29e33deeb5
Fix m.location example
2016-11-07 14:31:29 +00:00
30f9ea0225
Spelling
2016-11-07 14:30:16 +00:00
5ccf41bafc
Add type: object
2016-11-07 14:29:17 +00:00
6ecb5d0729
re-order thumbnail keys
2016-11-07 14:28:19 +00:00
4349982189
Fix path
2016-11-07 10:54:02 +00:00
2fdca5a995
Add a thumbnail_info common schema, deduplicate m.room.avatar and m.room.message#m.image
2016-11-07 10:50:52 +00:00
1b661b64dc
Move m.location thumbnail_url to be inside info to match m.video
2016-11-04 14:59:39 +00:00
14d05464ee
Move m.file thumbnail_url to be inside info to match m.video
2016-11-04 14:57:45 +00:00
25b41c7551
Move m.image thumbnail_url to be inside info to match m.video
2016-11-04 14:52:01 +00:00
dfbe416490
Better types for additionalProps
...
recurse down the definitions for additionalProps, so that the types are better
2016-10-14 15:57:52 +01:00
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.
2016-10-05 13:12:14 +01:00
b789251f70
More PR feedback
2016-10-05 12:59:49 +01:00
8af90bfc21
Clarify 'this room'
2016-10-04 15:08:48 +01:00
85bc989c02
pr feedback
2016-10-04 15:07:14 +01:00
8fe8bd6a81
Add is_direct to member event spec.
2016-10-03 17:33:45 +01:00
cade909e25
Fix inconsistencies regarding redacted_because
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
2016-08-30 21:18:55 -07:00
1c02ff5249
Specify requirement of origin_server_ts
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
2016-08-12 01:49:14 -07:00
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).
2016-07-12 17:28:30 +01:00
d724b6bf75
Make null m.room.name behaviour explicit
...
PR feedback
2016-07-12 13:44:04 +01:00
be9dccb266
m.room.canonical alias: fix schema syntax
2016-07-12 10:04:01 +01:00
d4194dd24e
Clarify the room-naming behaviour
...
Make behaviour on empty `m.room.name` and `m.room.canonical_alias` events
explicit.
2016-07-11 17:49:27 +01:00
4f37e4ece0
Merge pull request #342 from matrix-org/erikj/presence
...
Fix and correctly document presence's currently_active
2016-06-29 11:36:55 +01:00
c83940750c
Update m.presence
2016-06-29 10:42:33 +01:00
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
2016-06-22 17:45:49 +01:00
e594132e95
m.room.member: yaml tweak
...
Quote "string" for consistency with "null"
2016-06-22 17:32:01 +01:00
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
2016-06-22 12:01:08 +01:00
2eebacacfe
Merge pull request #286 from matrix-org/dbkr/default_state_defaults
...
Update spec to say what the default state / events defaults are
2016-05-13 11:30:34 +02:00
33ec8dde88
m.room.power_levels: More newlines
2016-05-13 10:28:26 +01:00
8c3838bc04
Formatting tweaks for m.room.power_levels
2016-05-13 10:26:27 +01:00
df0e070146
Merge pull request #321 from matrix-org/rav/fix_eventschema_readme
...
Update eventschema readme
2016-05-05 11:41:38 +01:00
2e9212af8a
Fix typo in m.room.member schema
...
remove spurious SHOULD
2016-05-05 11:07:37 +01:00
4bc78633a5
We don't support z-schema or other JSON tools for now
2016-05-05 10:50:03 +01:00
d94deb6296
Add event as a parent for all event types
...
Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>
2016-03-16 16:46:16 +01:00
dd6dfa7635
Merge pull request #291 from gergelypolonkai/room-avatar-image-info
...
Update m.room.avatar schema so it references image_info in info
2016-03-14 15:31:57 +00:00
77f495d36f
Remove restrictions on StrippedState
...
Note also that these are purely informational and not things on which to
rely.
SPEC-357
2016-03-10 14:27:54 +00:00
6e2b02a608
Update m.room.avatar schema so it references image_info in info
...
Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>
2016-03-08 16:32:19 +01:00
583c8cbfaf
Add invite key to m.room.power_levels schema
...
Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>
2016-03-08 15:50:27 +01:00
449bb09998
Fix for m.room.third_party_invite schema
2016-03-04 16:58:02 +01:00
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).
2016-03-02 18:31:14 +00:00
11c572267e
Add titles where they're missing
2016-03-02 15:23:48 +00:00
ea170e5dca
m.third_party_invite: Allow multiple public keys
2016-02-12 13:15:21 +00:00
c959ca689c
Explain what the room member states mean
2015-12-21 14:51:49 +00:00
9bfe86f474
Add display_name to 3pid invites in m.room.member
2015-12-17 19:01:20 +01:00
f81b967e2d
Make all the schema files yaml
2015-12-07 13:56:36 +00:00
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.
2015-12-04 10:55:18 +00:00
aa4ed10821
Unify v1 and v2 event schemas
2015-12-01 17:23:58 +00:00
79244e8065
Remove redundant node event schema checker
...
The python one does the same
2015-11-30 16:40:48 +00:00
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.
2015-11-30 11:22:57 +00:00
eb61f018c2
Merge pull request #144 from matrix-org/paul/small-fixes
...
Don't mark 'aliases' on m.room.canonical_alias as required
2015-11-27 15:42:36 +00:00
c5f457cee9
Merge pull request #132 from matrix-org/markjh/room_tags
...
Document a v2 api for setting tags on rooms
2015-11-27 15:31:54 +00:00
4faede73a1
Merge branch 'master' into daniel/multipleexamples
2015-11-25 14:29:33 +00:00
5bae15d47b
Merge branch 'master' into markjh/room_tags
...
Conflicts:
api/client-server/v2_alpha/sync.yaml
2015-11-20 18:39:15 +00:00
3b390bff3c
Merge branch 'master' into markjh/room_tags
...
Conflicts:
api/client-server/v1/rooms.yaml
specification/targets.yaml
2015-11-16 16:56:35 +00:00
4d3175fc8b
Note that invite_room_state is optional
2015-11-12 10:45:57 +00:00
071edcd86e
Merge branch 'master' into daniel/multipleexamples
2015-11-10 13:22:35 +00:00
e72151f2c3
Specify guest room access
...
This was reviewed as PR #150 and merged from daniel/anonymousaccess
2015-11-06 18:15:21 +00:00
2734f9f9f2
Merge branch 'master' into daniel/multipleexamples
...
Conflicts:
specification/modules/third_party_invites.rst
2015-11-05 18:33:31 +00:00
161441fa3a
Update 3pid spec based on new implementation
2015-11-05 18:11:20 +00:00
ebc0237109
Add the missing titles to the schema
2015-11-03 19:35:44 +00:00
30a4f17420
Don't mark 'aliases' on m.room.canonical_alias as required, because it isn't.
2015-11-03 16:15:36 +00:00
d53814097f
Add example content to the tags in example tag events
2015-11-03 15:57:06 +00:00
fba3c04e42
Apparently the spec generator breaks if the title in a schema is too long
2015-11-03 15:48:30 +00:00
bcb8fac53c
Add a description for the tag event
2015-11-03 15:46:01 +00:00
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
9f4d81308d
Pull out separate invite_room_state example
2015-10-30 16:21:50 +00:00
810922bb38
Fix schema validator for multiple examples
2015-10-28 15:06:44 +00:00
176f919fc8
Show multiple examples where present
2015-10-28 15:00:53 +00:00
b92a0f2b4d
Remove extra trailing comma
2015-10-28 14:49:41 +00:00
81a60a25cc
Update 3pid spec based on new implementation
2015-10-28 14:46:10 +00:00
12e33a3b09
Document a v2 api for setting tags on rooms
2015-10-26 16:14:24 +00:00
67880686d5
Allow history to be noted as world-readable
...
SPEC-237
2015-10-23 14:02:53 +01:00
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
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
bbd3f8072c
Review comments
2015-10-19 13:28:44 +01:00
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
b2aae762fc
Give useful error if z-schema is missing
2015-10-19 12:36:49 +01:00
f51e031066
Fix JSON
2015-10-19 12:36:10 +01:00
ae90d15b3c
Add m.room.avatar
2015-10-19 10:46:07 +01:00
a38e0862cf
Fix required field names
2015-10-16 18:56:07 +01:00
6161a920b6
Update 3pid invite section to reflect signed property
2015-10-16 18:29:20 +01:00
83d21484df
Oopsie
2015-10-16 16:54:40 +01:00
a8d8412068
Add invite_room_state example.
2015-10-16 16:48:18 +01:00
d39a9082a0
Add invite_room_state to spec. Flesh out info.
2015-10-16 16:43:33 +01:00
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
c5dc383668
Merge pull request #85 from matrix-org/module-im
...
Instant messaging module
2015-10-15 10:59:41 +01:00
6a0595bc46
Add in size limits as per SPEC-222
2015-10-14 16:15:55 +01:00
4170dbd5cf
Review comments
2015-10-13 11:29:54 +01:00
dc3c02aff5
Review comments
2015-10-08 10:08:38 -05:00
21a40b317d
Merge branch 'master' into daniel/threepidinvites-2
2015-10-08 09:41:17 -05:00
8e5c832ff9
Flesh out more of the IM module
2015-10-05 13:45:23 +01:00
3b4c3522e6
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/disable_federation
2015-10-05 09:17:28 +01:00
ead79614ff
Merge pull request #78 from matrix-org/module-typing2
...
Typing module
2015-10-02 14:36:30 +01:00
9d8dc7971d
Review comments
2015-10-02 08:33:12 -05:00
9cda004848
Fix ref
2015-10-01 22:27:19 -05:00
fdccf35c47
Banish more tabs
2015-10-01 22:23:24 -05:00
e996933a29
Banish the tabs
2015-10-01 22:21:34 -05:00
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
1520f3647f
Merge branch 'master' into module-typing2
...
Conflicts:
specification/modules/typing_notifications.rst
2015-10-01 15:47:46 +01:00
c972dad8b3
Flesh out receipts module. Add receipts swagger
...
Add templating support for v2 apis.
2015-10-01 15:41:54 +01:00
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
9964dd1401
Make explicit the state event only includes some keys
2015-09-30 16:11:34 +01:00
2b7e02c080
Add sections for typing. Add swagger, JSON schema and example m.typing event
2015-09-30 15:51:04 +01:00
7b4c8a9f68
Indicate default for m.federate key
2015-09-29 16:19:27 +01:00
affc2cfc92
Add 'm.federate' flag to 'm.room.create;
2015-09-28 16:39:54 +01:00
d7d9f406a6
Bundle some state into invites
2015-09-25 14:21:50 +01:00
2efadea583
Merge branch 'master' into markjh/document_v1_rooms_api
2015-09-21 16:35:31 +01:00
8974b2b67b
Skip files that start with ".", e.g. vim swp files.
2015-09-21 15:05:10 +01:00
6ba9b29b3b
Report all the errors in schemas/check_examples, not just the first error.
2015-09-21 15:04:03 +01:00
Travis Ralston