docs-matrix-spec/event-schemas/schema/m.room.join_rules
Richard van der Hoff 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

28 lines
922 B
Text

---
allOf:
- $ref: core-event-schema/state_event.yaml
description: 'A room may be ``public`` meaning anyone can join the room without any prior action. Alternatively, it can be ``invite`` meaning that a user who wishes to join the room must first receive an invite to the room from someone already inside of the room. Currently, ``knock`` and ``private`` are reserved keywords which are not implemented.'
properties:
content:
properties:
join_rule:
description: The type of rules used for users wishing to join this room.
enum:
- public
- knock
- invite
- private
type: string
required:
- join_rule
type: object
state_key:
description: A zero-length string.
pattern: '^$'
type: string
type:
enum:
- m.room.join_rules
type: string
title: Describes how users are allowed to join the room.
type: object