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

elastic · Aug 4, 2022 · 0fdf99b · 0fdf99b
1 parent eb72cdd
commit 0fdf99b
Show file tree

Hide file tree

Showing 371 changed files with 1,781 additions and 828 deletions.
diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/actions
 title: "actions"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the actions plugin
-date: 2022-08-03
+date: 2022-08-04
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
 warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
 ---

diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/advancedSettings
 title: "advancedSettings"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the advancedSettings plugin
-date: 2022-08-03
+date: 2022-08-04
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
 warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
 ---

diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/aiops
 title: "aiops"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the aiops plugin
-date: 2022-08-03
+date: 2022-08-04
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
 warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
 ---

diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/alerting
 title: "alerting"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the alerting plugin
-date: 2022-08-03
+date: 2022-08-04
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
 warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
 ---

diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/apm
 title: "apm"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the apm plugin
-date: 2022-08-03
+date: 2022-08-04
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
 warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
 ---

diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/banners
 title: "banners"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the banners plugin
-date: 2022-08-03
+date: 2022-08-04
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
 warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
 ---

diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/bfetch
 title: "bfetch"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the bfetch plugin
-date: 2022-08-03
+date: 2022-08-04
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
 warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
 ---

diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/canvas
 title: "canvas"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the canvas plugin
-date: 2022-08-03
+date: 2022-08-04
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
 warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
 ---

diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cases
 title: "cases"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the cases plugin
-date: 2022-08-03
+date: 2022-08-04
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
 warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
 ---

diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/charts
 title: "charts"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the charts plugin
-date: 2022-08-03
+date: 2022-08-04
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
 warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
 ---

diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloud
 title: "cloud"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the cloud plugin
-date: 2022-08-03
+date: 2022-08-04
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
 warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
 ---

diff --git a/api_docs/cloud_security_posture.mdx b/api_docs/cloud_security_posture.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture
 title: "cloudSecurityPosture"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the cloudSecurityPosture plugin
-date: 2022-08-03
+date: 2022-08-04
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
 warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
 ---

diff --git a/api_docs/console.mdx b/api_docs/console.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/console
 title: "console"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the console plugin
-date: 2022-08-03
+date: 2022-08-04
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
 warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
 ---

diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/controls
 title: "controls"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the controls plugin
-date: 2022-08-03
+date: 2022-08-04
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
 warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
 ---

diff --git a/api_docs/core.devdocs.json b/api_docs/core.devdocs.json
@@ -475,7 +475,7 @@
               "\nReports a telemetry event."
             ],
             "signature": [
-              "<EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void"
+              "<EventTypeData extends object>(eventType: string, eventData: EventTypeData) => void"
             ],
             "path": "node_modules/@types/kbn__analytics-client/index.d.ts",
             "deprecated": false,
@@ -1031,7 +1031,7 @@
             "signature": [
               "{ optIn: (optInConfig: ",
               "OptInConfig",
-              ") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
+              ") => void; reportEvent: <EventTypeData extends object>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
               "Observable",
               "<",
               "TelemetryCounter",
@@ -1228,7 +1228,7 @@
             "signature": [
               "{ optIn: (optInConfig: ",
               "OptInConfig",
-              ") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
+              ") => void; reportEvent: <EventTypeData extends object>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
               "Observable",
               "<",
               "TelemetryCounter",
@@ -1334,13 +1334,7 @@
               "{@link SavedObjectsStart}"
             ],
             "signature": [
-              {
-                "pluginId": "core",
-                "scope": "public",
-                "docId": "kibCoreSavedObjectsPluginApi",
-                "section": "def-public.SavedObjectsStart",
-                "text": "SavedObjectsStart"
-              }
+              "SavedObjectsStart"
             ],
             "path": "src/core/public/index.ts",
             "deprecated": false
@@ -1794,7 +1788,8 @@
           "\nDefinition of the full event structure"
         ],
         "signature": [
-          "Event"
+          "Event",
+          "<Properties>"
         ],
         "path": "node_modules/@types/kbn__analytics-client/index.d.ts",
         "deprecated": false,
@@ -1826,14 +1821,14 @@
           {
             "parentPluginId": "core",
             "id": "def-public.Event.properties",
-            "type": "Object",
+            "type": "Uncategorized",
             "tags": [],
             "label": "properties",
             "description": [
               "\nThe specific properties of the event type."
             ],
             "signature": [
-              "{ [x: string]: unknown; }"
+              "Properties"
             ],
             "path": "node_modules/@types/kbn__analytics-client/index.d.ts",
             "deprecated": false
@@ -4165,7 +4160,7 @@
             "signature": [
               "(events: ",
               "Event",
-              "[]) => void"
+              "<Record<string, unknown>>[]) => void"
             ],
             "path": "node_modules/@types/kbn__analytics-client/index.d.ts",
             "deprecated": false,
@@ -4181,7 +4176,7 @@
                 ],
                 "signature": [
                   "Event",
-                  "[]"
+                  "<Record<string, unknown>>[]"
                 ],
                 "path": "node_modules/@types/kbn__analytics-client/index.d.ts",
                 "deprecated": false,
@@ -8674,6 +8669,37 @@
         ],
         "initialIsOpen": false
       },
+      {
+        "parentPluginId": "core",
+        "id": "def-public.SavedObjectsStart",
+        "type": "Interface",
+        "tags": [],
+        "label": "SavedObjectsStart",
+        "description": [],
+        "signature": [
+          "SavedObjectsStart"
+        ],
+        "path": "node_modules/@types/kbn__core-saved-objects-browser/index.d.ts",
+        "deprecated": false,
+        "children": [
+          {
+            "parentPluginId": "core",
+            "id": "def-public.SavedObjectsStart.client",
+            "type": "Object",
+            "tags": [],
+            "label": "client",
+            "description": [
+              "{@link SavedObjectsClientContract}"
+            ],
+            "signature": [
+              "SavedObjectsClientContract"
+            ],
+            "path": "node_modules/@types/kbn__core-saved-objects-browser/index.d.ts",
+            "deprecated": false
+          }
+        ],
+        "initialIsOpen": false
+      },
       {
         "parentPluginId": "core",
         "id": "def-public.SavedObjectsUpdateOptions",
@@ -9659,7 +9685,7 @@
         "signature": [
           "{ optIn: (optInConfig: ",
           "OptInConfig",
-          ") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
+          ") => void; reportEvent: <EventTypeData extends object>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
           "Observable",
           "<",
           "TelemetryCounter",
@@ -9691,7 +9717,7 @@
         "signature": [
           "{ optIn: (optInConfig: ",
           "OptInConfig",
-          ") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
+          ") => void; reportEvent: <EventTypeData extends object>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
           "Observable",
           "<",
           "TelemetryCounter",
@@ -10538,7 +10564,7 @@
               "\nReports a telemetry event."
             ],
             "signature": [
-              "<EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void"
+              "<EventTypeData extends object>(eventType: string, eventData: EventTypeData) => void"
             ],
             "path": "node_modules/@types/kbn__analytics-client/index.d.ts",
             "deprecated": false,
@@ -12127,7 +12153,7 @@
             "signature": [
               "{ optIn: (optInConfig: ",
               "OptInConfig",
-              ") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
+              ") => void; reportEvent: <EventTypeData extends object>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
               "Observable",
               "<",
               "TelemetryCounter",
@@ -12316,7 +12342,7 @@
             "signature": [
               "{ optIn: (optInConfig: ",
               "OptInConfig",
-              ") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
+              ") => void; reportEvent: <EventTypeData extends object>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
               "Observable",
               "<",
               "TelemetryCounter",
@@ -12608,7 +12634,7 @@
             "signature": [
               "{ optIn: (optInConfig: ",
               "OptInConfig",
-              ") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
+              ") => void; reportEvent: <EventTypeData extends object>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
               "Observable",
               "<",
               "TelemetryCounter",
@@ -13955,7 +13981,8 @@
           "\nDefinition of the full event structure"
         ],
         "signature": [
-          "Event"
+          "Event",
+          "<Properties>"
         ],
         "path": "node_modules/@types/kbn__analytics-client/index.d.ts",
         "deprecated": false,
@@ -13987,14 +14014,14 @@
           {
             "parentPluginId": "core",
             "id": "def-server.Event.properties",
-            "type": "Object",
+            "type": "Uncategorized",
             "tags": [],
             "label": "properties",
             "description": [
               "\nThe specific properties of the event type."
             ],
             "signature": [
-              "{ [x: string]: unknown; }"
+              "Properties"
             ],
             "path": "node_modules/@types/kbn__analytics-client/index.d.ts",
             "deprecated": false
@@ -23071,7 +23098,7 @@
             "signature": [
               "(events: ",
               "Event",
-              "[]) => void"
+              "<Record<string, unknown>>[]) => void"
             ],
             "path": "node_modules/@types/kbn__analytics-client/index.d.ts",
             "deprecated": false,
@@ -23087,7 +23114,7 @@
                 ],
                 "signature": [
                   "Event",
-                  "[]"
+                  "<Record<string, unknown>>[]"
                 ],
                 "path": "node_modules/@types/kbn__analytics-client/index.d.ts",
                 "deprecated": false,
@@ -36270,7 +36297,7 @@
         "signature": [
           "{ optIn: (optInConfig: ",
           "OptInConfig",
-          ") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
+          ") => void; reportEvent: <EventTypeData extends object>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
           "Observable",
           "<",
           "TelemetryCounter",
@@ -36302,7 +36329,7 @@
         "signature": [
           "{ optIn: (optInConfig: ",
           "OptInConfig",
-          ") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
+          ") => void; reportEvent: <EventTypeData extends object>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
           "Observable",
           "<",
           "TelemetryCounter",
@@ -36334,7 +36361,7 @@
         "signature": [
           "{ optIn: (optInConfig: ",
           "OptInConfig",
-          ") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
+          ") => void; reportEvent: <EventTypeData extends object>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
           "Observable",
           "<",
           "TelemetryCounter",

diff --git a/api_docs/core.mdx b/api_docs/core.mdx
@@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core
 title: "core"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the core plugin
-date: 2022-08-03
+date: 2022-08-04
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core']
 warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
 ---
@@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
 
 | Public API count  | Any count | Items lacking comments | Missing exports |
 |-------------------|-----------|------------------------|-----------------|
-| 2524 | 2 | 297 | 6 |
+| 2524 | 2 | 296 | 6 |
 
 ## Client