[api-docs] Daily api_docs build (elastic#134799)

kibanamachine · Jun 21, 2022 · 04e6217 · 04e6217
1 parent 1599cd8
commit 04e6217
Show file tree

Hide file tree

Showing 254 changed files with 2,107 additions and 663 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-06-20
+date: 2022-06-21
 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-06-20
+date: 2022-06-21
 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-06-20
+date: 2022-06-21
 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.devdocs.json b/api_docs/alerting.devdocs.json
@@ -3036,7 +3036,15 @@
             "section": "def-server.BulkEditError",
             "text": "BulkEditError"
           },
-          "[]; total: number; }>; updateApiKey: ({ id }: { id: string; }) => Promise<void>; snooze: ({ id, snoozeEndTime, }: { id: string; snoozeEndTime: string | -1; }) => Promise<void>; unsnooze: ({ id }: { id: string; }) => Promise<void>; updateSnoozedUntilTime: ({ id }: { id: string; }) => Promise<void>; unmuteAll: ({ id }: { id: string; }) => Promise<void>; muteInstance: ({ alertId, alertInstanceId }: ",
+          "[]; total: number; }>; updateApiKey: ({ id }: { id: string; }) => Promise<void>; snooze: ({ id, snoozeSchedule, }: { id: string; snoozeSchedule: ",
+          {
+            "pluginId": "alerting",
+            "scope": "common",
+            "docId": "kibAlertingPluginApi",
+            "section": "def-common.RuleSnoozeSchedule",
+            "text": "RuleSnoozeSchedule"
+          },
+          "; }) => Promise<void>; unsnooze: ({ id, scheduleIds, }: { id: string; scheduleIds?: string[] | undefined; }) => Promise<void>; updateSnoozedUntilTime: ({ id }: { id: string; }) => Promise<void>; unmuteAll: ({ id }: { id: string; }) => Promise<void>; muteInstance: ({ alertId, alertInstanceId }: ",
           "MuteOptions",
           ") => Promise<void>; unmuteInstance: ({ alertId, alertInstanceId }: ",
           "MuteOptions",
@@ -4466,10 +4474,13 @@
           {
             "parentPluginId": "alerting",
             "id": "def-common.RRuleRecord.bymonthday",
-            "type": "number",
+            "type": "Array",
             "tags": [],
             "label": "bymonthday",
             "description": [],
+            "signature": [
+              "number[]"
+            ],
             "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
             "deprecated": false
           },
@@ -5241,6 +5252,71 @@
         ],
         "initialIsOpen": false
       },
+      {
+        "parentPluginId": "alerting",
+        "id": "def-common.RuleSnoozeSchedule",
+        "type": "Interface",
+        "tags": [],
+        "label": "RuleSnoozeSchedule",
+        "description": [],
+        "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
+        "deprecated": false,
+        "children": [
+          {
+            "parentPluginId": "alerting",
+            "id": "def-common.RuleSnoozeSchedule.duration",
+            "type": "number",
+            "tags": [],
+            "label": "duration",
+            "description": [],
+            "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
+            "deprecated": false
+          },
+          {
+            "parentPluginId": "alerting",
+            "id": "def-common.RuleSnoozeSchedule.rRule",
+            "type": "CompoundType",
+            "tags": [],
+            "label": "rRule",
+            "description": [],
+            "signature": [
+              "Partial<",
+              {
+                "pluginId": "alerting",
+                "scope": "common",
+                "docId": "kibAlertingPluginApi",
+                "section": "def-common.RRuleRecord",
+                "text": "RRuleRecord"
+              },
+              "> & Pick<",
+              {
+                "pluginId": "alerting",
+                "scope": "common",
+                "docId": "kibAlertingPluginApi",
+                "section": "def-common.RRuleRecord",
+                "text": "RRuleRecord"
+              },
+              ", \"dtstart\" | \"tzid\">"
+            ],
+            "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
+            "deprecated": false
+          },
+          {
+            "parentPluginId": "alerting",
+            "id": "def-common.RuleSnoozeSchedule.id",
+            "type": "string",
+            "tags": [],
+            "label": "id",
+            "description": [],
+            "signature": [
+              "string | undefined"
+            ],
+            "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
+            "deprecated": false
+          }
+        ],
+        "initialIsOpen": false
+      },
       {
         "parentPluginId": "alerting",
         "id": "def-common.RuleStateNavigation",
@@ -5942,23 +6018,7 @@
         "label": "RuleSnooze",
         "description": [],
         "signature": [
-          "{ duration: number; rRule: Partial<",
-          {
-            "pluginId": "alerting",
-            "scope": "common",
-            "docId": "kibAlertingPluginApi",
-            "section": "def-common.RRuleRecord",
-            "text": "RRuleRecord"
-          },
-          "> & Pick<",
-          {
-            "pluginId": "alerting",
-            "scope": "common",
-            "docId": "kibAlertingPluginApi",
-            "section": "def-common.RRuleRecord",
-            "text": "RRuleRecord"
-          },
-          ", \"dtstart\" | \"tzid\">; id?: string | undefined; }[]"
+          "{ duration: number; rRule: SnoozeRRule; id?: string | undefined; }[]"
         ],
         "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
         "deprecated": false,

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-06-20
+date: 2022-06-21
 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.
 ---
@@ -18,7 +18,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q
 
 | Public API count  | Any count | Items lacking comments | Missing exports |
 |-------------------|-----------|------------------------|-----------------|
-| 359 | 0 | 350 | 20 |
+| 363 | 0 | 354 | 20 |
 
 ## Client
 

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-06-20
+date: 2022-06-21
 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-06-20
+date: 2022-06-21
 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-06-20
+date: 2022-06-21
 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-06-20
+date: 2022-06-21
 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-06-20
+date: 2022-06-21
 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-06-20
+date: 2022-06-21
 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-06-20
+date: 2022-06-21
 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-06-20
+date: 2022-06-21
 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-06-20
+date: 2022-06-21
 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-06-20
+date: 2022-06-21
 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.
 ---