library
turbot/detect_correct
OverviewPipelines
0
Triggers
0
Variables
GitHub

Pipeline: Correction Handler

Generic pipeline for handling correction actions for Detect and Correct mods.

Run the pipeline

To run this pipeline from your terminal:

flowpipe pipeline run detect_correct.pipeline.correction_handler

Use this pipeline

To call this pipeline from your pipeline, use a step:

step "pipeline" "step_name" {
pipeline = detect_correct.pipeline.correction_handler
}

Params

NameTypeRequiredDescriptionDefault
notifier
notifier
YesThe notifier to use for sending notification messages. Defaults to the default notifier.notifier.default
notification_level
string
YesThe verbosity level of notification to send, valid values are 'verbose', 'info', 'error'. Defaults to 'info'.info
approvers
list(notifier)
YesA list of notifiers to use for decisions/approvals on actions to undertake, if set to an empty list, the 'default_action' will be used as the outcome. Defaults to an empty list.-
default_action
string
YesThe key of the action to use if no approvers are set. Defaults to 'notify'.notify
enabled_actions
list(string)
YesA list of action keys identifying which actions are available for approvers, this will define the ordering in the UI.
[
"skip"
]
detect_msg
string
YesThe message to display to approvers when asking for a decision or when simply notifying of detections.Detected item requiring action.
actions
map(object({
      label         = string
      value         = string
      style         = string
      pipeline_ref  = any
      pipeline_args = any
      success_msg   = string
      error_msg     = string
    }))
YesA map of actions, if approvers are set these will be offered as options to select, else the one matching the default_action will be used.
{
"skip": {
"error_msg": "",
"label": "Skip",
"pipeline_args": {
"notifier": {
"description": "Default notifier",
"full_name": "default",
"name": "default",
"notifier_name": "default",
"notifies": [
{
"integration": {
"description": "Default http integration",
"full_name": "http.default",
"short_name": "default",
"type": "http",
"unqualified_name": "http.default"
}
}
],
"resource_type": "notifier",
"short_name": "default",
"title": null,
"unqualified_name": "default"
},
"send": false,
"text": "Skipped item."
},
"pipeline_ref": {
"description": "Sends a message using a notifier if the send parameter is true.",
"documentation": null,
"max_concurrency": null,
"mod_full_version": "mod.detect_correct",
"name": "detect_correct.pipeline.optional_message",
"short_name": "optional_message",
"tags": null,
"title": "Optional Message",
"unqualified_name": "pipeline.optional_message"
},
"style": "info",
"success_msg": "",
"value": "skip"
}
}

Outputs

This pipeline has no outputs.