Class RuleAPI

st2common/st2common/models/api/rule.py:86–232

Attribute: trigger_type: Trigger that trips this rule. Of the form {'id':'1234', 'name':'trigger-1'}. Only 1 of the id or name is required and if both are specified name is ignored. criteria: Criteria used to further restrict the trigger that applies to this rule.

class RuleAPI(BaseAPI, APIUIDMixin):
    """
    Attribute:
        trigger_type: Trigger that trips this rule. Of the form {'id':'1234', 'name':'trigger-1'}.
        Only 1 of the id or name is required and if both are specified name is ignored.
        criteria: Criteria used to further restrict the trigger that applies to this rule.
        e.g.
        { "trigger.from" :
            { "pattern": "@gmail.com$"
            , "type": "matchregex" }
        , "trigger.subject" :
            { "pattern": "RE:"
            , "operator": "contain" }
        }
        action: Specification of the action to execute and the mappings to apply.
        expected arguments are name, parameters.
        e.g.
        "action":
        { "name": "st2.action.foo"
        , "parameters":
            { "command": "{{ system.foo }}"
            , "args": "--email {{ trigger.from }} --subject \'{{ user[stanley].ALERT_SUBJECT }}\'"}
        }
        status: enabled or disabled. If disabled occurrence of the trigger
        does not lead to execution of a action and vice-versa.
    """

    model = RuleDB
    schema = {
        "type": "object",
        "properties": {
            "id": {"type": "string", "default": None},
            "ref": {
                "description": (
                    "System computed user friendly reference for the rule. "
                    "Provided value will be overridden by computed value."
                ),
                "type": "string",
            },
            "uid": {"type": "string"},
            "name": {"type": "string", "required": True},
            "pack": {"type": "string", "default": DEFAULT_PACK_NAME},
            "description": {"type": "string"},
            "type": RuleTypeSpec.schema,
            "trigger": {
                "type": "object",
                "required": True,
                "properties": {
                    "type": {"type": "string", "required": True},
                    "description": {"type": "string", "require": False},
                    "parameters": {"type": "object", "default": {}},
                    "ref": {"type": "string", "required": False},
                },
                "additionalProperties": True,
            },
            "criteria": {"type": "object", "default": {}},
            "action": {
                "type": "object",