Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-25 02:18:38 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
matrix-spec/api
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
..
application-service Move TODO. field1, field2... -> fields... 2018-07-30 19:21:54 +01:00
client-server Add general clarity to the /createRoom endpoint 2018-08-15 17:25:30 -06:00
files fix for https://github.com/matrix-org/matrix-doc/issues/270 2016-02-16 11:01:04 +00:00
identity convert IS endpoints to Swagger (#1427) 2018-08-10 16:21:06 -04:00
push-gateway Add operationId to all endpoints of all APIs 2017-10-11 01:58:31 +09:00
server-server Merge pull request #1469 from turt2live/travis/s2s/backfill 2018-08-09 08:00:43 -06:00
check_examples.py Revert giving get() a default 2018-07-29 14:04:07 +09:00
openapi_extensions.md Document OpenAPI extension 2018-08-12 16:52:07 +09:00
package.json Reinstate validator.js 2016-05-04 00:19:46 +01:00
README README.rst: Add notes on how to build the spec 2017-10-25 09:57:02 +01:00
validator.js Provide doc-comments with makeHandler(); cleanup 2017-11-15 07:28:25 +09:00

README 

This directory contains swagger-compatible representations of our APIs. See
the main README.rst for details on how to make use of them.