mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-24 09:58:38 +01:00
00c6a866e2
Historical note: this was originally a series of several commits, spread out over several weeks. They have been squashed together to make `git annotate` work properly. The original commits were: * 91ab3934 <Will> 2021-01-25 21:16:42 -0800 Add raw API end event schemas into /data directory * aae22f47 <Will> 2021-01-25 21:33:06 -0800 Remove non-data files * 1092d4ca <Will> 2021-01-26 20:41:33 -0800 Add data-compatiuble extension (.yaml) to all data files that currently omit one * 21060109 <Will> 2021-01-26 20:57:28 -0800 Remove symlink to event-schemas, and update openAPI schema paths accordingly * 4f633845 <Travis Ralston> 2021-04-12 21:54:54 -0600 Fix event schema examples too * 301c7b2f <Will> 2021-02-05 10:15:42 -0800 Restore docs describing OpenAPI extensions that we use
50 lines
1.8 KiB
YAML
50 lines
1.8 KiB
YAML
# Copyright 2016 OpenMarket Ltd
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
title: PushCondition
|
|
type: object
|
|
properties:
|
|
kind:
|
|
type: string
|
|
description: |-
|
|
The kind of condition to apply. See `conditions <#conditions>`_ for
|
|
more information on the allowed kinds and how they work.
|
|
key:
|
|
type: string
|
|
description: |-
|
|
Required for ``event_match`` conditions. The dot-separated field of the
|
|
event to match.
|
|
|
|
Required for ``sender_notification_permission`` conditions. The field in
|
|
the power level event the user needs a minimum power level for. Fields
|
|
must be specified under the ``notifications`` property in the power level
|
|
event's ``content``.
|
|
x-example: content.body
|
|
pattern:
|
|
type: string
|
|
description: |-
|
|
Required for ``event_match`` conditions. The glob-style pattern to
|
|
match against. Patterns with no special glob characters should be
|
|
treated as having asterisks prepended and appended when testing the
|
|
condition.
|
|
is:
|
|
type: string
|
|
description: |-
|
|
Required for ``room_member_count`` conditions. A decimal integer
|
|
optionally prefixed by one of, ==, <, >, >= or <=. A prefix of < matches
|
|
rooms where the member count is strictly less than the given number and
|
|
so forth. If no prefix is present, this parameter defaults to ==.
|
|
required:
|
|
- kind
|