matrix-spec-proposals/api/client-server/definitions/push_rule.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: PushRule
type: object
properties:
  actions:
    items:
      type:
      - object
      - string
    type: array
    description: |-
            The actions to perform when this rule is matched.
  default:
    type: boolean
    description: |-
            Whether this is a default rule, or has been set explicitly.
  enabled:
    type: boolean
    description: |-
            Whether the push rule is enabled or not.
  rule_id:
    type: string
    description: |-
            The ID of this rule.
  conditions:
    type: array
    items:
      allOf:
      - $ref: push_condition.yaml
    description: |-
      The conditions that must hold true for an event in order for a rule to be
      applied to an event. A rule with no conditions always matches. Only
      applicable to ``underride`` and ``override`` rules.      
  pattern:
    type: string
    description: |-
      The glob-style pattern to match against.  Only applicable to ``content``
      rules.      
required:
  - actions
  - default
  - enabled
  - rule_id