Skip to content

Commit

Permalink
[api-docs] 2023-08-15 Daily api_docs build (#163906)
Browse files Browse the repository at this point in the history 
Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/430
  • Loading branch information
@kibanamachine
kibanamachine authored Aug 15, 2023
1 parent fd3df5e commit 3640633
Show file tree
Hide file tree
Showing 617 changed files with 5,853 additions and 17,651 deletions.
2 changes: 1 addition & 1 deletion api_docs/actions.mdx
View file
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-14
date: 2023-08-15
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
---
import actionsObj from './actions.devdocs.json';
Expand Down
314 changes: 25 additions & 289 deletions api_docs/advanced_settings.devdocs.json
View file
Original file line number Diff line number Diff line change
@@ -1,261 +1,7 @@
{
"id": "advancedSettings",
"client": {
"classes": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry",
"type": "Class",
"tags": [],
"label": "ComponentRegistry",
"description": [],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.componentType",
"type": "Object",
"tags": [],
"label": "componentType",
"description": [],
"signature": [
"{ [key: string]: Id; }"
],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.defaultRegistry",
"type": "Object",
"tags": [],
"label": "defaultRegistry",
"description": [],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_title",
"type": "Function",
"tags": [],
"label": "advanced_settings_page_title",
"description": [],
"signature": [
"() => JSX.Element"
],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_subtitle",
"type": "Function",
"tags": [],
"label": "advanced_settings_page_subtitle",
"description": [],
"signature": [
"() => null"
],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_footer",
"type": "Function",
"tags": [],
"label": "advanced_settings_page_footer",
"description": [],
"signature": [
"() => null"
],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": []
}
]
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.registry",
"type": "Object",
"tags": [],
"label": "registry",
"description": [],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": []
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.setup",
"type": "Object",
"tags": [],
"label": "setup",
"description": [],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.setup.componentType",
"type": "Object",
"tags": [],
"label": "componentType",
"description": [],
"signature": [
"{ [key: string]: Id; }"
],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.setup.register",
"type": "Function",
"tags": [],
"label": "register",
"description": [
"/**\n * Attempts to register the provided component, with the ability to optionally allow\n * the component to override an existing one.\n *\n * If the intent is to override, then `allowOverride` must be set to true, otherwise an exception is thrown.\n *\n * @param id the id of the component to register\n * @param component the component\n * @param allowOverride (default: false) - optional flag to allow this component to override a previously registered component\n */"
],
"signature": [
"(id: Id, component: RegistryComponent, allowOverride?: boolean) => void"
],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.setup.register.$1",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"Id"
],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.setup.register.$2",
"type": "CompoundType",
"tags": [],
"label": "component",
"description": [],
"signature": [
"RegistryComponent"
],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.setup.register.$3",
"type": "boolean",
"tags": [],
"label": "allowOverride",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
]
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.start",
"type": "Object",
"tags": [],
"label": "start",
"description": [],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.start.componentType",
"type": "Object",
"tags": [],
"label": "componentType",
"description": [],
"signature": [
"{ [key: string]: Id; }"
],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.start.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [
"/**\n * Retrieve a registered component by its ID.\n * If the component does not exist, then an exception is thrown.\n *\n * @param id the ID of the component to retrieve\n */"
],
"signature": [
"(id: Id) => RegistryComponent"
],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.ComponentRegistry.start.get.$1",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"Id"
],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
]
}
],
"initialIsOpen": false
}
],
"classes": [],
"functions": [
{
"parentPluginId": "advancedSettings",
Expand Down Expand Up @@ -537,58 +283,48 @@
"setup": {
"parentPluginId": "advancedSettings",
"id": "def-public.AdvancedSettingsSetup",
"type": "Interface",
"type": "Type",
"tags": [],
"label": "AdvancedSettingsSetup",
"description": [],
"signature": [
"{ addSpaceSection: (Component: RegistryComponent, queryMatch: QueryMatchFn) => void; addGlobalSection: (Component: RegistryComponent, queryMatch: QueryMatchFn) => void; }"
],
"path": "src/plugins/advanced_settings/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.AdvancedSettingsSetup.component",
"type": "Object",
"tags": [],
"label": "component",
"description": [],
"signature": [
"{ componentType: { [key: string]: Id; }; register: (id: Id, component: RegistryComponent, allowOverride?: boolean) => void; }"
],
"path": "src/plugins/advanced_settings/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "advancedSettings",
"id": "def-public.AdvancedSettingsStart",
"type": "Interface",
"type": "Type",
"tags": [],
"label": "AdvancedSettingsStart",
"description": [],
"signature": [
"{ getGlobalSections: () => ",
{
"pluginId": "@kbn/management-settings-section-registry",
"scope": "common",
"docId": "kibKbnManagementSettingsSectionRegistryPluginApi",
"section": "def-common.RegistryEntry",
"text": "RegistryEntry"
},
"[]; getSpacesSections: () => ",
{
"pluginId": "@kbn/management-settings-section-registry",
"scope": "common",
"docId": "kibKbnManagementSettingsSectionRegistryPluginApi",
"section": "def-common.RegistryEntry",
"text": "RegistryEntry"
},
"[]; }"
],
"path": "src/plugins/advanced_settings/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.AdvancedSettingsStart.component",
"type": "Object",
"tags": [],
"label": "component",
"description": [],
"signature": [
"{ componentType: { [key: string]: Id; }; get: (id: Id) => RegistryComponent; }"
],
"path": "src/plugins/advanced_settings/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
Expand Down
9 changes: 3 additions & 6 deletions api_docs/advanced_settings.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ 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-14
date: 2023-08-15
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
---
import advancedSettingsObj from './advanced_settings.devdocs.json';



Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) for questions regarding this plugin.
Contact [@elastic/appex-sharedux @elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/appex-sharedux ) for questions regarding this plugin.

**Code health stats**

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 36 | 1 | 32 | 2 |
| 17 | 1 | 15 | 2 |

## Client

Expand All @@ -34,9 +34,6 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh
### Functions
<DocDefinitionList data={advancedSettingsObj.client.functions}/>

### Classes
<DocDefinitionList data={advancedSettingsObj.client.classes}/>

### Interfaces
<DocDefinitionList data={advancedSettingsObj.client.interfaces}/>

2 changes: 1 addition & 1 deletion api_docs/aiops.mdx
View file
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-14
date: 2023-08-15
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
---
import aiopsObj from './aiops.devdocs.json';
Expand Down
Loading

0 comments on commit 3640633

Please sign in to comment.