* 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>
270 lines
9.1 KiB
JSON
270 lines
9.1 KiB
JSON
{
|
|
"id": "infra",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"id": "def-public.LazyLogStreamWrapper",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "props",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"React.PropsWithChildren<",
|
|
{
|
|
"pluginId": "infra",
|
|
"scope": "public",
|
|
"docId": "kibInfraPluginApi",
|
|
"section": "def-public.LogStreamProps",
|
|
"text": "LogStreamProps"
|
|
},
|
|
">"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx",
|
|
"lineNumber": 13,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx#L13"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(props: React.PropsWithChildren<",
|
|
"LogStreamProps",
|
|
">) => JSX.Element"
|
|
],
|
|
"description": [],
|
|
"label": "LazyLogStreamWrapper",
|
|
"source": {
|
|
"path": "x-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx",
|
|
"lineNumber": 13,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx#L13"
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [],
|
|
"enums": [
|
|
{
|
|
"id": "def-public.InfraFormatterType",
|
|
"type": "Enum",
|
|
"label": "InfraFormatterType",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/infra/public/lib/lib.ts",
|
|
"lineNumber": 147,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/public/lib/lib.ts#L147"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"id": "def-public.InfraAppId",
|
|
"type": "Type",
|
|
"label": "InfraAppId",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/infra/public/index.ts",
|
|
"lineNumber": 29,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/public/index.ts#L29"
|
|
},
|
|
"signature": [
|
|
"\"metrics\" | \"logs\""
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"id": "def-public.FORMATTERS",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FORMATTERS.number",
|
|
"type": "Function",
|
|
"label": "number",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/infra/common/formatters/index.ts",
|
|
"lineNumber": 16,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L16"
|
|
},
|
|
"signature": [
|
|
"(val: number) => string"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FORMATTERS.abbreviatedNumber",
|
|
"type": "Function",
|
|
"label": "abbreviatedNumber",
|
|
"description": [
|
|
"// Because the implimentation for formatting large numbers is the same as formatting\n// bytes we are re-using the same code, we just format the number using the abbreviated number format."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/infra/common/formatters/index.ts",
|
|
"lineNumber": 19,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L19"
|
|
},
|
|
"signature": [
|
|
"(bytes: number) => string"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FORMATTERS.bytes",
|
|
"type": "Function",
|
|
"label": "bytes",
|
|
"description": [
|
|
"// bytes in bytes formatted string out"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/infra/common/formatters/index.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L21"
|
|
},
|
|
"signature": [
|
|
"(bytes: number) => string"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FORMATTERS.bits",
|
|
"type": "Function",
|
|
"label": "bits",
|
|
"description": [
|
|
"// bytes in bits formatted string out"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/infra/common/formatters/index.ts",
|
|
"lineNumber": 23,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L23"
|
|
},
|
|
"signature": [
|
|
"(bytes: number) => string"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FORMATTERS.percent",
|
|
"type": "Function",
|
|
"label": "percent",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/infra/common/formatters/index.ts",
|
|
"lineNumber": 24,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L24"
|
|
},
|
|
"signature": [
|
|
"(val: number) => string"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FORMATTERS.highPercision",
|
|
"type": "Function",
|
|
"label": "highPercision",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/infra/common/formatters/index.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L25"
|
|
},
|
|
"signature": [
|
|
"(val: number) => string"
|
|
]
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "FORMATTERS",
|
|
"source": {
|
|
"path": "x-pack/plugins/infra/common/formatters/index.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L15"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"id": "def-server.InfraConfig",
|
|
"type": "Type",
|
|
"label": "InfraConfig",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/infra/server/plugin.ts",
|
|
"lineNumber": 64,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/server/plugin.ts#L64"
|
|
},
|
|
"signature": [
|
|
"{ readonly sources?: Readonly<{ default?: Readonly<{ fields?: Readonly<{ host?: string | undefined; message?: string[] | undefined; timestamp?: string | undefined; tiebreaker?: string | undefined; container?: string | undefined; pod?: string | undefined; } & {}> | undefined; logAlias?: string | undefined; metricAlias?: string | undefined; } & {}> | undefined; } & {}> | undefined; readonly enabled: boolean; readonly query: Readonly<{} & { partitionSize: number; partitionFactor: number; }>; }"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-server.InfraPluginSetup",
|
|
"type": "Interface",
|
|
"label": "InfraPluginSetup",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.InfraPluginSetup.defineInternalSourceConfiguration",
|
|
"type": "Function",
|
|
"label": "defineInternalSourceConfiguration",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/infra/server/plugin.ts",
|
|
"lineNumber": 75,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/server/plugin.ts#L75"
|
|
},
|
|
"signature": [
|
|
"(sourceId: string, sourceProperties: ",
|
|
{
|
|
"pluginId": "infra",
|
|
"scope": "common",
|
|
"docId": "kibInfraPluginApi",
|
|
"section": "def-common.InfraStaticSourceConfiguration",
|
|
"text": "InfraStaticSourceConfiguration"
|
|
},
|
|
") => void"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/infra/server/plugin.ts",
|
|
"lineNumber": 74,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/server/plugin.ts#L74"
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |