Skip to content

Commit

Permalink
[api-docs] Daily api_docs build (#136061)
Browse files Browse the repository at this point in the history
  • Loading branch information
kibanamachine authored Jul 9, 2022
1 parent f990f31 commit bfb1988
Show file tree
Hide file tree
Showing 287 changed files with 1,868 additions and 480 deletions.
2 changes: 1 addition & 1 deletion api_docs/actions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-07-08
date: 2022-07-09
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/advanced_settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-07-08
date: 2022-07-09
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/aiops.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-07-08
date: 2022-07-09
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.
---
Expand Down
31 changes: 31 additions & 0 deletions api_docs/alerting.devdocs.json
Original file line number Diff line number Diff line change
Expand Up @@ -829,6 +829,37 @@
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-server.isRuleSnoozed",
"type": "Function",
"tags": [],
"label": "isRuleSnoozed",
"description": [],
"signature": [
"(rule: RuleSnoozeProps) => boolean"
],
"path": "x-pack/plugins/alerting/server/lib/is_rule_snoozed.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-server.isRuleSnoozed.$1",
"type": "Object",
"tags": [],
"label": "rule",
"description": [],
"signature": [
"RuleSnoozeProps"
],
"path": "x-pack/plugins/alerting/server/lib/is_rule_snoozed.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-server.parseDuration",
Expand Down
4 changes: 2 additions & 2 deletions api_docs/alerting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-07-08
date: 2022-07-09
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.
---
Expand All @@ -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 |
|-------------------|-----------|------------------------|-----------------|
| 363 | 0 | 354 | 20 |
| 365 | 0 | 356 | 20 |

## Client

Expand Down
2 changes: 1 addition & 1 deletion api_docs/apm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-07-08
date: 2022-07-09
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/banners.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-07-08
date: 2022-07-09
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/bfetch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-07-08
date: 2022-07-09
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/canvas.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-07-08
date: 2022-07-09
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/cases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-07-08
date: 2022-07-09
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/charts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-07-08
date: 2022-07-09
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/cloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-07-08
date: 2022-07-09
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/cloud_security_posture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-07-08
date: 2022-07-09
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/console.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-07-08
date: 2022-07-09
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/controls.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-07-08
date: 2022-07-09
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/core.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-07-08
date: 2022-07-09
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/core_application.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-application
title: "core.application"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the core.application plugin
date: 2022-07-08
date: 2022-07-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.application']
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/core_chrome.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-chrome
title: "core.chrome"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the core.chrome plugin
date: 2022-07-08
date: 2022-07-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.chrome']
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/core_http.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-http
title: "core.http"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the core.http plugin
date: 2022-07-08
date: 2022-07-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.http']
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/core_saved_objects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-savedObjects
title: "core.savedObjects"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the core.savedObjects plugin
date: 2022-07-08
date: 2022-07-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.savedObjects']
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/custom_integrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/customIntegrations
title: "customIntegrations"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the customIntegrations plugin
date: 2022-07-08
date: 2022-07-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/dashboard.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboard
title: "dashboard"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the dashboard plugin
date: 2022-07-08
date: 2022-07-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
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.
---
Expand Down
2 changes: 1 addition & 1 deletion api_docs/dashboard_enhanced.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced
title: "dashboardEnhanced"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the dashboardEnhanced plugin
date: 2022-07-08
date: 2022-07-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
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.
---
Expand Down
32 changes: 28 additions & 4 deletions api_docs/data.devdocs.json
Original file line number Diff line number Diff line change
Expand Up @@ -4667,7 +4667,13 @@
"description": [],
"signature": [
"(x: unknown) => x is ",
"TimeRange"
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
}
],
"path": "src/plugins/data/common/query/timefilter/is_time_range.ts",
"deprecated": false,
Expand Down Expand Up @@ -8450,7 +8456,13 @@
],
"signature": [
"{ calculateAutoTimeExpression: (range: ",
"TimeRange",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
") => string | undefined; createAggConfigs: (indexPattern: ",
{
"pluginId": "dataViews",
Expand Down Expand Up @@ -8661,7 +8673,13 @@
" | ",
"Query",
"[] | undefined; timeRange?: ",
"TimeRange",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; }"
],
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
Expand Down Expand Up @@ -9398,7 +9416,13 @@
],
"signature": [
"{ time?: ",
"TimeRange",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; refreshInterval?: ",
{
"pluginId": "data",
Expand Down
4 changes: 2 additions & 2 deletions api_docs/data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data
title: "data"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the data plugin
date: 2022-07-08
date: 2022-07-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
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.
---
Expand All @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3073 | 34 | 2400 | 22 |
| 3075 | 34 | 2402 | 21 |

## Client

Expand Down
Loading

0 comments on commit bfb1988

Please sign in to comment.