Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
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-02-28
date: 2023-03-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-02-28
date: 2023-03-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-02-28
date: 2023-03-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-02-28
date: 2023-03-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-02-28
date: 2023-03-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
---
import apmObj from './apm.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-02-28
date: 2023-03-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-02-28
date: 2023-03-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-02-28
date: 2023-03-01
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-02-28
date: 2023-03-01
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-02-28
date: 2023-03-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-02-28
date: 2023-03-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-02-28
date: 2023-03-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_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-02-28
date: 2023-03-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
---
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';
Expand Down
241 changes: 235 additions & 6 deletions api_docs/cloud_defend.devdocs.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,198 @@
"id": "cloudDefend",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"functions": [
{
"parentPluginId": "cloudDefend",
"id": "def-public.getSecuritySolutionLink",
"type": "Function",
"tags": [],
"label": "getSecuritySolutionLink",
"description": [
"\nGets the cloud_defend link properties of a Cloud Defend page for navigation in the security solution."
],
"signature": [
"<TId extends string = \"cloud_defend-policies\">(cloudDefendPage: \"policies\") => CloudDefendLinkItem<TId>"
],
"path": "x-pack/plugins/cloud_defend/public/common/navigation/security_solution_links.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cloudDefend",
"id": "def-public.getSecuritySolutionLink.$1",
"type": "string",
"tags": [],
"label": "cloudDefendPage",
"description": [
"the name of the cloud defend page."
],
"signature": [
"\"policies\""
],
"path": "x-pack/plugins/cloud_defend/public/common/navigation/security_solution_links.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cloudDefend",
"id": "def-public.getSecuritySolutionNavTab",
"type": "Function",
"tags": [],
"label": "getSecuritySolutionNavTab",
"description": [
"\nGets the link properties of a Cloud Defend page for navigation in the old security solution navigation."
],
"signature": [
"<TId extends string = \"cloud_defend-policies\">(cloudDefendPage: \"policies\", basePath: string) => CloudDefendNavTab<TId>"
],
"path": "x-pack/plugins/cloud_defend/public/common/navigation/security_solution_links.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cloudDefend",
"id": "def-public.getSecuritySolutionNavTab.$1",
"type": "string",
"tags": [],
"label": "cloudDefendPage",
"description": [
"the name of the cloud defend page."
],
"signature": [
"\"policies\""
],
"path": "x-pack/plugins/cloud_defend/public/common/navigation/security_solution_links.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "cloudDefend",
"id": "def-public.getSecuritySolutionNavTab.$2",
"type": "string",
"tags": [],
"label": "basePath",
"description": [
"the base path for links."
],
"signature": [
"string"
],
"path": "x-pack/plugins/cloud_defend/public/common/navigation/security_solution_links.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "cloudDefend",
"id": "def-public.CloudDefendSecuritySolutionContext",
"type": "Interface",
"tags": [],
"label": "CloudDefendSecuritySolutionContext",
"description": [],
"path": "x-pack/plugins/cloud_defend/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cloudDefend",
"id": "def-public.CloudDefendSecuritySolutionContext.getFiltersGlobalComponent",
"type": "Function",
"tags": [],
"label": "getFiltersGlobalComponent",
"description": [
"Gets the `FiltersGlobal` component for embedding a filter bar in the security solution application."
],
"signature": [
"() => React.ComponentType<{ children: React.ReactNode; }>"
],
"path": "x-pack/plugins/cloud_defend/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "cloudDefend",
"id": "def-public.CloudDefendSecuritySolutionContext.getSpyRouteComponent",
"type": "Function",
"tags": [],
"label": "getSpyRouteComponent",
"description": [
"Gets the `SpyRoute` component for navigation highlighting and breadcrumbs."
],
"signature": [
"() => React.ComponentType<{ pageName: \"cloud_defend-policies\"; state?: Record<string, string | undefined> | undefined; }>"
],
"path": "x-pack/plugins/cloud_defend/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"misc": [
{
"parentPluginId": "cloudDefend",
"id": "def-public.CLOUD_DEFEND_BASE_PATH",
"type": "string",
"tags": [],
"label": "CLOUD_DEFEND_BASE_PATH",
"description": [
"The base path for all cloud defend pages."
],
"signature": [
"\"/cloud_defend\""
],
"path": "x-pack/plugins/cloud_defend/public/common/navigation/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cloudDefend",
"id": "def-public.CloudDefendPageId",
"type": "Type",
"tags": [],
"label": "CloudDefendPageId",
"description": [
"\nAll the IDs for the cloud defend pages.\nThis needs to match the cloud defend page entries in `SecurityPageName` in `x-pack/plugins/security_solution/common/constants.ts`."
],
"signature": [
"\"cloud_defend-policies\""
],
"path": "x-pack/plugins/cloud_defend/public/common/navigation/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "cloudDefend",
"id": "def-public.CloudDefendPluginSetup",
"type": "Interface",
"tags": [],
"label": "CloudDefendPluginSetup",
"description": [],
"description": [
"\ncloud_defend plugin types"
],
"path": "x-pack/plugins/cloud_defend/public/types.ts",
"deprecated": false,
"trackAdoption": false,
Expand All @@ -31,7 +211,28 @@
"path": "x-pack/plugins/cloud_defend/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"children": [
{
"parentPluginId": "cloudDefend",
"id": "def-public.CloudDefendPluginStart.getCloudDefendRouter",
"type": "Function",
"tags": [],
"label": "getCloudDefendRouter",
"description": [
"Gets the cloud defend router component for embedding in the security solution."
],
"signature": [
"() => React.ComponentType<",
"CloudDefendRouterProps",
">"
],
"path": "x-pack/plugins/cloud_defend/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"lifecycle": "start",
"initialIsOpen": true
}
Expand All @@ -42,7 +243,35 @@
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
"objects": [],
"setup": {
"parentPluginId": "cloudDefend",
"id": "def-server.CloudDefendPluginSetup",
"type": "Interface",
"tags": [],
"label": "CloudDefendPluginSetup",
"description": [],
"path": "x-pack/plugins/cloud_defend/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "cloudDefend",
"id": "def-server.CloudDefendPluginStart",
"type": "Interface",
"tags": [],
"label": "CloudDefendPluginStart",
"description": [],
"path": "x-pack/plugins/cloud_defend/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
Expand Down
Loading