[api-docs] Daily api_docs build (#138866)

elastic · Aug 16, 2022 · 416123a · 416123a
1 parent f77afae
commit 416123a
Show file tree

Hide file tree

Showing 400 changed files with 2,190 additions and 1,931 deletions.
diff --git a/api_docs/actions.devdocs.json b/api_docs/actions.devdocs.json
@@ -1580,7 +1580,7 @@
         "label": "ActionParamsType",
         "description": [],
         "signature": [
-          "{ readonly subAction: \"pushToService\"; readonly subActionParams: Readonly<{} & { incident: Readonly<{} & { title: string; description: string | null; tags: string[] | null; externalId: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }"
+          "{ readonly subAction: \"pushToService\"; readonly subActionParams: Readonly<{} & { incident: Readonly<{} & { tags: string[] | null; title: string; description: string | null; externalId: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }"
         ],
         "path": "x-pack/plugins/actions/server/builtin_action_types/cases_webhook/index.ts",
         "deprecated": false,
@@ -1748,7 +1748,17 @@
         "label": "ActionsClient",
         "description": [],
         "signature": [
-          "{ execute: ({ actionId, params, source, relatedSavedObjects, }: Omit<",
+          "{ get: ({ id }: { id: string; }) => Promise<",
+          {
+            "pluginId": "actions",
+            "scope": "server",
+            "docId": "kibActionsPluginApi",
+            "section": "def-server.ActionResult",
+            "text": "ActionResult"
+          },
+          "<",
+          "ActionTypeConfig",
+          ">>; delete: ({ id }: { id: string; }) => Promise<{}>; execute: ({ actionId, params, source, relatedSavedObjects, }: Omit<",
           "ExecuteOptions",
           "<unknown>, \"request\">) => Promise<",
           {
@@ -1770,16 +1780,6 @@
           },
           "<",
           "ActionTypeConfig",
-          ">>; get: ({ id }: { id: string; }) => Promise<",
-          {
-            "pluginId": "actions",
-            "scope": "server",
-            "docId": "kibActionsPluginApi",
-            "section": "def-server.ActionResult",
-            "text": "ActionResult"
-          },
-          "<",
-          "ActionTypeConfig",
           ">>; update: ({ id, action }: ",
           "UpdateOptions",
           ") => Promise<",
@@ -1792,7 +1792,7 @@
           },
           "<",
           "ActionTypeConfig",
-          ">>; delete: ({ id }: { id: string; }) => Promise<{}>; getAll: () => Promise<",
+          ">>; getAll: () => Promise<",
           {
             "pluginId": "actions",
             "scope": "server",
@@ -1810,7 +1810,7 @@
           },
           "<",
           "ActionTypeConfig",
-          ">[]>; getOAuthAccessToken: ({ type, options }: Readonly<{} & { type: \"client\" | \"jwt\"; options: Readonly<{} & { config: Readonly<{} & { clientId: string; jwtKeyId: string; userIdentifierValue: string; }>; tokenUrl: string; secrets: Readonly<{ privateKeyPassword?: string | undefined; } & { clientSecret: string; privateKey: string; }>; }> | Readonly<{} & { scope: string; config: Readonly<{} & { clientId: string; tenantId: string; }>; tokenUrl: string; secrets: Readonly<{} & { clientSecret: string; }>; }>; }>, configurationUtilities: ",
+          ">[]>; getOAuthAccessToken: ({ type, options }: Readonly<{} & { options: Readonly<{} & { config: Readonly<{} & { clientId: string; jwtKeyId: string; userIdentifierValue: string; }>; tokenUrl: string; secrets: Readonly<{ privateKeyPassword?: string | undefined; } & { clientSecret: string; privateKey: string; }>; }> | Readonly<{} & { scope: string; config: Readonly<{} & { clientId: string; tenantId: string; }>; tokenUrl: string; secrets: Readonly<{} & { clientSecret: string; }>; }>; type: \"client\" | \"jwt\"; }>, configurationUtilities: ",
           "ActionsConfigurationUtilities",
           ") => Promise<{ accessToken: string | null; }>; enqueueExecution: (options: ",
           "ExecuteOptions",

diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx
@@ -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-08-15
+date: 2022-08-16
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
 ---
 import actionsObj from './actions.devdocs.json';

diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/advancedSettings
 title: "advancedSettings"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the advancedSettings plugin
-date: 2022-08-15
+date: 2022-08-16
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
 ---
 import advancedSettingsObj from './advanced_settings.devdocs.json';

diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiops
 title: "aiops"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the aiops plugin
-date: 2022-08-15
+date: 2022-08-16
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
 ---
 import aiopsObj from './aiops.devdocs.json';

diff --git a/api_docs/alerting.devdocs.json b/api_docs/alerting.devdocs.json
@@ -43,15 +43,15 @@
               "The rule to view"
             ],
             "signature": [
-              "{ id: string; name: string; monitoring?: ",
+              "{ params: never; tags: string[]; id: string; name: string; monitoring?: ",
               {
                 "pluginId": "alerting",
                 "scope": "common",
                 "docId": "kibAlertingPluginApi",
                 "section": "def-common.RuleMonitoring",
                 "text": "RuleMonitoring"
               },
-              " | undefined; tags: string[]; enabled: boolean; params: never; actions: ",
+              " | undefined; enabled: boolean; actions: ",
               {
                 "pluginId": "alerting",
                 "scope": "common",
@@ -1732,7 +1732,7 @@
                 "section": "def-common.SanitizedRule",
                 "text": "SanitizedRule"
               },
-              "<never>, \"name\" | \"tags\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
+              "<never>, \"tags\" | \"name\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
             ],
             "path": "x-pack/plugins/alerting/server/types.ts",
             "deprecated": false
@@ -2569,7 +2569,25 @@
         "label": "RulesClient",
         "description": [],
         "signature": [
-          "{ aggregate: ({ options: { fields, filter, ...options }, }?: { options?: ",
+          "{ get: <Params extends ",
+          {
+            "pluginId": "alerting",
+            "scope": "common",
+            "docId": "kibAlertingPluginApi",
+            "section": "def-common.RuleTypeParams",
+            "text": "RuleTypeParams"
+          },
+          " = never>({ id, includeLegacyId, includeSnoozeData, excludeFromPublicApi, }: { id: string; includeLegacyId?: boolean | undefined; includeSnoozeData?: boolean | undefined; excludeFromPublicApi?: boolean | undefined; }) => Promise<",
+          {
+            "pluginId": "alerting",
+            "scope": "common",
+            "docId": "kibAlertingPluginApi",
+            "section": "def-common.SanitizedRule",
+            "text": "SanitizedRule"
+          },
+          "<Params> | ",
+          "SanitizedRuleWithLegacyId",
+          "<Params>>; delete: ({ id }: { id: string; }) => Promise<{}>; aggregate: ({ options: { fields, filter, ...options }, }?: { options?: ",
           "AggregateOptions",
           " | undefined; }) => Promise<",
           "AggregateResult",
@@ -2609,24 +2627,6 @@
             "section": "def-server.FindResult",
             "text": "FindResult"
           },
-          "<Params>>; get: <Params extends ",
-          {
-            "pluginId": "alerting",
-            "scope": "common",
-            "docId": "kibAlertingPluginApi",
-            "section": "def-common.RuleTypeParams",
-            "text": "RuleTypeParams"
-          },
-          " = never>({ id, includeLegacyId, includeSnoozeData, excludeFromPublicApi, }: { id: string; includeLegacyId?: boolean | undefined; includeSnoozeData?: boolean | undefined; excludeFromPublicApi?: boolean | undefined; }) => Promise<",
-          {
-            "pluginId": "alerting",
-            "scope": "common",
-            "docId": "kibAlertingPluginApi",
-            "section": "def-common.SanitizedRule",
-            "text": "SanitizedRule"
-          },
-          "<Params> | ",
-          "SanitizedRuleWithLegacyId",
           "<Params>>; update: <Params extends ",
           {
             "pluginId": "alerting",
@@ -2645,7 +2645,7 @@
             "section": "def-server.PartialRule",
             "text": "PartialRule"
           },
-          "<Params>>; delete: ({ id }: { id: string; }) => Promise<{}>; resolve: <Params extends ",
+          "<Params>>; resolve: <Params extends ",
           {
             "pluginId": "alerting",
             "scope": "common",
@@ -4069,7 +4069,7 @@
             "label": "freq",
             "description": [],
             "signature": [
-              "0 | 2 | 1 | 6 | 4 | 3 | 5 | undefined"
+              "0 | 2 | 1 | 3 | 4 | 5 | 6 | undefined"
             ],
             "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
             "deprecated": false
@@ -5817,15 +5817,15 @@
         "label": "SanitizedRule",
         "description": [],
         "signature": [
-          "{ id: string; name: string; monitoring?: ",
+          "{ params: Params; tags: string[]; id: string; name: string; monitoring?: ",
           {
             "pluginId": "alerting",
             "scope": "common",
             "docId": "kibAlertingPluginApi",
             "section": "def-common.RuleMonitoring",
             "text": "RuleMonitoring"
           },
-          " | undefined; tags: string[]; enabled: boolean; params: Params; actions: ",
+          " | undefined; enabled: boolean; actions: ",
           {
             "pluginId": "alerting",
             "scope": "common",
@@ -5887,7 +5887,7 @@
             "section": "def-common.SanitizedRule",
             "text": "SanitizedRule"
           },
-          "<never>, \"name\" | \"tags\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
+          "<never>, \"tags\" | \"name\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
         ],
         "path": "x-pack/plugins/alerting/common/rule.ts",
         "deprecated": false,

diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/alerting
 title: "alerting"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the alerting plugin
-date: 2022-08-15
+date: 2022-08-16
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
 ---
 import alertingObj from './alerting.devdocs.json';

diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apm
 title: "apm"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the apm plugin
-date: 2022-08-15
+date: 2022-08-16
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
 ---
 import apmObj from './apm.devdocs.json';

diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/banners
 title: "banners"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the banners plugin
-date: 2022-08-15
+date: 2022-08-16
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
 ---
 import bannersObj from './banners.devdocs.json';

diff --git a/api_docs/bfetch.devdocs.json b/api_docs/bfetch.devdocs.json
@@ -338,15 +338,33 @@
           "signature": [
             "<Payload, Response>(path: string, params: (request: ",
             "KibanaRequest",
-            "<unknown, unknown, unknown, any>) => ",
+            "<unknown, unknown, unknown, any>, context: ",
+            {
+              "pluginId": "core",
+              "scope": "server",
+              "docId": "kibCorePluginApi",
+              "section": "def-server.RequestHandlerContext",
+              "text": "RequestHandlerContext"
+            },
+            ") => ",
             {
               "pluginId": "bfetch",
               "scope": "common",
               "docId": "kibBfetchPluginApi",
               "section": "def-common.StreamingResponseHandler",
               "text": "StreamingResponseHandler"
             },
-            "<Payload, Response>) => void"
+            "<Payload, Response>, method?: \"GET\" | \"POST\" | \"PUT\" | \"DELETE\" | undefined, pluginRouter?: ",
+            "IRouter",
+            "<",
+            {
+              "pluginId": "core",
+              "scope": "server",
+              "docId": "kibCorePluginApi",
+              "section": "def-server.RequestHandlerContext",
+              "text": "RequestHandlerContext"
+            },
+            "> | undefined) => void"
           ],
           "path": "src/plugins/bfetch/server/plugin.ts",
           "deprecated": false,
@@ -375,7 +393,15 @@
               "signature": [
                 "(request: ",
                 "KibanaRequest",
-                "<unknown, unknown, unknown, any>) => ",
+                "<unknown, unknown, unknown, any>, context: ",
+                {
+                  "pluginId": "core",
+                  "scope": "server",
+                  "docId": "kibCorePluginApi",
+                  "section": "def-server.RequestHandlerContext",
+                  "text": "RequestHandlerContext"
+                },
+                ") => ",
                 {
                   "pluginId": "bfetch",
                   "scope": "common",
@@ -388,6 +414,43 @@
               "path": "src/plugins/bfetch/server/plugin.ts",
               "deprecated": false,
               "isRequired": true
+            },
+            {
+              "parentPluginId": "bfetch",
+              "id": "def-server.BfetchServerSetup.addStreamingResponseRoute.$3",
+              "type": "CompoundType",
+              "tags": [],
+              "label": "method",
+              "description": [],
+              "signature": [
+                "\"GET\" | \"POST\" | \"PUT\" | \"DELETE\" | undefined"
+              ],
+              "path": "src/plugins/bfetch/server/plugin.ts",
+              "deprecated": false,
+              "isRequired": false
+            },
+            {
+              "parentPluginId": "bfetch",
+              "id": "def-server.BfetchServerSetup.addStreamingResponseRoute.$4",
+              "type": "Object",
+              "tags": [],
+              "label": "pluginRouter",
+              "description": [],
+              "signature": [
+                "IRouter",
+                "<",
+                {
+                  "pluginId": "core",
+                  "scope": "server",
+                  "docId": "kibCorePluginApi",
+                  "section": "def-server.RequestHandlerContext",
+                  "text": "RequestHandlerContext"
+                },
+                "> | undefined"
+              ],
+              "path": "src/plugins/bfetch/server/plugin.ts",
+              "deprecated": false,
+              "isRequired": false
             }
           ],
           "returnComment": []

diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/bfetch
 title: "bfetch"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the bfetch plugin
-date: 2022-08-15
+date: 2022-08-16
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
 ---
 import bfetchObj from './bfetch.devdocs.json';
@@ -21,7 +21,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
 
 | Public API count  | Any count | Items lacking comments | Missing exports |
 |-------------------|-----------|------------------------|-----------------|
-| 78 | 1 | 69 | 2 |
+| 80 | 1 | 71 | 2 |
 
 ## Client
 

diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/canvas
 title: "canvas"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the canvas plugin
-date: 2022-08-15
+date: 2022-08-16
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
 ---
 import canvasObj from './canvas.devdocs.json';

diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cases
 title: "cases"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the cases plugin
-date: 2022-08-15
+date: 2022-08-16
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
 ---
 import casesObj from './cases.devdocs.json';

diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/charts
 title: "charts"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the charts plugin
-date: 2022-08-15
+date: 2022-08-16
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
 ---
 import chartsObj from './charts.devdocs.json';

diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloud
 title: "cloud"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the cloud plugin
-date: 2022-08-15
+date: 2022-08-16
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
 ---
 import cloudObj from './cloud.devdocs.json';