github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[api-docs] 2024-07-01 Daily api_docs build (#187289)

Browse source 
Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/755
This commit is contained in:
Kibana Machine 2024-07-01 19:28:33 +02:00 • committed by GitHub
parent 2b611d8835
commit 1a8a905835
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 72 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

83
api_docs/integration_assistant.devdocs.json
View file

@ -34,13 +34,17 @@
"children": [
{
"parentPluginId": "integrationAssistant",
"id": "def-public.IntegrationAssistantPluginStart.CreateIntegration",
"type": "CompoundType",
"id": "def-public.IntegrationAssistantPluginStart.components",
"type": "Object",
"tags": [],
"label": "CreateIntegration",
"label": "components",
"description": [],
"signature": [
"React.ComponentClass<{}, any> | React.FunctionComponent<{}>"
"{ CreateIntegration: ",
"CreateIntegrationComponent",
"; CreateIntegrationCardButton: ",
"CreateIntegrationCardButtonComponent",
"; }"
],
"path": "x-pack/plugins/integration_assistant/public/types.ts",
"deprecated": false,
@ -48,21 +52,37 @@
},
{
"parentPluginId": "integrationAssistant",
"id": "def-public.IntegrationAssistantPluginStart.CreateIntegrationCardButton",
"type": "CompoundType",
"id": "def-public.IntegrationAssistantPluginStart.renderUpselling",
"type": "Function",
"tags": [],
"label": "CreateIntegrationCardButton",
"description": [],
"label": "renderUpselling",
"description": [
"\nSets the upselling to be rendered in the UI.\nIf defined, the section will be displayed and it will prevent\nthe user from interacting with the rest of the UI."
],
"signature": [
"React.ComponentClass<",
"CreateIntegrationCardButtonProps",
", any> | React.FunctionComponent<",
"CreateIntegrationCardButtonProps",
">"
"(upselling: React.ReactNode) => void"
],
"path": "x-pack/plugins/integration_assistant/public/types.ts",
"deprecated": false,
"trackAdoption": false
"trackAdoption": false,
"children": [
{
"parentPluginId": "integrationAssistant",
"id": "def-public.IntegrationAssistantPluginStart.renderUpselling.$1",
"type": "CompoundType",
"tags": [],
"label": "upselling",
"description": [],
"signature": [
"React.ReactNode"
],
"path": "x-pack/plugins/integration_assistant/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
}
],
"lifecycle": "start",
@ -86,7 +106,40 @@
"path": "x-pack/plugins/integration_assistant/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"children": [
{
"parentPluginId": "integrationAssistant",
"id": "def-server.IntegrationAssistantPluginSetup.setIsAvailable",
"type": "Function",
"tags": [],
"label": "setIsAvailable",
"description": [],
"signature": [
"(isAvailable: boolean) => void"
],
"path": "x-pack/plugins/integration_assistant/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "integrationAssistant",
"id": "def-server.IntegrationAssistantPluginSetup.setIsAvailable.$1",
"type": "boolean",
"tags": [],
"label": "isAvailable",
"description": [],
"signature": [
"boolean"
],
"path": "x-pack/plugins/integration_assistant/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "setup",
"initialIsOpen": true
},

2
api_docs/integration_assistant.mdx
View file

@ -21,7 +21,7 @@ Contact [@elastic/security-solution](https://github.com/orgs/elastic/teams/secur
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 44 | 0 | 38 | 2 |
| 47 | 0 | 40 | 3 |
## Client

2
api_docs/kbn_doc_links.devdocs.json
View file

@ -840,7 +840,7 @@
"label": "fleet",
"description": [],
"signature": [
"{ readonly beatsAgentComparison: string; readonly guide: string; readonly fleetServer: string; readonly fleetServerAddFleetServer: string; readonly esSettings: string; readonly settings: string; readonly logstashSettings: string; readonly kafkaSettings: string; readonly settingsFleetServerHostSettings: string; readonly settingsFleetServerProxySettings: string; readonly troubleshooting: string; readonly elasticAgent: string; readonly datastreams: string; readonly datastreamsILM: string; readonly datastreamsNamingScheme: string; readonly datastreamsManualRollover: string; readonly datastreamsTSDS: string; readonly datastreamsTSDSMetrics: string; readonly datastreamsDownsampling: string; readonly installElasticAgent: string; readonly installElasticAgentStandalone: string; readonly packageSignatures: string; readonly upgradeElasticAgent: string; readonly learnMoreBlog: string; readonly apiKeysLearnMore: string; readonly onPremRegistry: string; readonly secureLogstash: string; readonly agentPolicy: string; readonly api: string; readonly uninstallAgent: string; readonly installAndUninstallIntegrationAssets: string; readonly elasticAgentInputConfiguration: string; readonly policySecrets: string; readonly remoteESOoutput: string; readonly performancePresets: string; readonly scalingKubernetesResourcesAndLimits: string; readonly roleAndPrivileges: string; readonly proxiesSettings: string; }"
"{ readonly beatsAgentComparison: string; readonly guide: string; readonly fleetServer: string; readonly fleetServerAddFleetServer: string; readonly esSettings: string; readonly settings: string; readonly logstashSettings: string; readonly kafkaSettings: string; readonly settingsFleetServerHostSettings: string; readonly settingsFleetServerProxySettings: string; readonly troubleshooting: string; readonly elasticAgent: string; readonly datastreams: string; readonly datastreamsILM: string; readonly datastreamsNamingScheme: string; readonly datastreamsManualRollover: string; readonly datastreamsTSDS: string; readonly datastreamsTSDSMetrics: string; readonly datastreamsDownsampling: string; readonly installElasticAgent: string; readonly installElasticAgentStandalone: string; readonly packageSignatures: string; readonly upgradeElasticAgent: string; readonly learnMoreBlog: string; readonly apiKeysLearnMore: string; readonly onPremRegistry: string; readonly secureLogstash: string; readonly agentPolicy: string; readonly api: string; readonly uninstallAgent: string; readonly installAndUninstallIntegrationAssets: string; readonly elasticAgentInputConfiguration: string; readonly policySecrets: string; readonly remoteESOoutput: string; readonly performancePresets: string; readonly scalingKubernetesResourcesAndLimits: string; readonly roleAndPrivileges: string; readonly proxiesSettings: string; readonly unprivilegedMode: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,

4
api_docs/plugin_directory.mdx
View file

@ -21,7 +21,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| API Count | Any Count | Missing comments | Missing exports |
|--------------|----------|-----------------|--------|
| 49599 | 238 | 37841 | 1886 |
| 49602 | 238 | 37843 | 1887 |
## Plugin Directory
@ -117,7 +117,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibIngestPipelinesPluginApi" text="ingestPipelines"/> | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 4 | 0 | 4 | 0 |
| inputControlVis | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds Input Control visualization to Kibana | 0 | 0 | 0 | 0 |
| <DocLink id="kibInspectorPluginApi" text="inspector"/> | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | - | 127 | 2 | 100 | 4 |
| <DocLink id="kibIntegrationAssistantPluginApi" text="integrationAssistant"/> | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | Plugin implementing the Integration Assistant API and UI | 44 | 0 | 38 | 2 |
| <DocLink id="kibIntegrationAssistantPluginApi" text="integrationAssistant"/> | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | Plugin implementing the Integration Assistant API and UI | 47 | 0 | 40 | 3 |
| <DocLink id="kibInteractiveSetupPluginApi" text="interactiveSetup"/> | [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides UI and APIs for the interactive setup mode. | 28 | 0 | 18 | 0 |
| <DocLink id="kibInvestigatePluginApi" text="investigate"/> | [@elastic/obs-ai-assistant](https://github.com/orgs/elastic/teams/obs-ai-assistant) | - | 95 | 0 | 95 | 4 |
| <DocLink id="kibKibanaOverviewPluginApi" text="kibanaOverview"/> | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 6 | 0 | 6 | 0 |