mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
2d982c0070
* Support the docs scripts knowing which json files are specifically for dev docs. * Update jest snapshot docs * Update api docs
615 lines
No EOL
21 KiB
JSON
615 lines
No EOL
21 KiB
JSON
{
|
|
"id": "reporting",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"start": {
|
|
"parentPluginId": "reporting",
|
|
"id": "def-public.ReportingStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ReportingStart",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "public",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-public.ReportingSetup",
|
|
"text": "ReportingSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/public/index.ts",
|
|
"deprecated": false,
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "ReportingPlugin",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingPlugin",
|
|
"text": "ReportingPlugin"
|
|
},
|
|
" implements ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.Plugin",
|
|
"text": "Plugin"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingSetup",
|
|
"text": "ReportingSetup"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingSetup",
|
|
"text": "ReportingSetup"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingSetupDeps",
|
|
"text": "ReportingSetupDeps"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingStartDeps",
|
|
"text": "ReportingStartDeps"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "initContext",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.PluginInitializerContext",
|
|
"text": "PluginInitializerContext"
|
|
},
|
|
"<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; capture: Readonly<{} & { zoom: number; timeouts: Readonly<{} & { renderComplete: number | moment.Duration; openUrl: number | moment.Duration; waitForElements: number | moment.Duration; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { enabled: boolean; allow: string[]; }>; kibanaServer: Readonly<{ hostname?: string | undefined; protocol?: string | undefined; port?: number | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ",
|
|
"ByteSizeValue",
|
|
"; useByteOrderMarkEncoding: boolean; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>, plugins: ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingSetupDeps",
|
|
"text": "ReportingSetupDeps"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingSetup",
|
|
"text": "ReportingSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin.setup.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin.setup.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "plugins",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingSetupDeps",
|
|
"text": "ReportingSetupDeps"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
", plugins: ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingStartDeps",
|
|
"text": "ReportingStartDeps"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingSetup",
|
|
"text": "ReportingSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin.start.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingPlugin.start.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "plugins",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "reporting",
|
|
"scope": "server",
|
|
"docId": "kibReportingPluginApi",
|
|
"section": "def-server.ReportingStartDeps",
|
|
"text": "ReportingStartDeps"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetupDeps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ReportingSetupDeps",
|
|
"description": [],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetupDeps.eventLog",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "eventLog",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "eventLog",
|
|
"scope": "server",
|
|
"docId": "kibEventLogPluginApi",
|
|
"section": "def-server.IEventLogService",
|
|
"text": "IEventLogService"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetupDeps.features",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "features",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "features",
|
|
"scope": "server",
|
|
"docId": "kibFeaturesPluginApi",
|
|
"section": "def-server.PluginSetupContract",
|
|
"text": "PluginSetupContract"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetupDeps.screenshotMode",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "screenshotMode",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "screenshotMode",
|
|
"scope": "server",
|
|
"docId": "kibScreenshotModePluginApi",
|
|
"section": "def-server.ScreenshotModePluginSetup",
|
|
"text": "ScreenshotModePluginSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetupDeps.security",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "security",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "security",
|
|
"scope": "server",
|
|
"docId": "kibSecurityPluginApi",
|
|
"section": "def-server.SecurityPluginSetup",
|
|
"text": "SecurityPluginSetup"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetupDeps.spaces",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "spaces",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "server",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-server.SpacesPluginSetup",
|
|
"text": "SpacesPluginSetup"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetupDeps.taskManager",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "taskManager",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.TaskManagerSetupContract",
|
|
"text": "TaskManagerSetupContract"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetupDeps.usageCollection",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "usageCollection",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "server",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-server.UsageCollectionSetup",
|
|
"text": "UsageCollectionSetup"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingStartDeps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ReportingStartDeps",
|
|
"description": [],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingStartDeps.data",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-server.DataPluginStart",
|
|
"text": "DataPluginStart"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingStartDeps.fieldFormats",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "fieldFormats",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "server",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-server.FieldFormatsStart",
|
|
"text": "FieldFormatsStart"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingStartDeps.licensing",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "licensing",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "licensing",
|
|
"scope": "server",
|
|
"docId": "kibLicensingPluginApi",
|
|
"section": "def-server.LicensingPluginStart",
|
|
"text": "LicensingPluginStart"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingStartDeps.screenshotting",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "screenshotting",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "screenshotting",
|
|
"scope": "server",
|
|
"docId": "kibScreenshottingPluginApi",
|
|
"section": "def-server.ScreenshottingStart",
|
|
"text": "ScreenshottingStart"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingStartDeps.security",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "security",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "security",
|
|
"scope": "server",
|
|
"docId": "kibSecurityPluginApi",
|
|
"section": "def-server.SecurityPluginStart",
|
|
"text": "SecurityPluginStart"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingStartDeps.taskManager",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "taskManager",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
"TaskScheduling",
|
|
", \"schedule\" | \"runNow\" | \"ephemeralRunNow\" | \"ensureScheduled\"> & Pick<",
|
|
"TaskStore",
|
|
", \"remove\" | \"fetch\" | \"get\"> & { removeIfExists: (id: string) => Promise<void>; } & { supportsEphemeralTasks: () => boolean; }"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"start": {
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ReportingSetup",
|
|
"description": [],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "reporting",
|
|
"id": "def-server.ReportingSetup.usesUiCapabilities",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "usesUiCapabilities",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "x-pack/plugins/reporting/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |