[api-docs] 2023-07-03 Daily api_docs build (#161059)

Generated by https://buildkite.com/elastic/kibana-api-docs-daily/builds/387
elastic · Jul 3, 2023 · 10b35cf · 10b35cf
1 parent e31ede2
commit 10b35cf
Show file tree

Hide file tree

Showing 550 changed files with 1,115 additions and 804 deletions.
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: 2023-07-02
+date: 2023-07-03
 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: 2023-07-02
+date: 2023-07-03
 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: 2023-07-02
+date: 2023-07-03
 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
@@ -7144,239 +7144,6 @@
  ],
  "initialIsOpen": false
  },
- {
- "parentPluginId": "alerting",
- "id": "def-common.RRuleRecord",
- "type": "Interface",
- "tags": [],
- "label": "RRuleRecord",
- "description": [],
- "path": "x-pack/plugins/alerting/common/rrule_type.ts",
- "deprecated": false,
- "trackAdoption": false,
- "children": [
- {
- "parentPluginId": "alerting",
- "id": "def-common.RRuleRecord.dtstart",
- "type": "string",
- "tags": [],
- "label": "dtstart",
- "description": [],
- "path": "x-pack/plugins/alerting/common/rrule_type.ts",
- "deprecated": false,
- "trackAdoption": false
- },
- {
- "parentPluginId": "alerting",
- "id": "def-common.RRuleRecord.tzid",
- "type": "string",
- "tags": [],
- "label": "tzid",
- "description": [],
- "path": "x-pack/plugins/alerting/common/rrule_type.ts",
- "deprecated": false,
- "trackAdoption": false
- },
- {
- "parentPluginId": "alerting",
- "id": "def-common.RRuleRecord.freq",
- "type": "CompoundType",
- "tags": [],
- "label": "freq",
- "description": [],
- "signature": [
- "0 | 2 | 6 | 5 | 4 | 3 | 1 | undefined"
- ],
- "path": "x-pack/plugins/alerting/common/rrule_type.ts",
- "deprecated": false,
- "trackAdoption": false
- },
- {
- "parentPluginId": "alerting",
- "id": "def-common.RRuleRecord.until",
- "type": "string",
- "tags": [],
- "label": "until",
- "description": [],
- "signature": [
- "string | undefined"
- ],
- "path": "x-pack/plugins/alerting/common/rrule_type.ts",
- "deprecated": false,
- "trackAdoption": false
- },
- {
- "parentPluginId": "alerting",
- "id": "def-common.RRuleRecord.count",
- "type": "number",
- "tags": [],
- "label": "count",
- "description": [],
- "signature": [
- "number | undefined"
- ],
- "path": "x-pack/plugins/alerting/common/rrule_type.ts",
- "deprecated": false,
- "trackAdoption": false
- },
- {
- "parentPluginId": "alerting",
- "id": "def-common.RRuleRecord.interval",
- "type": "number",
- "tags": [],
- "label": "interval",
- "description": [],
- "signature": [
- "number | undefined"
- ],
- "path": "x-pack/plugins/alerting/common/rrule_type.ts",
- "deprecated": false,
- "trackAdoption": false
- },
- {
- "parentPluginId": "alerting",
- "id": "def-common.RRuleRecord.wkst",
- "type": "CompoundType",
- "tags": [],
- "label": "wkst",
- "description": [],
- "signature": [
- "WeekdayStr",
- " | undefined"
- ],
- "path": "x-pack/plugins/alerting/common/rrule_type.ts",
- "deprecated": false,
- "trackAdoption": false
- },
- {
- "parentPluginId": "alerting",
- "id": "def-common.RRuleRecord.byweekday",
- "type": "Array",
- "tags": [],
- "label": "byweekday",
- "description": [],
- "signature": [
- "(string | number)[] | undefined"
- ],
- "path": "x-pack/plugins/alerting/common/rrule_type.ts",
- "deprecated": false,
- "trackAdoption": false
- },
- {
- "parentPluginId": "alerting",
- "id": "def-common.RRuleRecord.bymonth",
- "type": "Array",
- "tags": [],
- "label": "bymonth",
- "description": [],
- "signature": [
- "number[] | undefined"
- ],
- "path": "x-pack/plugins/alerting/common/rrule_type.ts",
- "deprecated": false,
- "trackAdoption": false
- },
- {
- "parentPluginId": "alerting",
- "id": "def-common.RRuleRecord.bysetpos",
- "type": "Array",
- "tags": [],
- "label": "bysetpos",
- "description": [],
- "signature": [
- "number[] | undefined"
- ],
- "path": "x-pack/plugins/alerting/common/rrule_type.ts",
- "deprecated": false,
- "trackAdoption": false
- },
- {
- "parentPluginId": "alerting",
- "id": "def-common.RRuleRecord.bymonthday",
- "type": "Array",
- "tags": [],
- "label": "bymonthday",
- "description": [],
- "signature": [
- "number[]"
- ],
- "path": "x-pack/plugins/alerting/common/rrule_type.ts",
- "deprecated": false,
- "trackAdoption": false
- },
- {
- "parentPluginId": "alerting",
- "id": "def-common.RRuleRecord.byyearday",
- "type": "Array",
- "tags": [],
- "label": "byyearday",
- "description": [],
- "signature": [
- "number[]"
- ],
- "path": "x-pack/plugins/alerting/common/rrule_type.ts",
- "deprecated": false,
- "trackAdoption": false
- },
- {
- "parentPluginId": "alerting",
- "id": "def-common.RRuleRecord.byweekno",
- "type": "Array",
- "tags": [],
- "label": "byweekno",
- "description": [],
- "signature": [
- "number[]"
- ],
- "path": "x-pack/plugins/alerting/common/rrule_type.ts",
- "deprecated": false,
- "trackAdoption": false
- },
- {
- "parentPluginId": "alerting",
- "id": "def-common.RRuleRecord.byhour",
- "type": "Array",
- "tags": [],
- "label": "byhour",
- "description": [],
- "signature": [
- "number[]"
- ],
- "path": "x-pack/plugins/alerting/common/rrule_type.ts",
- "deprecated": false,
- "trackAdoption": false
- },
- {
- "parentPluginId": "alerting",
- "id": "def-common.RRuleRecord.byminute",
- "type": "Array",
- "tags": [],
- "label": "byminute",
- "description": [],
- "signature": [
- "number[]"
- ],
- "path": "x-pack/plugins/alerting/common/rrule_type.ts",
- "deprecated": false,
- "trackAdoption": false
- },
- {
- "parentPluginId": "alerting",
- "id": "def-common.RRuleRecord.bysecond",
- "type": "Array",
- "tags": [],
- "label": "bysecond",
- "description": [],
- "signature": [
- "number[]"
- ],
- "path": "x-pack/plugins/alerting/common/rrule_type.ts",
- "deprecated": false,
- "trackAdoption": false
- }
- ],
- "initialIsOpen": false
- },
  {
  "parentPluginId": "alerting",
  "id": "def-common.Rule",
@@ -10247,6 +10014,31 @@
  "trackAdoption": false,
  "initialIsOpen": false
  },
+ {
+ "parentPluginId": "alerting",
+ "id": "def-common.RRuleRecord",
+ "type": "Type",
+ "tags": [],
+ "label": "RRuleRecord",
+ "description": [],
+ "signature": [
+ "Omit<",
+ "Options",
+ ", \"wkst\" | \"byweekday\" | \"dtstart\" | \"until\"> & { dtstart: string; byweekday?: (string | number)[] | undefined; wkst?: ",
+ {
+ "pluginId": "@kbn/rrule",
+ "scope": "common",
+ "docId": "kibKbnRrulePluginApi",
+ "section": "def-common.WeekdayStr",
+ "text": "WeekdayStr"
+ },
+ " | undefined; until?: string | undefined; }"
+ ],
+ "path": "x-pack/plugins/alerting/common/rrule_type.ts",
+ "deprecated": false,
+ "trackAdoption": false,
+ "initialIsOpen": false
+ },
  {
  "parentPluginId": "alerting",
  "id": "def-common.RuleActionAlertsFilterProperty",

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: 2023-07-02
+date: 2023-07-03
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
 ---
 import alertingObj from './alerting.devdocs.json';
@@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o
 
 | Public API count | Any count | Items lacking comments | Missing exports |
 |-------------------|-----------|------------------------|-----------------|
-| 635 | 1 | 611 | 47 |
+| 619 | 1 | 595 | 47 |
 
 ## Client
 

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: 2023-07-02
+date: 2023-07-03
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
 ---
 import apmObj from './apm.devdocs.json';

diff --git a/api_docs/asset_manager.mdx b/api_docs/asset_manager.mdx
@@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/assetManager
 title: "assetManager"
 image: https://source.unsplash.com/400x175/?github
 description: API docs for the assetManager plugin
-date: 2023-07-02
+date: 2023-07-03
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetManager']
 ---
 import assetManagerObj from './asset_manager.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: 2023-07-02
+date: 2023-07-03
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
 ---
 import bannersObj from './banners.devdocs.json';

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: 2023-07-02
+date: 2023-07-03
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
 ---
 import bfetchObj from './bfetch.devdocs.json';

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: 2023-07-02
+date: 2023-07-03
 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: 2023-07-02
+date: 2023-07-03
 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: 2023-07-02
+date: 2023-07-03
 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
 ---
 import chartsObj from './charts.devdocs.json';