mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-01-02 05:58:37 +01:00
d6d74c4cbe
# is reserved by the swagger validator as a way to include partial content from a JSON object (eg: "#/path" would include {"test": true} from the object {"path":{"test":true}}). Instead of trying to convince the validator that it is wrong, we'll just use a different character.
Note that our rendering tools do not care about #-style references to objects. It's still somewhat worth changing the character though.
40 lines
1 KiB
Plaintext
40 lines
1 KiB
Plaintext
---
|
|
allOf:
|
|
- $ref: core-event-schema/room_event.yaml
|
|
description: Represents a server notice for a user.
|
|
properties:
|
|
content:
|
|
properties:
|
|
body:
|
|
description: A human-readable description of the notice.
|
|
type: string
|
|
msgtype:
|
|
enum:
|
|
- m.server_notice
|
|
type: string
|
|
server_notice_type:
|
|
description: |-
|
|
The type of notice being represented.
|
|
type: string
|
|
admin_contact:
|
|
description: |-
|
|
A URI giving a contact method for the server administrator. Required if the
|
|
notice type is ``m.server_notice.usage_limit_reached``.
|
|
type: string
|
|
limit_type:
|
|
description: |-
|
|
The kind of usage limit the server has exceeded. Required if the notice type is
|
|
``m.server_notice.usage_limit_reached``.
|
|
type: string
|
|
required:
|
|
- msgtype
|
|
- body
|
|
- server_notice_type
|
|
type: object
|
|
type:
|
|
enum:
|
|
- m.room.message
|
|
type: string
|
|
title: ServerNoticeMessage
|
|
type: object
|