Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-26 10:58:38 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
matrix-spec/event-schemas
History
Travis Ralston 45c68e323a Add general clarity to the /createRoom endpoint 
This commit does a number of things:
* Minor formatting/alignment changes
* Document the room_alias response key. This could be deprecated now, or forfeited, if needed.
* Remove the guest_can_join parameter - it is not actually supported
* Document the previously undocumented power_level_content_override parameter
* Clarify that the room_id is required on the response
* More clearly spell out which events are created as part of the request
* Clarify how the room alias becomes the canonical alias
* Clarify how the `visibility` may be used to determine a default preset to apply
* Document the `m.federate` creation content parameter, adding an option for the homeserver to define a default value

References:
* Preset being inferred by the visibility: cd32c19a60/synapse/handlers/room.py (L172-L177)
* Power level content overrides:
  * https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L198
  * https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L335-L359
* Aliases becoming canonical: https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L366-L370
* `m.federate` landing in the create event: https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L311-L315

Fixes https://github.com/matrix-org/matrix-doc/issues/1243
Fixes https://github.com/matrix-org/matrix-doc/issues/1471
Inspired by https://github.com/matrix-org/matrix-doc/issues/1213
2018-08-15 17:25:30 -06:00
..
examples Document message formats as-is 2018-07-10 12:52:11 -06:00
schema Add general clarity to the /createRoom endpoint 2018-08-15 17:25:30 -06:00
check_examples.py Add a license to the spec 2016-07-12 17:28:30 +01:00
power_level_content_schema.yaml Add general clarity to the /createRoom endpoint 2018-08-15 17:25:30 -06:00
README.md We don't support z-schema or other JSON tools for now 2016-05-05 10:50:03 +01:00

README.md

Checking the event schemas

To validate the event schemas, and check the example events, run

./check-examples.py