|
252 | 252 | "path": "x-pack/plugins/actions/server/types.ts", |
253 | 253 | "lineNumber": 40 |
254 | 254 | }, |
255 | | - "deprecated": false |
| 255 | + "deprecated": false, |
| 256 | + "returnComment": [], |
| 257 | + "children": [] |
256 | 258 | }, |
257 | 259 | { |
258 | 260 | "parentPluginId": "actions", |
|
276 | 278 | "path": "x-pack/plugins/actions/server/types.ts", |
277 | 279 | "lineNumber": 41 |
278 | 280 | }, |
279 | | - "deprecated": false |
| 281 | + "deprecated": false, |
| 282 | + "returnComment": [], |
| 283 | + "children": [] |
280 | 284 | } |
281 | 285 | ], |
282 | 286 | "initialIsOpen": false |
|
516 | 520 | "label": "executor", |
517 | 521 | "description": [], |
518 | 522 | "signature": [ |
519 | | - "ExecutorType", |
520 | | - "<Config, Secrets, Params, ExecutorResultData>" |
| 523 | + "(options: ", |
| 524 | + { |
| 525 | + "pluginId": "actions", |
| 526 | + "scope": "server", |
| 527 | + "docId": "kibActionsPluginApi", |
| 528 | + "section": "def-server.ActionTypeExecutorOptions", |
| 529 | + "text": "ActionTypeExecutorOptions" |
| 530 | + }, |
| 531 | + "<Config, Secrets, Params>) => Promise<", |
| 532 | + { |
| 533 | + "pluginId": "actions", |
| 534 | + "scope": "common", |
| 535 | + "docId": "kibActionsPluginApi", |
| 536 | + "section": "def-common.ActionTypeExecutorResult", |
| 537 | + "text": "ActionTypeExecutorResult" |
| 538 | + }, |
| 539 | + "<ExecutorResultData>>" |
521 | 540 | ], |
522 | 541 | "source": { |
523 | 542 | "path": "x-pack/plugins/actions/server/types.ts", |
524 | 543 | "lineNumber": 116 |
525 | 544 | }, |
526 | | - "deprecated": false |
| 545 | + "deprecated": false, |
| 546 | + "returnComment": [], |
| 547 | + "children": [ |
| 548 | + { |
| 549 | + "parentPluginId": "actions", |
| 550 | + "id": "def-server.options", |
| 551 | + "type": "Object", |
| 552 | + "tags": [], |
| 553 | + "label": "options", |
| 554 | + "description": [], |
| 555 | + "signature": [ |
| 556 | + { |
| 557 | + "pluginId": "actions", |
| 558 | + "scope": "server", |
| 559 | + "docId": "kibActionsPluginApi", |
| 560 | + "section": "def-server.ActionTypeExecutorOptions", |
| 561 | + "text": "ActionTypeExecutorOptions" |
| 562 | + }, |
| 563 | + "<Config, Secrets, Params>" |
| 564 | + ], |
| 565 | + "source": { |
| 566 | + "path": "x-pack/plugins/actions/server/types.ts", |
| 567 | + "lineNumber": 84 |
| 568 | + }, |
| 569 | + "deprecated": false |
| 570 | + } |
| 571 | + ] |
527 | 572 | } |
528 | 573 | ], |
529 | 574 | "initialIsOpen": false |
|
743 | 788 | "label": "ActionParamsType", |
744 | 789 | "description": [], |
745 | 790 | "signature": [ |
746 | | - "{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"warning\" | \"info\" | \"error\" | \"critical\" | undefined; readonly component?: string | undefined; readonly group?: string | undefined; readonly class?: string | undefined; }" |
| 791 | + "{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"warning\" | \"error\" | \"info\" | \"critical\" | undefined; readonly component?: string | undefined; readonly group?: string | undefined; readonly class?: string | undefined; }" |
747 | 792 | ], |
748 | 793 | "source": { |
749 | 794 | "path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts", |
|
760 | 805 | "label": "ActionParamsType", |
761 | 806 | "description": [], |
762 | 807 | "signature": [ |
763 | | - "{ readonly message: string; readonly level: \"info\" | \"error\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }" |
| 808 | + "{ readonly message: string; readonly level: \"error\" | \"info\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }" |
764 | 809 | ], |
765 | 810 | "source": { |
766 | 811 | "path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts", |
|
923 | 968 | "docId": "kibActionsPluginApi", |
924 | 969 | "section": "def-server.ActionResult", |
925 | 970 | "text": "ActionResult" |
926 | | - } |
| 971 | + }, |
| 972 | + "<Record<string, unknown>>>; execute: ({ actionId, params, source, }: Pick<", |
| 973 | + "ExecuteOptions", |
| 974 | + "<unknown>, \"source\" | \"params\" | \"actionId\">) => Promise<", |
| 975 | + { |
| 976 | + "pluginId": "actions", |
| 977 | + "scope": "common", |
| 978 | + "docId": "kibActionsPluginApi", |
| 979 | + "section": "def-common.ActionTypeExecutorResult", |
| 980 | + "text": "ActionTypeExecutorResult" |
| 981 | + }, |
| 982 | + "<unknown>>; getAll: () => Promise<", |
| 983 | + "FindActionResult", |
| 984 | + "[]>; getBulk: (ids: string[]) => Promise<", |
| 985 | + { |
| 986 | + "pluginId": "actions", |
| 987 | + "scope": "server", |
| 988 | + "docId": "kibActionsPluginApi", |
| 989 | + "section": "def-server.ActionResult", |
| 990 | + "text": "ActionResult" |
| 991 | + }, |
| 992 | + "<Record<string, unknown>>[]>; enqueueExecution: (options: ", |
| 993 | + "ExecuteOptions", |
| 994 | + ") => Promise<void>; listTypes: () => Promise<", |
| 995 | + { |
| 996 | + "pluginId": "actions", |
| 997 | + "scope": "common", |
| 998 | + "docId": "kibActionsPluginApi", |
| 999 | + "section": "def-common.ActionType", |
| 1000 | + "text": "ActionType" |
| 1001 | + }, |
| 1002 | + "[]>; isActionTypeEnabled: (actionTypeId: string, options?: { notifyUsage: boolean; }) => boolean; }" |
927 | 1003 | ], |
928 | 1004 | "source": { |
929 | 1005 | "path": "x-pack/plugins/actions/server/index.ts", |
|
1719 | 1795 | "label": "config", |
1720 | 1796 | "description": [], |
1721 | 1797 | "signature": [ |
1722 | | - "Record<string, any>" |
| 1798 | + "{ [x: string]: any; }" |
1723 | 1799 | ], |
1724 | 1800 | "source": { |
1725 | 1801 | "path": "x-pack/plugins/actions/common/types.ts", |
|
0 commit comments