Update API docs

This commit is contained in:
Jen Huang 2021-03-16 11:04:42 -07:00
parent afc91ce32f
commit b9770fdc56
5 changed files with 522 additions and 311 deletions

View file

@ -3805,7 +3805,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 340
"lineNumber": 342
}
}
],
@ -3813,7 +3813,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 339
"lineNumber": 341
}
},
{
@ -3847,7 +3847,7 @@
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 360
"lineNumber": 362
}
},
{
@ -3868,7 +3868,7 @@
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 360
"lineNumber": 362
}
}
],
@ -3876,7 +3876,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 360
"lineNumber": 362
}
},
{
@ -3902,7 +3902,7 @@
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 384
"lineNumber": 386
}
}
],
@ -3910,7 +3910,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 384
"lineNumber": 386
}
},
{
@ -3942,7 +3942,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 404
"lineNumber": 406
}
}
],
@ -3950,7 +3950,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 404
"lineNumber": 406
}
},
{
@ -3980,7 +3980,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 412
"lineNumber": 414
}
},
{
@ -3993,7 +3993,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 413
"lineNumber": 415
}
},
{
@ -4013,7 +4013,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 414
"lineNumber": 416
}
}
],
@ -4021,7 +4021,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 411
"lineNumber": 413
}
},
{
@ -4043,7 +4043,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 422
"lineNumber": 424
}
},
{
@ -4056,7 +4056,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 422
"lineNumber": 424
}
}
],
@ -4064,7 +4064,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 422
"lineNumber": 424
}
},
{
@ -4086,7 +4086,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 433
"lineNumber": 435
}
},
{
@ -4099,7 +4099,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 433
"lineNumber": 435
}
}
],
@ -4107,7 +4107,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 433
"lineNumber": 435
}
},
{
@ -4124,7 +4124,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 446
"lineNumber": 448
}
},
{
@ -4144,7 +4144,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 446
"lineNumber": 448
}
}
],
@ -4163,7 +4163,7 @@
"label": "setFieldFormat",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 446
"lineNumber": 448
},
"tags": [],
"returnComment": []
@ -4182,7 +4182,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 450
"lineNumber": 452
}
}
],
@ -4193,7 +4193,7 @@
"label": "deleteFieldFormat",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 450
"lineNumber": 452
},
"tags": [],
"returnComment": []
@ -15956,7 +15956,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 340
"lineNumber": 342
}
}
],
@ -15964,7 +15964,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 339
"lineNumber": 341
}
},
{
@ -15998,7 +15998,7 @@
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 360
"lineNumber": 362
}
},
{
@ -16019,7 +16019,7 @@
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 360
"lineNumber": 362
}
}
],
@ -16027,7 +16027,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 360
"lineNumber": 362
}
},
{
@ -16053,7 +16053,7 @@
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 384
"lineNumber": 386
}
}
],
@ -16061,7 +16061,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 384
"lineNumber": 386
}
},
{
@ -16093,7 +16093,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 404
"lineNumber": 406
}
}
],
@ -16101,7 +16101,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 404
"lineNumber": 406
}
},
{
@ -16131,7 +16131,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 412
"lineNumber": 414
}
},
{
@ -16144,7 +16144,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 413
"lineNumber": 415
}
},
{
@ -16164,7 +16164,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 414
"lineNumber": 416
}
}
],
@ -16172,7 +16172,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 411
"lineNumber": 413
}
},
{
@ -16194,7 +16194,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 422
"lineNumber": 424
}
},
{
@ -16207,7 +16207,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 422
"lineNumber": 424
}
}
],
@ -16215,7 +16215,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 422
"lineNumber": 424
}
},
{
@ -16237,7 +16237,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 433
"lineNumber": 435
}
},
{
@ -16250,7 +16250,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 433
"lineNumber": 435
}
}
],
@ -16258,7 +16258,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 433
"lineNumber": 435
}
},
{
@ -16275,7 +16275,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 446
"lineNumber": 448
}
},
{
@ -16295,7 +16295,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 446
"lineNumber": 448
}
}
],
@ -16314,7 +16314,7 @@
"label": "setFieldFormat",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 446
"lineNumber": 448
},
"tags": [],
"returnComment": []
@ -16333,7 +16333,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 450
"lineNumber": 452
}
}
],
@ -16344,7 +16344,7 @@
"label": "deleteFieldFormat",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 450
"lineNumber": 452
},
"tags": [],
"returnComment": []

View file

@ -1768,7 +1768,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 340
"lineNumber": 342
}
}
],
@ -1776,7 +1776,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 339
"lineNumber": 341
}
},
{
@ -1810,7 +1810,7 @@
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 360
"lineNumber": 362
}
},
{
@ -1831,7 +1831,7 @@
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 360
"lineNumber": 362
}
}
],
@ -1839,7 +1839,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 360
"lineNumber": 362
}
},
{
@ -1865,7 +1865,7 @@
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 384
"lineNumber": 386
}
}
],
@ -1873,7 +1873,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 384
"lineNumber": 386
}
},
{
@ -1905,7 +1905,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 404
"lineNumber": 406
}
}
],
@ -1913,7 +1913,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 404
"lineNumber": 406
}
},
{
@ -1943,7 +1943,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 412
"lineNumber": 414
}
},
{
@ -1956,7 +1956,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 413
"lineNumber": 415
}
},
{
@ -1976,7 +1976,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 414
"lineNumber": 416
}
}
],
@ -1984,7 +1984,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 411
"lineNumber": 413
}
},
{
@ -2006,7 +2006,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 422
"lineNumber": 424
}
},
{
@ -2019,7 +2019,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 422
"lineNumber": 424
}
}
],
@ -2027,7 +2027,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 422
"lineNumber": 424
}
},
{
@ -2049,7 +2049,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 433
"lineNumber": 435
}
},
{
@ -2062,7 +2062,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 433
"lineNumber": 435
}
}
],
@ -2070,7 +2070,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 433
"lineNumber": 435
}
},
{
@ -2087,7 +2087,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 446
"lineNumber": 448
}
},
{
@ -2107,7 +2107,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 446
"lineNumber": 448
}
}
],
@ -2126,7 +2126,7 @@
"label": "setFieldFormat",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 446
"lineNumber": 448
},
"tags": [],
"returnComment": []
@ -2145,7 +2145,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 450
"lineNumber": 452
}
}
],
@ -2156,7 +2156,7 @@
"label": "deleteFieldFormat",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"lineNumber": 450
"lineNumber": 452
},
"tags": [],
"returnComment": []

View file

@ -1699,7 +1699,7 @@
"children": [],
"source": {
"path": "x-pack/plugins/fleet/server/errors/index.ts",
"lineNumber": 34
"lineNumber": 37
},
"initialIsOpen": false
}
@ -2061,6 +2061,303 @@
},
"initialIsOpen": false
},
{
"id": "def-server.Artifact",
"type": "Interface",
"label": "Artifact",
"signature": [
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.Artifact",
"text": "Artifact"
},
" extends ",
"NewArtifact"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.Artifact.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 34
}
},
{
"tags": [],
"id": "def-server.Artifact.created",
"type": "string",
"label": "created",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 35
}
}
],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 33
},
"initialIsOpen": false
},
{
"id": "def-server.ArtifactsClientInterface",
"type": "Interface",
"label": "ArtifactsClientInterface",
"description": [
"\nThe interface exposed out of Fleet's Artifact service via the client class"
],
"tags": [],
"children": [
{
"id": "def-server.ArtifactsClientInterface.getArtifact",
"type": "Function",
"label": "getArtifact",
"signature": [
"(id: string) => Promise<",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.Artifact",
"text": "Artifact"
},
" | undefined>"
],
"description": [],
"children": [
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 68
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 68
}
},
{
"id": "def-server.ArtifactsClientInterface.createArtifact",
"type": "Function",
"label": "createArtifact",
"signature": [
"(options: ",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.ArtifactsClientCreateOptions",
"text": "ArtifactsClientCreateOptions"
},
") => Promise<",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.Artifact",
"text": "Artifact"
},
">"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.ArtifactsClientCreateOptions",
"text": "ArtifactsClientCreateOptions"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 69
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 69
}
},
{
"id": "def-server.ArtifactsClientInterface.deleteArtifact",
"type": "Function",
"label": "deleteArtifact",
"signature": [
"(id: string) => Promise<void>"
],
"description": [],
"children": [
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 70
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 70
}
},
{
"id": "def-server.ArtifactsClientInterface.listArtifacts",
"type": "Function",
"label": "listArtifacts",
"signature": [
"(options?: Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}> | undefined) => Promise<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.ListResult",
"text": "ListResult"
},
"<",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.Artifact",
"text": "Artifact"
},
">>"
],
"description": [],
"children": [
{
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
"Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}> | undefined"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 71
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 71
}
},
{
"id": "def-server.ArtifactsClientInterface.encodeContent",
"type": "Function",
"label": "encodeContent",
"signature": [
"(content: string) => Promise<Pick<",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.Artifact",
"text": "Artifact"
},
", \"body\" | \"decodedSha256\" | \"decodedSize\" | \"encodedSha256\" | \"encodedSize\" | \"compressionAlgorithm\">>"
],
"description": [],
"children": [
{
"type": "string",
"label": "content",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 72
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 72
}
},
{
"id": "def-server.ArtifactsClientInterface.generateHash",
"type": "Function",
"label": "generateHash",
"signature": [
"(content: string) => string"
],
"description": [],
"children": [
{
"type": "string",
"label": "content",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 73
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 73
}
}
],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 67
},
"initialIsOpen": false
},
{
"id": "def-server.ESIndexPatternService",
"type": "Interface",
@ -2164,7 +2461,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 91
"lineNumber": 93
},
"signature": [
{
@ -2184,7 +2481,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 92
"lineNumber": 94
},
"signature": [
{
@ -2205,7 +2502,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 93
"lineNumber": 95
},
"signature": [
{
@ -2226,7 +2523,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 94
"lineNumber": 96
},
"signature": [
{
@ -2246,7 +2543,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 95
"lineNumber": 97
},
"signature": [
{
@ -2267,7 +2564,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 96
"lineNumber": 98
},
"signature": [
"Pick<",
@ -2284,7 +2581,7 @@
],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 90
"lineNumber": 92
},
"initialIsOpen": false
},
@ -2384,7 +2681,7 @@
],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 134
"lineNumber": 138
},
"signature": [
"[\"packagePolicyCreate\", (newPackagePolicy: ",
@ -2438,7 +2735,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/index.ts",
"lineNumber": 76
"lineNumber": 78
},
"signature": [
"any"
@ -2486,7 +2783,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 119
"lineNumber": 123
},
"signature": [
"void"
@ -2511,7 +2808,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 158
"lineNumber": 162
},
"signature": [
{
@ -2531,7 +2828,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 159
"lineNumber": 163
},
"signature": [
{
@ -2551,7 +2848,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 160
"lineNumber": 164
},
"signature": [
{
@ -2573,7 +2870,7 @@
],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 164
"lineNumber": 168
},
"signature": [
{
@ -2593,7 +2890,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 165
"lineNumber": 169
},
"signature": [
{
@ -2615,7 +2912,7 @@
],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 170
"lineNumber": 174
},
"signature": [
"(...args: ",
@ -2628,11 +2925,34 @@
},
") => void"
]
},
{
"tags": [],
"id": "def-server.FleetStartContract.createArtifactsClient",
"type": "Function",
"label": "createArtifactsClient",
"description": [
"\nCreate a Fleet Artifact Client instance"
],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 180
},
"signature": [
"(packageName: string) => ",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.FleetArtifactsClient",
"text": "FleetArtifactsClient"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 157
"lineNumber": 161
},
"lifecycle": "start",
"initialIsOpen": true
@ -4134,59 +4454,44 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 86
"lineNumber": 91
}
},
{
"tags": [],
"id": "def-common.BulkInstallPackageInfo.newVersion",
"id": "def-common.BulkInstallPackageInfo.version",
"type": "string",
"label": "newVersion",
"label": "version",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 87
"lineNumber": 92
}
},
{
"tags": [],
"id": "def-common.BulkInstallPackageInfo.oldVersion",
"type": "CompoundType",
"label": "oldVersion",
"id": "def-common.BulkInstallPackageInfo.result",
"type": "Object",
"label": "result",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 89
},
"signature": [
"string | null"
]
},
{
"tags": [],
"id": "def-common.BulkInstallPackageInfo.assets",
"type": "Array",
"label": "assets",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 90
"lineNumber": 93
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AssetReference",
"text": "AssetReference"
},
"[]"
"section": "def-common.InstallResult",
"text": "InstallResult"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 85
"lineNumber": 90
},
"initialIsOpen": false
},
@ -4205,7 +4510,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 98
"lineNumber": 101
},
"signature": [
"{ packages: string[]; }"
@ -4214,7 +4519,7 @@
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 97
"lineNumber": 100
},
"initialIsOpen": false
},
@ -4233,7 +4538,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 94
"lineNumber": 97
},
"signature": [
"(",
@ -4258,7 +4563,7 @@
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 93
"lineNumber": 96
},
"initialIsOpen": false
},
@ -4883,7 +5188,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 108
"lineNumber": 111
},
"signature": [
"{ pkgkey: string; }"
@ -4892,7 +5197,7 @@
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 107
"lineNumber": 110
},
"initialIsOpen": false
},
@ -4911,7 +5216,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 114
"lineNumber": 117
},
"signature": [
{
@ -4927,7 +5232,7 @@
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 113
"lineNumber": 116
},
"initialIsOpen": false
},
@ -8257,6 +8562,55 @@
},
"initialIsOpen": false
},
{
"id": "def-common.InstallResult",
"type": "Interface",
"label": "InstallResult",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.InstallResult.assets",
"type": "Array",
"label": "assets",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 86
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AssetReference",
"text": "AssetReference"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.InstallResult.status",
"type": "CompoundType",
"label": "status",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 87
},
"signature": [
"\"installed\" | \"already_installed\""
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 85
},
"initialIsOpen": false
},
{
"id": "def-common.InstallScriptRequest",
"type": "Interface",
@ -8472,13 +8826,13 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 104
"lineNumber": 107
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 103
"lineNumber": 106
},
"initialIsOpen": false
},
@ -12804,6 +13158,21 @@
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.FLEET_SERVER_ARTIFACTS_INDEX",
"type": "string",
"label": "FLEET_SERVER_ARTIFACTS_INDEX",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/index.ts",
"lineNumber": 27
},
"signature": [
"\".fleet-artifacts\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.FLEET_SERVER_INDICES",
@ -12812,7 +13181,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/index.ts",
"lineNumber": 27
"lineNumber": 29
},
"signature": [
"string[]"
@ -12842,7 +13211,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"lineNumber": 13
"lineNumber": 12
},
"signature": [
"\"fleet_server\""
@ -12879,21 +13248,6 @@
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.INDEX_PATTERN_SAVED_OBJECT_TYPE",
"type": "string",
"label": "INDEX_PATTERN_SAVED_OBJECT_TYPE",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"lineNumber": 10
},
"signature": [
"\"index-pattern\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.INSTALL_SCRIPT_API_ROUTES",
@ -13093,7 +13447,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"lineNumber": 11
"lineNumber": 10
},
"signature": [
"60000"
@ -14076,7 +14430,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"lineNumber": 24
"lineNumber": 23
},
"signature": [
"{ readonly Input: \"input\"; }"
@ -14784,7 +15138,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"lineNumber": 28
"lineNumber": 27
},
"signature": [
"{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }"
@ -15114,7 +15468,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"lineNumber": 22
"lineNumber": 21
},
"signature": [
"{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }"
@ -15691,7 +16045,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"lineNumber": 33
"lineNumber": 32
},
"signature": [
"{ readonly Installed: \"installed\"; readonly NotInstalled: \"not_installed\"; }"
@ -16049,7 +16403,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"lineNumber": 15
"lineNumber": 14
},
"signature": [
"{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }"

View file

@ -16,7 +16,7 @@
"type": "Function",
"label": "addFilters",
"signature": [
"(filter: object) => void"
"(filter: object, actionId: string) => void"
],
"description": [],
"children": [
@ -32,6 +32,19 @@
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
"lineNumber": 32
}
},
{
"type": "string",
"label": "actionId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
"lineNumber": 32
}
}
],
"tags": [],

View file

@ -362,7 +362,7 @@
"label": "config",
"isRequired": true,
"signature": [
"Readonly<{} & { enabled: boolean; signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; endpointResultListDefaultFirstPageIndex: number; endpointResultListDefaultPageSize: number; alertResultListDefaultDateRange: Readonly<{} & { from: string; to: string; }>; packagerTaskInterval: string; validateArtifactDownloads: boolean; }>"
"Readonly<{} & { enabled: boolean; signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; fleetServerEnabled: boolean; endpointResultListDefaultFirstPageIndex: number; endpointResultListDefaultPageSize: number; alertResultListDefaultDateRange: Readonly<{} & { from: string; to: string; }>; packagerTaskInterval: string; validateArtifactDownloads: boolean; }>"
],
"description": [],
"source": {
@ -650,7 +650,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 398
"lineNumber": 400
}
}
],
@ -1463,10 +1463,10 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/config.ts",
"lineNumber": 43
"lineNumber": 47
},
"signature": [
"{ readonly enabled: boolean; readonly signalsIndex: string; readonly maxRuleImportExportSize: number; readonly maxRuleImportPayloadBytes: number; readonly maxTimelineImportExportSize: number; readonly maxTimelineImportPayloadBytes: number; readonly endpointResultListDefaultFirstPageIndex: number; readonly endpointResultListDefaultPageSize: number; readonly alertResultListDefaultDateRange: Readonly<{} & { from: string; to: string; }>; readonly packagerTaskInterval: string; readonly validateArtifactDownloads: boolean; }"
"{ readonly enabled: boolean; readonly signalsIndex: string; readonly maxRuleImportExportSize: number; readonly maxRuleImportPayloadBytes: number; readonly maxTimelineImportExportSize: number; readonly maxTimelineImportPayloadBytes: number; readonly fleetServerEnabled: boolean; readonly endpointResultListDefaultFirstPageIndex: number; readonly endpointResultListDefaultPageSize: number; readonly alertResultListDefaultDateRange: Readonly<{} & { from: string; to: string; }>; readonly packagerTaskInterval: string; readonly validateArtifactDownloads: boolean; }"
],
"initialIsOpen": false
}
@ -1725,162 +1725,6 @@
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.migratePackagePolicyToV7110",
"type": "Function",
"children": [
{
"type": "CompoundType",
"label": "packagePolicyDoc",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
">"
],
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/common/endpoint/policy/migrations/to_v7_11_0.ts",
"lineNumber": 13
}
}
],
"signature": [
"(packagePolicyDoc: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
">) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
">"
],
"description": [],
"label": "migratePackagePolicyToV7110",
"source": {
"path": "x-pack/plugins/security_solution/common/endpoint/policy/migrations/to_v7_11_0.ts",
"lineNumber": 12
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.migratePackagePolicyToV7120",
"type": "Function",
"children": [
{
"type": "CompoundType",
"label": "packagePolicyDoc",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
">"
],
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/common/endpoint/policy/migrations/to_v7_12_0.ts",
"lineNumber": 14
}
}
],
"signature": [
"(packagePolicyDoc: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
">) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
">"
],
"description": [],
"label": "migratePackagePolicyToV7120",
"source": {
"path": "x-pack/plugins/security_solution/common/endpoint/policy/migrations/to_v7_12_0.ts",
"lineNumber": 13
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.removeExternalLinkText",
"type": "Function",