Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[api-docs] 2022-10-29 Daily api_docs build #144203

Merged
merged 1 commit into from
Oct 29, 2022
Merged

[api-docs] 2022-10-29 Daily api_docs build #144203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
160 changes: 137 additions & 23 deletions api_docs/actions.devdocs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,13 @@
"text": "Plugin"
},
" implements ",
"Plugin",
{
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.Plugin",
"text": "Plugin"
},
"<",
{
"pluginId": "actions",
Expand Down Expand Up @@ -55,7 +61,13 @@
"label": "ctx",
"description": [],
"signature": [
"PluginInitializerContext",
{
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<",
"Config",
">"
Expand Down Expand Up @@ -527,7 +539,13 @@
"label": "logger",
"description": [],
"signature": [
"Logger"
{
"pluginId": "@kbn/logging",
"scope": "server",
"docId": "kibKbnLoggingPluginApi",
"section": "def-server.Logger",
"text": "Logger"
}
],
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
"deprecated": false,
Expand Down Expand Up @@ -880,7 +898,13 @@
"description": [],
"signature": [
"(source: ",
"KibanaRequest",
{
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => ",
"HttpRequestExecutionSource"
],
Expand All @@ -896,7 +920,13 @@
"label": "source",
"description": [],
"signature": [
"KibanaRequest",
{
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
Expand All @@ -917,7 +947,13 @@
"description": [],
"signature": [
"(source: Omit<",
"SavedObjectReference",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
", \"name\">) => ",
"SavedObjectExecutionSource"
],
Expand All @@ -934,7 +970,13 @@
"description": [],
"signature": [
"Omit<",
"SavedObjectReference",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
", \"name\">"
],
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
Expand Down Expand Up @@ -1493,7 +1535,13 @@
"label": "logger",
"description": [],
"signature": [
"Logger"
{
"pluginId": "@kbn/logging",
"scope": "server",
"docId": "kibKbnLoggingPluginApi",
"section": "def-server.Logger",
"text": "Logger"
}
],
"path": "x-pack/plugins/actions/server/types.ts",
"deprecated": false,
Expand Down Expand Up @@ -1773,7 +1821,13 @@
"label": "logger",
"description": [],
"signature": [
"Logger"
{
"pluginId": "@kbn/logging",
"scope": "server",
"docId": "kibKbnLoggingPluginApi",
"section": "def-server.Logger",
"text": "Logger"
}
],
"path": "x-pack/plugins/actions/server/sub_action_framework/types.ts",
"deprecated": false,
Expand Down Expand Up @@ -2294,9 +2348,21 @@
"description": [],
"signature": [
"(request: ",
"KibanaRequest",
{
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => Promise<",
"PublicMethodsOf",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.PublicMethodsOf",
"text": "PublicMethodsOf"
},
"<",
{
"pluginId": "actions",
Expand All @@ -2319,7 +2385,13 @@
"label": "request",
"description": [],
"signature": [
"KibanaRequest",
{
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/plugins/actions/server/plugin.ts",
Expand All @@ -2339,9 +2411,21 @@
"description": [],
"signature": [
"(request: ",
"KibanaRequest",
{
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => ",
"PublicMethodsOf",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.PublicMethodsOf",
"text": "PublicMethodsOf"
},
"<",
{
"pluginId": "actions",
Expand All @@ -2364,7 +2448,13 @@
"label": "request",
"description": [],
"signature": [
"KibanaRequest",
{
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/plugins/actions/server/plugin.ts",
Expand Down Expand Up @@ -3644,21 +3734,27 @@
{
"parentPluginId": "actions",
"id": "def-common.AlertingConnectorFeature.name",
"type": "string",
"type": "Any",
"tags": [],
"label": "name",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.AlertingConnectorFeature.compatibility",
"type": "string",
"type": "Any",
"tags": [],
"label": "compatibility",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false,
"trackAdoption": false
Expand Down Expand Up @@ -3691,21 +3787,27 @@
{
"parentPluginId": "actions",
"id": "def-common.CasesConnectorFeature.name",
"type": "string",
"type": "Any",
"tags": [],
"label": "name",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.CasesConnectorFeature.compatibility",
"type": "string",
"type": "Any",
"tags": [],
"label": "compatibility",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false,
"trackAdoption": false
Expand Down Expand Up @@ -3753,21 +3855,27 @@
{
"parentPluginId": "actions",
"id": "def-common.SecuritySolutionFeature.name",
"type": "string",
"type": "Any",
"tags": [],
"label": "name",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.SecuritySolutionFeature.compatibility",
"type": "string",
"type": "Any",
"tags": [],
"label": "compatibility",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false,
"trackAdoption": false
Expand Down Expand Up @@ -3800,21 +3908,27 @@
{
"parentPluginId": "actions",
"id": "def-common.UptimeConnectorFeature.name",
"type": "string",
"type": "Any",
"tags": [],
"label": "name",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.UptimeConnectorFeature.compatibility",
"type": "string",
"type": "Any",
"tags": [],
"label": "compatibility",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false,
"trackAdoption": false
Expand Down
4 changes: 2 additions & 2 deletions api_docs/actions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/actions
title: "actions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the actions plugin
date: 2022-10-28
date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
---
import actionsObj from './actions.devdocs.json';
Expand All @@ -21,7 +21,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 225 | 0 | 220 | 24 |
| 225 | 8 | 220 | 24 |

## Client

Expand Down
Loading