aliasesedit

Note

This setting is used only when using the alias filter.

The value of this setting must be a single alias name, or a list of alias names. This can be done in any of the ways YAML allows for lists or arrays. Here are a few examples.

Single

filters:
- filtertype: alias
  aliases: my_alias
  exclude: False

List

  • Flow style:

    filters:
    - filtertype: alias
      aliases: [ my_alias, another_alias ]
      exclude: False
  • Block style:

    filters:
    - filtertype: alias
      aliases:
        - my_alias
        - another_alias
      exclude: False

There is no default value. This setting must be set by the user or an exception will be raised, and execution will halt.