matrix-spec/data/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:
      $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](/appendices#glob-style-matching) to match against.
      Only applicable to `content` rules.
required:
  - actions
  - default
  - enabled
  - rule_id
Add a license to the spec We're licensing hte spec under ASLv2. Add the LICENSE file, and add the short-form to as much of the source as is practical right now (adding it to json source is a massive pita). 8 years ago			`# 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.`
Clean up the pushrules API doc * make it clearer which fields go in which parts of the rule * the example given appeared to be for a content rule, so use a content rule consistently through the examples. 8 years ago
			`title: PushRule`
			`type: object`
Make all the schema files yaml 9 years ago			`properties:`
			`actions:`
			`items:`
			`type:`
			`- object`
			`- string`
			`type: array`
Clean up the pushrules API doc * make it clearer which fields go in which parts of the rule * the example given appeared to be for a content rule, so use a content rule consistently through the examples. 8 years ago			`description: \|-`
			`The actions to perform when this rule is matched.`
Make all the schema files yaml 9 years ago			`default:`
			`type: boolean`
Clean up the pushrules API doc * make it clearer which fields go in which parts of the rule * the example given appeared to be for a content rule, so use a content rule consistently through the examples. 8 years ago			`description: \|-`
			`Whether this is a default rule, or has been set explicitly.`
Make all the schema files yaml 9 years ago			`enabled:`
			`type: boolean`
Clean up the pushrules API doc * make it clearer which fields go in which parts of the rule * the example given appeared to be for a content rule, so use a content rule consistently through the examples. 8 years ago			`description: \|-`
			`Whether the push rule is enabled or not.`
Make all the schema files yaml 9 years ago			`rule_id:`
			`type: string`
Clean up the pushrules API doc * make it clearer which fields go in which parts of the rule * the example given appeared to be for a content rule, so use a content rule consistently through the examples. 8 years ago			`description: \|-`
			`The ID of this rule.`
			`conditions:`
			`type: array`
			`items:`
OpenAPI compliance: avoid $ref siblings (#1457) This strives to fix all remaining cases where additional attributes (most often 'description' but not only) are provided next to $ref by wrapping $ref in allOf; and also drops allOf in a couple of places where $ref is the only element under it. 2 years ago			`$ref: push_condition.yaml`
Clean up the pushrules API doc * make it clearer which fields go in which parts of the rule * the example given appeared to be for a content rule, so use a content rule consistently through the examples. 8 years ago			`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`
Change RST code formatting markup to Markdown 4 years ago			applicable to `underride` and `override` rules.
Clean up the pushrules API doc * make it clearer which fields go in which parts of the rule * the example given appeared to be for a content rule, so use a content rule consistently through the examples. 8 years ago			`pattern:`
			`type: string`
			`description: \|-`
Clarify what key content-specific rules match against. (#1441) 2 years ago			`The [glob-style pattern](/appendices#glob-style-matching) to match against.`
			Only applicable to `content` rules.
Clean up the pushrules API doc * make it clearer which fields go in which parts of the rule * the example given appeared to be for a content rule, so use a content rule consistently through the examples. 8 years ago			`required:`
			`- actions`
			`- default`
			`- enabled`
			`- rule_id`