mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-23 01:38:36 +01:00
Document guest_access in /createRoom presets; Make presets a table
Previously the presets ended up being rendered as one long string (the indentation was not respected). This was hard to read and wasn't very clear. Now that there's a larger amount of information, it makes some sense to put it into a table. Tables don't work nicely when nested in another table, so the preset definitions have been moved into the general route description. This commit also updates the documentation to reference `preset`, not `presets` given the param is singular. Fixes https://github.com/matrix-org/matrix-doc/issues/881
This commit is contained in:
parent
442ad99727
commit
9b1f3a1f47
|
|
@ -1,4 +1,5 @@
|
||||||
# Copyright 2016 OpenMarket Ltd
|
# Copyright 2016 OpenMarket Ltd
|
||||||
|
# Copyright 2018 New Vector Ltd
|
||||||
#
|
#
|
||||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
# you may not use this file except in compliance with the License.
|
# you may not use this file except in compliance with the License.
|
||||||
|
|
@ -40,7 +41,7 @@ paths:
|
||||||
0. A default ``m.room.power_levels`` event, giving the room creator
|
0. A default ``m.room.power_levels`` event, giving the room creator
|
||||||
(and not other members) permission to send state events.
|
(and not other members) permission to send state events.
|
||||||
|
|
||||||
1. Events set by ``presets``.
|
1. Events set by the ``preset``.
|
||||||
|
|
||||||
2. Events listed in ``initial_state``, in the order that they are
|
2. Events listed in ``initial_state``, in the order that they are
|
||||||
listed.
|
listed.
|
||||||
|
|
@ -49,6 +50,16 @@ paths:
|
||||||
|
|
||||||
4. Invite events implied by ``invite`` and ``invite_3pid``.
|
4. Invite events implied by ``invite`` and ``invite_3pid``.
|
||||||
|
|
||||||
|
The available presets do the following with respect to room state:
|
||||||
|
|
||||||
|
======================== ============== ====================== ================ =========
|
||||||
|
Preset ``join_rules`` ``history_visibility`` ``guest_access`` Other
|
||||||
|
======================== ============== ====================== ================ =========
|
||||||
|
``private_chat`` ``invite`` ``shared`` ``can_join``
|
||||||
|
``trusted_private_chat`` ``invite`` ``shared`` ``can_join`` All invitees are given the same power level as the room creator.
|
||||||
|
``public_chat`` ``public`` ``shared`` ``forbidden``
|
||||||
|
======================== ============== ====================== ================ =========
|
||||||
|
|
||||||
operationId: createRoom
|
operationId: createRoom
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
|
|
@ -142,7 +153,7 @@ paths:
|
||||||
room. The expected format of the state events are an object
|
room. The expected format of the state events are an object
|
||||||
with type, state_key and content keys set.
|
with type, state_key and content keys set.
|
||||||
|
|
||||||
Takes precedence over events set by ``presets``, but gets
|
Takes precedence over events set by ``preset``, but gets
|
||||||
overriden by ``name`` and ``topic`` keys.
|
overriden by ``name`` and ``topic`` keys.
|
||||||
items:
|
items:
|
||||||
type: object
|
type: object
|
||||||
|
|
@ -163,20 +174,7 @@ paths:
|
||||||
enum: ["private_chat", "public_chat", "trusted_private_chat"]
|
enum: ["private_chat", "public_chat", "trusted_private_chat"]
|
||||||
description: |-
|
description: |-
|
||||||
Convenience parameter for setting various default state events
|
Convenience parameter for setting various default state events
|
||||||
based on a preset. Must be either:
|
based on a preset.
|
||||||
|
|
||||||
``private_chat`` =>
|
|
||||||
``join_rules`` is set to ``invite``.
|
|
||||||
``history_visibility`` is set to ``shared``.
|
|
||||||
|
|
||||||
``trusted_private_chat`` =>
|
|
||||||
``join_rules`` is set to ``invite``.
|
|
||||||
``history_visibility`` is set to ``shared``.
|
|
||||||
All invitees are given the same power level as the room creator.
|
|
||||||
|
|
||||||
``public_chat``: =>
|
|
||||||
``join_rules`` is set to ``public``.
|
|
||||||
``history_visibility`` is set to ``shared``.
|
|
||||||
is_direct:
|
is_direct:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: |-
|
description: |-
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue