# Copyright 2020 The Matrix.org Foundation C.I.C.
#
# 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.
properties:
  entity:
    description: |-
      The entity affected by this rule. Glob characters ``*`` and ``?`` can be used
      to match zero or more and one or more characters respectively.
    type: string
  recommendation:
    description: The suggested action to take. Currently only ``m.ban`` is specified.
    type: string
  reason:
    description: The human-readable description for the ``recommendation``.
    type: string
type: object
required:
  - entity
  - recommendation
  - reason