Skip to content

Commit

Permalink
[api-docs] 2023-08-11 Daily api_docs build (#163672)
Browse files Browse the repository at this point in the history
  • Loading branch information
kibanamachine authored Aug 11, 2023
1 parent 2465550 commit ccc252d
Show file tree
Hide file tree
Showing 567 changed files with 1,111 additions and 704 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-10
date: 2023-08-11
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-10
date: 2023-08-11
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-10
date: 2023-08-11
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-10
date: 2023-08-11
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-10
date: 2023-08-11
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
---
import apmObj from './apm.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-10
date: 2023-08-11
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-10
date: 2023-08-11
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-10
date: 2023-08-11
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-10
date: 2023-08-11
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
---
import canvasObj from './canvas.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion 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-10
date: 2023-08-11
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
---
import casesObj from './cases.devdocs.json';
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-10
date: 2023-08-11
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
---
import chartsObj from './charts.devdocs.json';
Expand Down
100 changes: 84 additions & 16 deletions api_docs/cloud.devdocs.json
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@
"tags": [],
"label": "deploymentUrl",
"description": [
"\nThe full URL to the deployment management page on Elastic Cloud. Undefined if not running on Cloud."
"\nThis is the path to the Cloud deployment management page for the deployment to which the Kibana instance belongs. The value is already prepended with `baseUrl`.\n"
],
"signature": [
"string | undefined"
Expand Down Expand Up @@ -517,7 +517,7 @@
"tags": [],
"label": "cname",
"description": [
"\nThis value is the same as `baseUrl` on ESS but can be customized on ECE."
"\nThis value is the same as `baseUrl` on ESS but can be customized on ECE.\n"
],
"signature": [
"string | undefined"
Expand Down Expand Up @@ -549,7 +549,7 @@
"tags": [],
"label": "deploymentUrl",
"description": [
"\nThe full URL to the deployment management page on Elastic Cloud. Undefined if not running on Cloud."
"\nThe full URL to the deployment management page on Elastic Cloud. Undefined if not running on Cloud.\n"
],
"signature": [
"string | undefined"
Expand Down Expand Up @@ -581,7 +581,7 @@
"tags": [],
"label": "profileUrl",
"description": [
"\nThe full URL to the user profile page on Elastic Cloud. Undefined if not running on Cloud."
"\nThis is the path to the Cloud User Profile page. The value is already prepended with `baseUrl`.\n"
],
"signature": [
"string | undefined"
Expand All @@ -597,7 +597,7 @@
"tags": [],
"label": "organizationUrl",
"description": [
"\nThe full URL to the organization management page on Elastic Cloud. Undefined if not running on Cloud."
"\nThis is the path to the Cloud Account and Billing page. The value is already prepended with `baseUrl`.\n"
],
"signature": [
"string | undefined"
Expand All @@ -613,7 +613,7 @@
"tags": [],
"label": "snapshotsUrl",
"description": [
"\nThis is the path to the Snapshots page for the deployment to which the Kibana instance belongs. The value is already prepended with `deploymentUrl`."
"\nThis is the path to the Snapshots page for the deployment to which the Kibana instance belongs. The value is already prepended with `deploymentUrl`.\n"
],
"signature": [
"string | undefined"
Expand Down Expand Up @@ -706,7 +706,7 @@
"tags": [],
"label": "trialEndDate",
"description": [
"\nWhen the Cloud Trial ends/ended for the organization that owns this deployment. Only available when running on Elastic Cloud."
"\nThe end date for the Elastic Cloud trial. Only available on Elastic Cloud.\n"
],
"signature": [
"Date | undefined"
Expand Down Expand Up @@ -738,7 +738,7 @@
"tags": [],
"label": "registerCloudService",
"description": [
"\nRegisters CloudServiceProviders so start's `CloudContextProvider` hooks them."
"\nRegisters CloudServiceProviders so start's `CloudContextProvider` hooks them.\n"
],
"signature": [
"(contextProvider: React.FC<{}>) => void"
Expand Down Expand Up @@ -825,10 +825,12 @@
"parentPluginId": "cloud",
"id": "def-server.CloudSetup.cloudId",
"type": "string",
"tags": [],
"tags": [
"note"
],
"label": "cloudId",
"description": [
"\nThe deployment's Cloud ID. Only available when running on Elastic Cloud."
"\nThis is the ID of the Cloud deployment to which the Kibana instance belongs.\n"
],
"signature": [
"string | undefined"
Expand Down Expand Up @@ -885,14 +887,46 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cloud",
"id": "def-server.CloudSetup.projectsUrl",
"type": "string",
"tags": [],
"label": "projectsUrl",
"description": [
"\nThis is the URL to the \"projects\" interface on cloud.\n"
],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/cloud/server/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cloud",
"id": "def-server.CloudSetup.baseUrl",
"type": "string",
"tags": [],
"label": "baseUrl",
"description": [
"\nThis is the URL of the Cloud interface.\n"
],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/cloud/server/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cloud",
"id": "def-server.CloudSetup.cloudHost",
"type": "string",
"tags": [],
"label": "cloudHost",
"description": [
"\n{host} from the deployment url https://<deploymentId>.<application>.<host><?:port>"
"\n{host} of the deployment url https://<deploymentId>.<application>.<host><?:port>"
],
"signature": [
"string | undefined"
Expand All @@ -908,7 +942,7 @@
"tags": [],
"label": "cloudDefaultPort",
"description": [
"\n{port} from the deployment url https://<deploymentId>.<application>.<host><?:port>"
"\n{port} of the deployment url https://<deploymentId>.<application>.<host><?:port>"
],
"signature": [
"string | undefined"
Expand All @@ -924,7 +958,7 @@
"tags": [],
"label": "isCloudEnabled",
"description": [
"\n`true` when running on Elastic Cloud."
"\nThis is set to `true` for both ESS and ECE deployments."
],
"path": "x-pack/plugins/cloud/server/plugin.ts",
"deprecated": false,
Expand Down Expand Up @@ -1011,10 +1045,12 @@
"parentPluginId": "cloud",
"id": "def-server.CloudSetup.serverless",
"type": "Object",
"tags": [],
"tags": [
"note"
],
"label": "serverless",
"description": [
"\nServerless configuration"
"\nServerless configuration.\n"
],
"signature": [
"{ projectId?: string | undefined; }"
Expand Down Expand Up @@ -1047,7 +1083,39 @@
"tags": [],
"label": "isCloudEnabled",
"description": [
"\n`true` when running on Elastic Cloud."
"\nThis is set to `true` for both ESS and ECE deployments."
],
"path": "x-pack/plugins/cloud/server/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cloud",
"id": "def-server.CloudStart.projectsUrl",
"type": "string",
"tags": [],
"label": "projectsUrl",
"description": [
"\nThis is the URL to the \"projects\" interface on cloud.\n"
],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/cloud/server/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cloud",
"id": "def-server.CloudStart.baseUrl",
"type": "string",
"tags": [],
"label": "baseUrl",
"description": [
"\nThis is the URL of the Cloud interface.\n"
],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/cloud/server/plugin.ts",
"deprecated": false,
Expand Down
4 changes: 2 additions & 2 deletions 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-10
date: 2023-08-11
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
---
import cloudObj from './cloud.devdocs.json';
Expand All @@ -21,7 +21,7 @@ Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 68 | 0 | 16 | 0 |
| 72 | 0 | 16 | 0 |

## Client

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-10
date: 2023-08-11
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-10
date: 2023-08-11
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-10
date: 2023-08-11
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-10
date: 2023-08-11
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-10
date: 2023-08-11
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-10
date: 2023-08-11
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-10
date: 2023-08-11
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
---
import consoleObj from './console.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/content_management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/contentManagement
title: "contentManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the contentManagement plugin
date: 2023-08-10
date: 2023-08-11
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
---
import contentManagementObj from './content_management.devdocs.json';
Expand Down
Loading

0 comments on commit ccc252d

Please sign in to comment.