Skip to content

Commit

Permalink
update api docs (#101528)
Browse files Browse the repository at this point in the history
  • Loading branch information
@stacey-gammon
stacey-gammon authored Jun 7, 2021
1 parent b3ed014 commit c489bca
Show file tree
Hide file tree
Showing 90 changed files with 76,342 additions and 11,825 deletions.
94 changes: 85 additions & 9 deletions api_docs/actions.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,9 @@
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 40
},
"deprecated": false
"deprecated": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "actions",
Expand All @@ -276,7 +278,9 @@
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 41
},
"deprecated": false
"deprecated": false,
"returnComment": [],
"children": []
}
],
"initialIsOpen": false
Expand Down Expand Up @@ -516,14 +520,55 @@
"label": "executor",
"description": [],
"signature": [
"ExecutorType",
"<Config, Secrets, Params, ExecutorResultData>"
"(options: ",
{
"pluginId": "actions",
"scope": "server",
"docId": "kibActionsPluginApi",
"section": "def-server.ActionTypeExecutorOptions",
"text": "ActionTypeExecutorOptions"
},
"<Config, Secrets, Params>) => Promise<",
{
"pluginId": "actions",
"scope": "common",
"docId": "kibActionsPluginApi",
"section": "def-common.ActionTypeExecutorResult",
"text": "ActionTypeExecutorResult"
},
"<ExecutorResultData>>"
],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 116
},
"deprecated": false
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "actions",
"id": "def-server.options",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "actions",
"scope": "server",
"docId": "kibActionsPluginApi",
"section": "def-server.ActionTypeExecutorOptions",
"text": "ActionTypeExecutorOptions"
},
"<Config, Secrets, Params>"
],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 84
},
"deprecated": false
}
]
}
],
"initialIsOpen": false
Expand Down Expand Up @@ -743,7 +788,7 @@
"label": "ActionParamsType",
"description": [],
"signature": [
"{ 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; }"
"{ 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; }"
],
"source": {
"path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts",
Expand All @@ -760,7 +805,7 @@
"label": "ActionParamsType",
"description": [],
"signature": [
"{ readonly message: string; readonly level: \"info\" | \"error\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }"
"{ readonly message: string; readonly level: \"error\" | \"info\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }"
],
"source": {
"path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts",
Expand Down Expand Up @@ -923,7 +968,38 @@
"docId": "kibActionsPluginApi",
"section": "def-server.ActionResult",
"text": "ActionResult"
}
},
"<Record<string, unknown>>>; execute: ({ actionId, params, source, }: Pick<",
"ExecuteOptions",
"<unknown>, \"source\" | \"params\" | \"actionId\">) => Promise<",
{
"pluginId": "actions",
"scope": "common",
"docId": "kibActionsPluginApi",
"section": "def-common.ActionTypeExecutorResult",
"text": "ActionTypeExecutorResult"
},
"<unknown>>; getAll: () => Promise<",
"FindActionResult",
"[]>; getBulk: (ids: string[]) => Promise<",
{
"pluginId": "actions",
"scope": "server",
"docId": "kibActionsPluginApi",
"section": "def-server.ActionResult",
"text": "ActionResult"
},
"<Record<string, unknown>>[]>; enqueueExecution: (options: ",
"ExecuteOptions",
") => Promise<void>; listTypes: () => Promise<",
{
"pluginId": "actions",
"scope": "common",
"docId": "kibActionsPluginApi",
"section": "def-common.ActionType",
"text": "ActionType"
},
"[]>; isActionTypeEnabled: (actionTypeId: string, options?: { notifyUsage: boolean; }) => boolean; }"
],
"source": {
"path": "x-pack/plugins/actions/server/index.ts",
Expand Down Expand Up @@ -1719,7 +1795,7 @@
"label": "config",
"description": [],
"signature": [
"Record<string, any>"
"{ [x: string]: any; }"
],
"source": {
"path": "x-pack/plugins/actions/common/types.ts",
Expand Down
108 changes: 101 additions & 7 deletions api_docs/advanced_settings.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,9 @@
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 30
},
"deprecated": false
"deprecated": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "advancedSettings",
Expand All @@ -74,7 +76,9 @@
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 31
},
"deprecated": false
"deprecated": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "advancedSettings",
Expand All @@ -90,7 +94,9 @@
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 32
},
"deprecated": false
"deprecated": false,
"returnComment": [],
"children": []
}
]
},
Expand Down Expand Up @@ -151,7 +157,55 @@
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 73
},
"deprecated": false
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.id",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"advanced_settings_page_title\" | \"advanced_settings_page_subtitle\" | \"advanced_settings_page_footer\""
],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 47
},
"deprecated": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.component",
"type": "CompoundType",
"tags": [],
"label": "component",
"description": [],
"signature": [
"React.ComponentClass<Record<string, any> | undefined, any> | React.FunctionComponent<Record<string, any> | undefined>"
],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 47
},
"deprecated": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.allowOverride",
"type": "boolean",
"tags": [],
"label": "allowOverride",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 47
},
"deprecated": false
}
]
}
]
},
Expand Down Expand Up @@ -198,7 +252,26 @@
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 78
},
"deprecated": false
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.id",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"advanced_settings_page_title\" | \"advanced_settings_page_subtitle\" | \"advanced_settings_page_footer\""
],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 67
},
"deprecated": false
}
]
}
]
}
Expand All @@ -217,15 +290,36 @@
"\nExports the field component as a React.lazy component. We're explicitly naming it lazy here\nso any plugin that would import that can clearly see it's lazy loaded and can only be used\ninside a suspense context."
],
"signature": [
"React.LazyExoticComponent<typeof ",
"React.ExoticComponent<FieldProps & React.RefAttributes<",
"Field",
">"
">> & { readonly _result: typeof ",
"Field",
"; }"
],
"source": {
"path": "src/plugins/advanced_settings/public/index.ts",
"lineNumber": 20
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"source": {
"path": "node_modules/@types/react/index.d.ts",
"lineNumber": 359
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
Expand Down
Loading

0 comments on commit c489bca

Please sign in to comment.