Add packages to our API documentation (#113564) (#114513)

* Add packages * Update docs * Fix test and types * debug heap size * remove debug heap line * updated docs # Conflicts: # api_docs/alerting.mdx # api_docs/apm.json # api_docs/core.mdx # api_docs/core_application.mdx # api_docs/core_chrome.mdx # api_docs/core_http.mdx # api_docs/core_saved_objects.mdx # api_docs/custom_integrations.mdx # api_docs/data.json # api_docs/data.mdx # api_docs/data_autocomplete.mdx # api_docs/data_data_views.json # api_docs/data_data_views.mdx # api_docs/data_query.mdx # api_docs/data_search.mdx # api_docs/data_ui.mdx # api_docs/deprecations_by_api.mdx # api_docs/deprecations_by_plugin.mdx # api_docs/discover_enhanced.json # api_docs/embeddable.json # api_docs/event_log.mdx # api_docs/fleet.mdx # api_docs/home.json # api_docs/index_management.json # api_docs/interactive_setup.mdx # api_docs/kibana_legacy.json # api_docs/kibana_legacy.mdx # api_docs/observability.mdx # api_docs/plugin_directory.mdx # api_docs/security_oss.mdx
elastic · Oct 11, 2021 · e92a945 · e92a945
1 parent 03cef84
commit e92a945
Show file tree

Hide file tree

Showing 316 changed files with 138,529 additions and 22,458 deletions.
diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx
@@ -1,7 +1,7 @@
 ---
 id: kibActionsPluginApi
-slug: /kibana-dev-docs/actionsPluginApi
-title: actions
+slug: /kibana-dev-docs/api/actions
+title: "actions"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the actions plugin
 date: 2020-11-16

diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx
@@ -1,7 +1,7 @@
 ---
 id: kibAdvancedSettingsPluginApi
-slug: /kibana-dev-docs/advancedSettingsPluginApi
-title: advancedSettings
+slug: /kibana-dev-docs/api/advancedSettings
+title: "advancedSettings"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the advancedSettings plugin
 date: 2020-11-16

diff --git a/api_docs/alerting.json b/api_docs/alerting.json
@@ -25,7 +25,13 @@
             "text": "Alert"
           },
           "<never>, \"enabled\" | \"id\" | \"name\" | \"tags\" | \"params\" | \"actions\" | \"throttle\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | ",
-          "JsonObject"
+          {
+            "pluginId": "@kbn/utility-types",
+            "scope": "server",
+            "docId": "kibKbnUtilityTypesPluginApi",
+            "section": "def-server.JsonObject",
+            "text": "JsonObject"
+          }
         ],
         "path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts",
         "deprecated": false,
@@ -510,9 +516,21 @@
               ", filterOpts: ",
               "AlertingAuthorizationFilterOpts",
               ") => Promise<{ filter?: ",
-              "KueryNode",
+              {
+                "pluginId": "@kbn/es-query",
+                "scope": "common",
+                "docId": "kibKbnEsQueryPluginApi",
+                "section": "def-common.KueryNode",
+                "text": "KueryNode"
+              },
               " | ",
-              "JsonObject",
+              {
+                "pluginId": "@kbn/utility-types",
+                "scope": "server",
+                "docId": "kibKbnUtilityTypesPluginApi",
+                "section": "def-server.JsonObject",
+                "text": "JsonObject"
+              },
               " | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; logSuccessfulAuthorization: () => void; }>"
             ],
             "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
@@ -590,9 +608,21 @@
                 "text": "WriteOperations"
               },
               ") => Promise<{ filter?: ",
-              "KueryNode",
+              {
+                "pluginId": "@kbn/es-query",
+                "scope": "common",
+                "docId": "kibKbnEsQueryPluginApi",
+                "section": "def-common.KueryNode",
+                "text": "KueryNode"
+              },
               " | ",
-              "JsonObject",
+              {
+                "pluginId": "@kbn/utility-types",
+                "scope": "server",
+                "docId": "kibKbnUtilityTypesPluginApi",
+                "section": "def-server.JsonObject",
+                "text": "JsonObject"
+              },
               " | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; logSuccessfulAuthorization: () => void; }>"
             ],
             "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
@@ -1537,6 +1567,19 @@
             "description": [],
             "path": "x-pack/plugins/alerting/server/types.ts",
             "deprecated": false
+          },
+          {
+            "parentPluginId": "alerting",
+            "id": "def-server.AlertType.ruleTaskTimeout",
+            "type": "string",
+            "tags": [],
+            "label": "ruleTaskTimeout",
+            "description": [],
+            "signature": [
+              "string | undefined"
+            ],
+            "path": "x-pack/plugins/alerting/server/types.ts",
+            "deprecated": false
           }
         ],
         "initialIsOpen": false
@@ -3388,7 +3431,13 @@
             "label": "state",
             "description": [],
             "signature": [
-              "JsonObject"
+              {
+                "pluginId": "@kbn/utility-types",
+                "scope": "server",
+                "docId": "kibKbnUtilityTypesPluginApi",
+                "section": "def-server.JsonObject",
+                "text": "JsonObject"
+              }
             ],
             "path": "x-pack/plugins/alerting/common/alert_navigation.ts",
             "deprecated": false

diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx
@@ -1,7 +1,7 @@
 ---
 id: kibAlertingPluginApi
-slug: /kibana-dev-docs/alertingPluginApi
-title: alerting
+slug: /kibana-dev-docs/api/alerting
+title: "alerting"
 image: https://source.unsplash.com/400x175/?github
 summary: API docs for the alerting plugin
 date: 2020-11-16
@@ -18,7 +18,7 @@ Contact [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-
 
 | Public API count  | Any count | Items lacking comments | Missing exports | 
 |-------------------|-----------|------------------------|-----------------|
-| 248 | 0 | 240 | 16 |
+| 249 | 0 | 241 | 16 |
 
 ## Client