The system entity that represents a Stack Action/Automation in the system.
| 167 | |
| 168 | # NOTE: Update pylint_plugins/fixtures/api_models.py if this changes significantly |
| 169 | class ActionAPI(BaseAPI, APIUIDMixin): |
| 170 | """ |
| 171 | The system entity that represents a Stack Action/Automation in the system. |
| 172 | """ |
| 173 | |
| 174 | model = ActionDB |
| 175 | schema = { |
| 176 | "title": "Action", |
| 177 | "description": "An activity that happens as a response to the external event.", |
| 178 | "type": "object", |
| 179 | "properties": { |
| 180 | "id": { |
| 181 | "description": "The unique identifier for the action.", |
| 182 | "type": "string", |
| 183 | }, |
| 184 | "ref": { |
| 185 | "description": "System computed user friendly reference for the action. \ |
| 186 | Provided value will be overridden by computed value.", |
| 187 | "type": "string", |
| 188 | }, |
| 189 | "uid": {"type": "string"}, |
| 190 | "name": { |
| 191 | "description": "The name of the action.", |
| 192 | "type": "string", |
| 193 | "required": True, |
| 194 | }, |
| 195 | "description": { |
| 196 | "description": "The description of the action.", |
| 197 | "type": "string", |
| 198 | }, |
| 199 | "enabled": { |
| 200 | "description": "Enable or disable the action from invocation.", |
| 201 | "type": "boolean", |
| 202 | "default": True, |
| 203 | }, |
| 204 | "runner_type": { |
| 205 | "description": "The type of runner that executes the action.", |
| 206 | "type": "string", |
| 207 | "required": True, |
| 208 | }, |
| 209 | "entry_point": { |
| 210 | "description": "The entry point for the action.", |
| 211 | "type": "string", |
| 212 | "default": "", |
| 213 | }, |
| 214 | "pack": { |
| 215 | "description": "The content pack this action belongs to.", |
| 216 | "type": "string", |
| 217 | "default": DEFAULT_PACK_NAME, |
| 218 | }, |
| 219 | "parameters": { |
| 220 | "description": "Input parameters for the action.", |
| 221 | "type": "object", |
| 222 | "patternProperties": { |
| 223 | r"^\w+$": util_schema.get_action_parameters_schema() |
| 224 | }, |
| 225 | "additionalProperties": False, |
| 226 | "default": {}, |
no outgoing calls