api doc files

api_docs/actions.mdx

@@ -0,0 +1,32 @@
+---
+id: kibActionsPluginApi
+slug: /kibana-dev-docs/actionsPluginApi
+title: actions
+image: https://source.unsplash.com/400x175/?github
+summary: API docs for the actions plugin
+date: 2020-11-16
+tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
+---
+
+import actionsObj from './actions.json';
+
+## Server
+
+### Setup
+<DocDefinitionList data={[actionsObj.server.setup]}/>
+### Start
+<DocDefinitionList data={[actionsObj.server.start]}/>
+### Functions
+<DocDefinitionList data={actionsObj.server.functions}/>
+### Interfaces
+<DocDefinitionList data={actionsObj.server.interfaces}/>
+### Consts, variables and types
+<DocDefinitionList data={actionsObj.server.misc}/>
+## Common
+
+### Functions
+<DocDefinitionList data={actionsObj.common.functions}/>
+### Interfaces
+<DocDefinitionList data={actionsObj.common.interfaces}/>
+### Consts, variables and types
+<DocDefinitionList data={actionsObj.common.misc}/>

api_docs/advanced_settings.json

@@ -0,0 +1 @@
+{"id":"advancedSettings","client":{"classes":[{"id":"def-public.ComponentRegistry","type":"Class","label":"ComponentRegistry","description":[],"children":[{"id":"def-public.ComponentRegistry.componentType","type":"Object","label":"componentType","description":[],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L28"},"signature":["{ [key: string]: Id; }"]},{"id":"def-public.ComponentRegistry.defaultRegistry","type":"Object","children":[{"id":"def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_title","type":"Function","label":"advanced_settings_page_title","description":[],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L30"},"signature":["() => JSX.Element"]},{"id":"def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_subtitle","type":"Function","label":"advanced_settings_page_subtitle","description":[],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L31"},"signature":["() => null"]},{"id":"def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_footer","type":"Function","label":"advanced_settings_page_footer","description":[],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L32"},"signature":["() => null"]}],"description":[],"label":"defaultRegistry","source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L29"}},{"id":"def-public.ComponentRegistry.registry","type":"Object","children":[],"description":[],"label":"registry","source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L35"}},{"id":"def-public.ComponentRegistry.setup","type":"Object","children":[{"id":"def-public.ComponentRegistry.setup.componentType","type":"Object","label":"componentType","description":[],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L72"},"signature":["{ [key: string]: Id; }"]},{"id":"def-public.ComponentRegistry.setup.register","type":"Function","label":"register","description":[],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L73"},"signature":["(id: Id, component: React.ComponentType<Record<string, any> | undefined>, allowOverride?: boolean) => void"]}],"description":[],"label":"setup","source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L71"}},{"id":"def-public.ComponentRegistry.start","type":"Object","children":[{"id":"def-public.ComponentRegistry.start.componentType","type":"Object","label":"componentType","description":[],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L77"},"signature":["{ [key: string]: Id; }"]},{"id":"def-public.ComponentRegistry.start.get","type":"Function","label":"get","description":[],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L78"},"signature":["(id: Id) => React.ComponentType<Record<string, any> | undefined>"]}],"description":[],"label":"start","source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L76"}}],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L27"},"initialIsOpen":false}],"functions":[{"id":"def-public.LazyField","type":"Function","label":"LazyField","description":["\nExports the field component as a React.lazy component. We're explicitly naming it lazy here\nso any plugin that would import that can clearly see it's lazy loaded and can only be used\ninside a suspense context."],"source":{"path":"src/plugins/advanced_settings/public/index.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/index.ts#L20"},"signature":["React.LazyExoticComponent<typeof ","Field",">"],"initialIsOpen":false}],"interfaces":[],"enums":[],"misc":[],"objects":[],"setup":{"id":"def-public.AdvancedSettingsSetup","type":"Interface","label":"AdvancedSettingsSetup","description":[],"children":[{"id":"def-public.AdvancedSettingsSetup.component","type":"Object","label":"component","description":[],"source":{"path":"src/plugins/advanced_settings/public/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L16"},"signature":["{ componentType: { [key: string]: Id; }; register: (id: Id, component: React.ComponentType<Record<string, any> | undefined>, allowOverride?: boolean) => void; }"]}],"source":{"path":"src/plugins/advanced_settings/public/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L15"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-public.AdvancedSettingsStart","type":"Interface","label":"AdvancedSettingsStart","description":[],"children":[{"id":"def-public.AdvancedSettingsStart.component","type":"Object","label":"component","description":[],"source":{"path":"src/plugins/advanced_settings/public/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L19"},"signature":["{ componentType: { [key: string]: Id; }; get: (id: Id) => React.ComponentType<Record<string, any> | undefined>; }"]}],"source":{"path":"src/plugins/advanced_settings/public/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L18"},"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}}

api_docs/advanced_settings.mdx

@@ -0,0 +1,22 @@
+---
+id: kibAdvancedSettingsPluginApi
+slug: /kibana-dev-docs/advancedSettingsPluginApi
+title: advancedSettings
+image: https://source.unsplash.com/400x175/?github
+summary: API docs for the advancedSettings plugin
+date: 2020-11-16
+tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
+---
+
+import advancedSettingsObj from './advanced_settings.json';
+
+## Client
+
+### Setup
+<DocDefinitionList data={[advancedSettingsObj.client.setup]}/>
+### Start
+<DocDefinitionList data={[advancedSettingsObj.client.start]}/>
+### Functions
+<DocDefinitionList data={advancedSettingsObj.client.functions}/>
+### Classes
+<DocDefinitionList data={advancedSettingsObj.client.classes}/>

api_docs/alerts.mdx

@@ -0,0 +1,38 @@
+---
+id: kibAlertsPluginApi
+slug: /kibana-dev-docs/alertsPluginApi
+title: alerts
+image: https://source.unsplash.com/400x175/?github
+summary: API docs for the alerts plugin
+date: 2020-11-16
+tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerts']
+---
+
+import alertsObj from './alerts.json';
+
+## Client
+
+### Setup
+<DocDefinitionList data={[alertsObj.client.setup]}/>
+### Start
+<DocDefinitionList data={[alertsObj.client.start]}/>
+## Server
+
+### Functions
+<DocDefinitionList data={alertsObj.server.functions}/>
+### Interfaces
+<DocDefinitionList data={alertsObj.server.interfaces}/>
+### Consts, variables and types
+<DocDefinitionList data={alertsObj.server.misc}/>
+## Common
+
+### Objects
+<DocDefinitionList data={alertsObj.common.objects}/>
+### Functions
+<DocDefinitionList data={alertsObj.common.functions}/>
+### Interfaces
+<DocDefinitionList data={alertsObj.common.interfaces}/>
+### Enums
+<DocDefinitionList data={alertsObj.common.enums}/>
+### Consts, variables and types
+<DocDefinitionList data={alertsObj.common.misc}/>

api_docs/apm.mdx

@@ -0,0 +1,30 @@
+---
+id: kibApmPluginApi
+slug: /kibana-dev-docs/apmPluginApi
+title: apm
+image: https://source.unsplash.com/400x175/?github
+summary: API docs for the apm plugin
+date: 2020-11-16
+tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
+---
+
+import apmObj from './apm.json';
+
+## Client
+
+### Start
+<DocDefinitionList data={[apmObj.client.start]}/>
+### Interfaces
+<DocDefinitionList data={apmObj.client.interfaces}/>
+## Server
+
+### Setup
+<DocDefinitionList data={[apmObj.server.setup]}/>
+### Functions
+<DocDefinitionList data={apmObj.server.functions}/>
+### Classes
+<DocDefinitionList data={apmObj.server.classes}/>
+### Enums
+<DocDefinitionList data={apmObj.server.enums}/>
+### Consts, variables and types
+<DocDefinitionList data={apmObj.server.misc}/>

api_docs/apm_oss.mdx

@@ -0,0 +1,28 @@
+---
+id: kibApmOssPluginApi
+slug: /kibana-dev-docs/apmOssPluginApi
+title: apmOss
+image: https://source.unsplash.com/400x175/?github
+summary: API docs for the apmOss plugin
+date: 2020-11-16
+tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmOss']
+---
+
+import apmOssObj from './apm_oss.json';
+
+## Client
+
+### Setup
+<DocDefinitionList data={[apmOssObj.client.setup]}/>
+### Start
+<DocDefinitionList data={[apmOssObj.client.start]}/>
+### Consts, variables and types
+<DocDefinitionList data={apmOssObj.client.misc}/>
+## Server
+
+### Setup
+<DocDefinitionList data={[apmOssObj.server.setup]}/>
+### Functions
+<DocDefinitionList data={apmOssObj.server.functions}/>
+### Consts, variables and types
+<DocDefinitionList data={apmOssObj.server.misc}/>

api_docs/banners.json

@@ -0,0 +1 @@
+{"id":"banners","client":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[{"id":"def-common.BannerInfoResponse","type":"Interface","label":"BannerInfoResponse","description":[],"children":[{"id":"def-common.BannerInfoResponse.allowed","type":"boolean","label":"allowed","description":[],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L9"}},{"id":"def-common.BannerInfoResponse.banner","type":"Object","label":"banner","description":[],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L10"},"signature":[{"pluginId":"banners","scope":"common","docId":"kibBannersPluginApi","section":"def-common.BannerConfiguration","text":"BannerConfiguration"}]}],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L8"},"initialIsOpen":false},{"id":"def-common.BannerConfiguration","type":"Interface","label":"BannerConfiguration","description":[],"children":[{"id":"def-common.BannerConfiguration.placement","type":"CompoundType","label":"placement","description":[],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L16"},"signature":[{"pluginId":"banners","scope":"common","docId":"kibBannersPluginApi","section":"def-common.BannerPlacement","text":"BannerPlacement"}]},{"id":"def-common.BannerConfiguration.textContent","type":"string","label":"textContent","description":[],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L17"}},{"id":"def-common.BannerConfiguration.textColor","type":"string","label":"textColor","description":[],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L18"}},{"id":"def-common.BannerConfiguration.backgroundColor","type":"string","label":"backgroundColor","description":[],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L19"}}],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L15"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-common.BannerPlacement","type":"Type","label":"BannerPlacement","description":[],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L13"},"signature":["\"disabled\" | \"header\""],"initialIsOpen":false}],"objects":[]}}

api_docs/banners.mdx

@@ -0,0 +1,18 @@
+---
+id: kibBannersPluginApi
+slug: /kibana-dev-docs/bannersPluginApi
+title: banners
+image: https://source.unsplash.com/400x175/?github
+summary: API docs for the banners plugin
+date: 2020-11-16
+tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
+---
+
+import bannersObj from './banners.json';
+
+## Common
+
+### Interfaces
+<DocDefinitionList data={bannersObj.common.interfaces}/>
+### Consts, variables and types
+<DocDefinitionList data={bannersObj.common.misc}/>

api_docs/beats_management.json

@@ -0,0 +1 @@
+{"id":"beatsManagement","client":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[{"id":"def-common.BeatsManagementConfigType","type":"Type","label":"BeatsManagementConfigType","description":[],"source":{"path":"x-pack/plugins/beats_management/common/index.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/beats_management/common/index.ts#L23"},"signature":["{ readonly enabled: boolean; readonly defaultUserRoles: string[]; readonly encryptionKey: string; readonly enrollmentTokensTtlInSeconds: number; }"],"initialIsOpen":false}],"objects":[{"id":"def-common.beatsManagementConfigSchema","type":"Object","label":"beatsManagementConfigSchema","description":[],"source":{"path":"x-pack/plugins/beats_management/common/index.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/beats_management/common/index.ts#L12"},"signature":["ObjectType","<{ enabled: ","Type","<boolean>; defaultUserRoles: ","Type","<string[]>; encryptionKey: ","Type","<string>; enrollmentTokensTtlInSeconds: ","Type"],"initialIsOpen":false}]}}

api_docs/beats_management.mdx

@@ -0,0 +1,18 @@
+---
+id: kibBeatsManagementPluginApi
+slug: /kibana-dev-docs/beatsManagementPluginApi
+title: beatsManagement
+image: https://source.unsplash.com/400x175/?github
+summary: API docs for the beatsManagement plugin
+date: 2020-11-16
+tags: ['contributor', 'dev', 'apidocs', 'kibana', 'beatsManagement']
+---
+
+import beatsManagementObj from './beats_management.json';
+
+## Common
+
+### Objects
+<DocDefinitionList data={beatsManagementObj.common.objects}/>
+### Consts, variables and types
+<DocDefinitionList data={beatsManagementObj.common.misc}/>

api_docs/bfetch.mdx

@@ -0,0 +1,38 @@
+---
+id: kibBfetchPluginApi
+slug: /kibana-dev-docs/bfetchPluginApi
+title: bfetch
+image: https://source.unsplash.com/400x175/?github
+summary: API docs for the bfetch plugin
+date: 2020-11-16
+tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
+---
+
+import bfetchObj from './bfetch.json';
+
+## Client
+
+### Start
+<DocDefinitionList data={[bfetchObj.client.start]}/>
+### Functions
+<DocDefinitionList data={bfetchObj.client.functions}/>
+### Consts, variables and types
+<DocDefinitionList data={bfetchObj.client.misc}/>
+## Server
+
+### Setup
+<DocDefinitionList data={[bfetchObj.server.setup]}/>
+### Start
+<DocDefinitionList data={[bfetchObj.server.start]}/>
+### Interfaces
+<DocDefinitionList data={bfetchObj.server.interfaces}/>
+### Consts, variables and types
+<DocDefinitionList data={bfetchObj.server.misc}/>
+## Common
+
+### Functions
+<DocDefinitionList data={bfetchObj.common.functions}/>
+### Classes
+<DocDefinitionList data={bfetchObj.common.classes}/>
+### Interfaces
+<DocDefinitionList data={bfetchObj.common.interfaces}/>