The representation of an RunnerType in the system. An RunnerType has a one-to-one mapping to a particular ActionRunner implementation.
| 54 | |
| 55 | |
| 56 | class RunnerTypeAPI(BaseAPI): |
| 57 | """ |
| 58 | The representation of an RunnerType in the system. An RunnerType |
| 59 | has a one-to-one mapping to a particular ActionRunner implementation. |
| 60 | """ |
| 61 | |
| 62 | model = RunnerTypeDB |
| 63 | schema = { |
| 64 | "title": "Runner", |
| 65 | "description": "A handler for a specific type of actions.", |
| 66 | "type": "object", |
| 67 | "properties": { |
| 68 | "id": { |
| 69 | "description": "The unique identifier for the action runner.", |
| 70 | "type": "string", |
| 71 | "default": None, |
| 72 | }, |
| 73 | "uid": {"type": "string"}, |
| 74 | "name": { |
| 75 | "description": "The name of the action runner.", |
| 76 | "type": "string", |
| 77 | "required": True, |
| 78 | }, |
| 79 | "description": { |
| 80 | "description": "The description of the action runner.", |
| 81 | "type": "string", |
| 82 | }, |
| 83 | "enabled": { |
| 84 | "description": "Enable or disable the action runner.", |
| 85 | "type": "boolean", |
| 86 | "default": True, |
| 87 | }, |
| 88 | "runner_package": { |
| 89 | "description": "The python package that implements the " |
| 90 | "action runner for this type.", |
| 91 | "type": "string", |
| 92 | "required": False, |
| 93 | }, |
| 94 | "runner_module": { |
| 95 | "description": "The python module that implements the " |
| 96 | "action runner for this type.", |
| 97 | "type": "string", |
| 98 | "required": True, |
| 99 | }, |
| 100 | "query_module": { |
| 101 | "description": "The python module that implements the " |
| 102 | "results tracker (querier) for the runner.", |
| 103 | "type": "string", |
| 104 | "required": False, |
| 105 | }, |
| 106 | "runner_parameters": { |
| 107 | "description": "Input parameters for the action runner.", |
| 108 | "type": "object", |
| 109 | "patternProperties": { |
| 110 | r"^\w+$": util_schema.get_action_parameters_schema() |
| 111 | }, |
| 112 | "additionalProperties": False, |
| 113 | }, |
no outgoing calls