* update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # api_docs/core.json # api_docs/core_application.json # api_docs/core_http.json # api_docs/core_saved_objects.json
715 lines
34 KiB
JSON
715 lines
34 KiB
JSON
{
|
|
"id": "eventLog",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-server.IEventLogger",
|
|
"type": "Interface",
|
|
"label": "IEventLogger",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"id": "def-server.IEventLogger.logEvent",
|
|
"type": "Function",
|
|
"label": "logEvent",
|
|
"signature": [
|
|
"(properties: DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "properties",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 53,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L53"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 53,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L53"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.IEventLogger.startTiming",
|
|
"type": "Function",
|
|
"label": "startTiming",
|
|
"signature": [
|
|
"(event: DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "event",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 54,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L54"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 54,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L54"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.IEventLogger.stopTiming",
|
|
"type": "Function",
|
|
"label": "stopTiming",
|
|
"signature": [
|
|
"(event: DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "event",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 55,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L55"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 55,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L55"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 52,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L52"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.IEventLogClient",
|
|
"type": "Interface",
|
|
"label": "IEventLogClient",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"id": "def-server.IEventLogClient.findEventsBySavedObjectIds",
|
|
"type": "Function",
|
|
"label": "findEventsBySavedObjectIds",
|
|
"signature": [
|
|
"(type: string, ids: string[], options?: Partial<",
|
|
{
|
|
"pluginId": "eventLog",
|
|
"scope": "server",
|
|
"docId": "kibEventLogPluginApi",
|
|
"section": "def-server.FindOptionsType",
|
|
"text": "FindOptionsType"
|
|
},
|
|
"> | undefined) => Promise<",
|
|
{
|
|
"pluginId": "eventLog",
|
|
"scope": "server",
|
|
"docId": "kibEventLogPluginApi",
|
|
"section": "def-server.QueryEventsBySavedObjectResult",
|
|
"text": "QueryEventsBySavedObjectResult"
|
|
},
|
|
">"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "type",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 46,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L46"
|
|
}
|
|
},
|
|
{
|
|
"type": "Array",
|
|
"label": "ids",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 47,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L47"
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "options",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "eventLog",
|
|
"scope": "server",
|
|
"docId": "kibEventLogPluginApi",
|
|
"section": "def-server.FindOptionsType",
|
|
"text": "FindOptionsType"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 48,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L48"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 45,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L45"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 44,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L44"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.QueryEventsBySavedObjectResult",
|
|
"type": "Interface",
|
|
"label": "QueryEventsBySavedObjectResult",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.QueryEventsBySavedObjectResult.page",
|
|
"type": "number",
|
|
"label": "page",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L35"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.QueryEventsBySavedObjectResult.per_page",
|
|
"type": "number",
|
|
"label": "per_page",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
|
|
"lineNumber": 36,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L36"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.QueryEventsBySavedObjectResult.total",
|
|
"type": "number",
|
|
"label": "total",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
|
|
"lineNumber": 37,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L37"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.QueryEventsBySavedObjectResult.data",
|
|
"type": "Array",
|
|
"label": "data",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
|
|
"lineNumber": 38,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L38"
|
|
},
|
|
"signature": [
|
|
"(Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L34"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"id": "def-server.IEvent",
|
|
"type": "Type",
|
|
"label": "IEvent",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/generated/schemas.ts",
|
|
"lineNumber": 26,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/generated/schemas.ts#L26"
|
|
},
|
|
"signature": [
|
|
"undefined | DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.IValidatedEvent",
|
|
"type": "Type",
|
|
"label": "IValidatedEvent",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/generated/schemas.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/generated/schemas.ts#L25"
|
|
},
|
|
"signature": [
|
|
"undefined | Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.SAVED_OBJECT_REL_PRIMARY",
|
|
"type": "string",
|
|
"label": "SAVED_OBJECT_REL_PRIMARY",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 18,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L18"
|
|
},
|
|
"signature": [
|
|
"\"primary\""
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-server.IEventLogService",
|
|
"type": "Interface",
|
|
"label": "IEventLogService",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"id": "def-server.IEventLogService.isEnabled",
|
|
"type": "Function",
|
|
"label": "isEnabled",
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L30"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.IEventLogService.isLoggingEntries",
|
|
"type": "Function",
|
|
"label": "isLoggingEntries",
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 31,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L31"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.IEventLogService.isIndexingEntries",
|
|
"type": "Function",
|
|
"label": "isIndexingEntries",
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 32,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L32"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.IEventLogService.registerProviderActions",
|
|
"type": "Function",
|
|
"label": "registerProviderActions",
|
|
"signature": [
|
|
"(provider: string, actions: string[]) => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "provider",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 33,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L33"
|
|
}
|
|
},
|
|
{
|
|
"type": "Array",
|
|
"label": "actions",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 33,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L33"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 33,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L33"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.IEventLogService.isProviderActionRegistered",
|
|
"type": "Function",
|
|
"label": "isProviderActionRegistered",
|
|
"signature": [
|
|
"(provider: string, action: string) => boolean"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "provider",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L34"
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "action",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L34"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L34"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.IEventLogService.getProviderActions",
|
|
"type": "Function",
|
|
"label": "getProviderActions",
|
|
"signature": [
|
|
"() => Map<string, Set<string>>"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L35"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.IEventLogService.registerSavedObjectProvider",
|
|
"type": "Function",
|
|
"label": "registerSavedObjectProvider",
|
|
"signature": [
|
|
"(type: string, provider: ",
|
|
{
|
|
"pluginId": "eventLog",
|
|
"scope": "server",
|
|
"docId": "kibEventLogPluginApi",
|
|
"section": "def-server.SavedObjectProvider",
|
|
"text": "SavedObjectProvider"
|
|
},
|
|
") => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "type",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 36,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L36"
|
|
}
|
|
},
|
|
{
|
|
"type": "Function",
|
|
"label": "provider",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "eventLog",
|
|
"scope": "server",
|
|
"docId": "kibEventLogPluginApi",
|
|
"section": "def-server.SavedObjectProvider",
|
|
"text": "SavedObjectProvider"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 36,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L36"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 36,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L36"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.IEventLogService.getLogger",
|
|
"type": "Function",
|
|
"label": "getLogger",
|
|
"signature": [
|
|
"(properties: DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => ",
|
|
{
|
|
"pluginId": "eventLog",
|
|
"scope": "server",
|
|
"docId": "kibEventLogPluginApi",
|
|
"section": "def-server.IEventLogger",
|
|
"text": "IEventLogger"
|
|
}
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "properties",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"DeepPartial<DeepWriteable<Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 37,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L37"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 37,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L37"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 29,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L29"
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"id": "def-server.IEventLogClientService",
|
|
"type": "Interface",
|
|
"label": "IEventLogClientService",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"id": "def-server.IEventLogClientService.getClient",
|
|
"type": "Function",
|
|
"label": "getClient",
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => ",
|
|
{
|
|
"pluginId": "eventLog",
|
|
"scope": "server",
|
|
"docId": "kibEventLogPluginApi",
|
|
"section": "def-server.IEventLogClient",
|
|
"text": "IEventLogClient"
|
|
}
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "request",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 41,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L41"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 41,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L41"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/server/types.ts",
|
|
"lineNumber": 40,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/server/types.ts#L40"
|
|
},
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.BASE_EVENT_LOG_API_PATH",
|
|
"type": "string",
|
|
"label": "BASE_EVENT_LOG_API_PATH",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/event_log/common/index.ts",
|
|
"lineNumber": 8,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/event_log/common/index.ts#L8"
|
|
},
|
|
"signature": [
|
|
"\"/api/event_log\""
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |