Skip to content

Commit

Permalink
[api-docs] 2023-09-01 Daily api_docs build (#165427)
Browse files Browse the repository at this point in the history
  • Loading branch information
kibanamachine authored Sep 1, 2023
1 parent 6bbd3c6 commit 0d12a05
Show file tree
Hide file tree
Showing 588 changed files with 2,364 additions and 1,008 deletions.
2 changes: 1 addition & 1 deletion api_docs/actions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
---
import actionsObj from './actions.devdocs.json';
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 @@ -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-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
---
import advancedSettingsObj from './advanced_settings.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/aiops.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
---
import aiopsObj from './aiops.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/alerting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
---
import alertingObj from './alerting.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/apm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
---
import apmObj from './apm.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/apm_data_access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apmDataAccess
title: "apmDataAccess"
image: https://source.unsplash.com/400x175/?github
description: API docs for the apmDataAccess plugin
date: 2023-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
---
import apmDataAccessObj from './apm_data_access.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/asset_manager.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetManager']
---
import assetManagerObj from './asset_manager.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/banners.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
---
import bannersObj from './banners.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/bfetch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
---
import bfetchObj from './bfetch.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/canvas.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
---
import canvasObj from './canvas.devdocs.json';
Expand Down
162 changes: 160 additions & 2 deletions api_docs/cases.devdocs.json
Original file line number Diff line number Diff line change
Expand Up @@ -1091,7 +1091,14 @@
"\nReturn the UI capabilities for each type of operation. These strings must match the values defined in the UI\nhere: x-pack/plugins/cases/public/client/helpers/capabilities.ts"
],
"signature": [
"() => { all: readonly [\"create_cases\", \"read_cases\", \"update_cases\", \"push_cases\", \"cases_connectors\"]; read: readonly [\"read_cases\", \"cases_connectors\"]; delete: readonly [\"delete_cases\"]; }"
"() => ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesUiCapabilities",
"text": "CasesUiCapabilities"
}
],
"path": "x-pack/plugins/cases/common/utils/capabilities.ts",
"deprecated": false,
Expand All @@ -1108,7 +1115,14 @@
"label": "getApiTags",
"description": [],
"signature": [
"(owner: \"cases\" | \"observability\" | \"securitySolution\") => { all: readonly [\"casesSuggestUserProfiles\", \"bulkGetUserProfiles\", \"casesGetConnectorsConfigure\", string, string]; read: readonly [\"casesSuggestUserProfiles\", \"bulkGetUserProfiles\", \"casesGetConnectorsConfigure\", string]; delete: readonly [string]; }"
"(owner: \"cases\" | \"observability\" | \"securitySolution\") => ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesApiTags",
"text": "CasesApiTags"
}
],
"path": "x-pack/plugins/cases/common/utils/api_tags.ts",
"deprecated": false,
Expand Down Expand Up @@ -1236,6 +1250,62 @@
}
],
"interfaces": [
{
"parentPluginId": "cases",
"id": "def-common.CasesApiTags",
"type": "Interface",
"tags": [],
"label": "CasesApiTags",
"description": [],
"path": "x-pack/plugins/cases/common/utils/api_tags.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.CasesApiTags.all",
"type": "Object",
"tags": [],
"label": "all",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/plugins/cases/common/utils/api_tags.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesApiTags.read",
"type": "Object",
"tags": [],
"label": "read",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/plugins/cases/common/utils/api_tags.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesApiTags.delete",
"type": "Object",
"tags": [],
"label": "delete",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/plugins/cases/common/utils/api_tags.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions",
Expand Down Expand Up @@ -1327,6 +1397,62 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesUiCapabilities",
"type": "Interface",
"tags": [],
"label": "CasesUiCapabilities",
"description": [],
"path": "x-pack/plugins/cases/common/utils/capabilities.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.CasesUiCapabilities.all",
"type": "Object",
"tags": [],
"label": "all",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/plugins/cases/common/utils/capabilities.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesUiCapabilities.read",
"type": "Object",
"tags": [],
"label": "read",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/plugins/cases/common/utils/capabilities.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesUiCapabilities.delete",
"type": "Object",
"tags": [],
"label": "delete",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/plugins/cases/common/utils/capabilities.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.Ecs",
Expand Down Expand Up @@ -2031,6 +2157,21 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASES_CONNECTORS_CAPABILITY",
"type": "string",
"tags": [],
"label": "CASES_CONNECTORS_CAPABILITY",
"description": [],
"signature": [
"\"cases_connectors\""
],
"path": "x-pack/plugins/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASES_URL",
Expand Down Expand Up @@ -2651,6 +2792,23 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.GET_CONNECTORS_CONFIGURE_API_TAG",
"type": "string",
"tags": [],
"label": "GET_CONNECTORS_CONFIGURE_API_TAG",
"description": [
"\nThis tag is registered for the connectors (configure) get API"
],
"signature": [
"\"casesGetConnectorsConfigure\""
],
"path": "x-pack/plugins/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.GetRelatedCasesByAlertResponse",
Expand Down
4 changes: 2 additions & 2 deletions api_docs/cases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
---
import casesObj from './cases.devdocs.json';
Expand All @@ -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 |
|-------------------|-----------|------------------------|-----------------|
| 94 | 0 | 75 | 27 |
| 104 | 0 | 84 | 27 |

## Client

Expand Down
2 changes: 1 addition & 1 deletion api_docs/charts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
---
import chartsObj from './charts.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/cloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloud
title: "cloud"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloud plugin
date: 2023-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
---
import cloudObj from './cloud.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/cloud_chat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChat
title: "cloudChat"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudChat plugin
date: 2023-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChat']
---
import cloudChatObj from './cloud_chat.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/cloud_chat_provider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChatProvider
title: "cloudChatProvider"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudChatProvider plugin
date: 2023-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChatProvider']
---
import cloudChatProviderObj from './cloud_chat_provider.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/cloud_data_migration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDataMigration
title: "cloudDataMigration"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDataMigration plugin
date: 2023-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
---
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/cloud_defend.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDefend
title: "cloudDefend"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDefend plugin
date: 2023-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
---
import cloudDefendObj from './cloud_defend.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/cloud_experiments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudExperiments
title: "cloudExperiments"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudExperiments plugin
date: 2023-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments']
---
import cloudExperimentsObj from './cloud_experiments.devdocs.json';
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 @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture
title: "cloudSecurityPosture"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudSecurityPosture plugin
date: 2023-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
---
import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/console.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/console
title: "console"
image: https://source.unsplash.com/400x175/?github
description: API docs for the console plugin
date: 2023-08-31
date: 2023-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
---
import consoleObj from './console.devdocs.json';
Expand Down
Loading

0 comments on commit 0d12a05

Please sign in to comment.