kibana/api_docs/kbn_content_packs_schema.devdocs.json

1665 lines
No EOL
57 KiB
JSON

{
"id": "@kbn/content-packs-schema",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.findConfiguration",
"type": "Function",
"tags": [],
"label": "findConfiguration",
"description": [],
"signature": [
"(savedObject: ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackSavedObject",
"text": "ContentPackSavedObject"
},
") => { patterns: string[]; fields: Record<string, { type: string; }>; }"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/helpers/index_pattern.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.findConfiguration.$1",
"type": "CompoundType",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackSavedObject",
"text": "ContentPackSavedObject"
}
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/helpers/index_pattern.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.getEntryTypeByFile",
"type": "Function",
"tags": [],
"label": "getEntryTypeByFile",
"description": [],
"signature": [
"(rootDir: string, filepath: string) => \"dashboard\" | \"index-pattern\" | \"lens\""
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.getEntryTypeByFile.$1",
"type": "string",
"tags": [],
"label": "rootDir",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.getEntryTypeByFile.$2",
"type": "string",
"tags": [],
"label": "filepath",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.isDashboardFile",
"type": "Function",
"tags": [],
"label": "isDashboardFile",
"description": [],
"signature": [
"(rootDir: string, filepath: string) => boolean"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.isDashboardFile.$1",
"type": "string",
"tags": [],
"label": "rootDir",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.isDashboardFile.$2",
"type": "string",
"tags": [],
"label": "filepath",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.isIncludeAll",
"type": "Function",
"tags": [],
"label": "isIncludeAll",
"description": [],
"signature": [
"(value: ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackIncludedObjects",
"text": "ContentPackIncludedObjects"
},
") => value is ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackIncludeAll",
"text": "ContentPackIncludeAll"
}
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.isIncludeAll.$1",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackIncludedObjects",
"text": "ContentPackIncludedObjects"
}
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/api.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.isIndexPlaceholder",
"type": "Function",
"tags": [],
"label": "isIndexPlaceholder",
"description": [],
"signature": [
"(index: string) => boolean"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/helpers/index_pattern.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.isIndexPlaceholder.$1",
"type": "string",
"tags": [],
"label": "index",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/helpers/index_pattern.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.isSupportedEntryType",
"type": "Function",
"tags": [],
"label": "isSupportedEntryType",
"description": [],
"signature": [
"(type: string) => boolean"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.isSupportedEntryType.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.isSupportedFile",
"type": "Function",
"tags": [],
"label": "isSupportedFile",
"description": [],
"signature": [
"(rootDir: string, filepath: string) => boolean"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.isSupportedFile.$1",
"type": "string",
"tags": [],
"label": "rootDir",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.isSupportedFile.$2",
"type": "string",
"tags": [],
"label": "filepath",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.isSupportedReferenceType",
"type": "Function",
"tags": [],
"label": "isSupportedReferenceType",
"description": [],
"signature": [
"(type: string) => boolean"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.isSupportedReferenceType.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.isSupportedSavedObjectType",
"type": "Function",
"tags": [],
"label": "isSupportedSavedObjectType",
"description": [],
"signature": [
"(entry: ",
"SavedObject",
"<unknown> | ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackSavedObject",
"text": "ContentPackSavedObject"
},
") => entry is ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackSavedObject",
"text": "ContentPackSavedObject"
}
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.isSupportedSavedObjectType.$1",
"type": "CompoundType",
"tags": [],
"label": "entry",
"description": [],
"signature": [
"SavedObject",
"<unknown> | ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackSavedObject",
"text": "ContentPackSavedObject"
}
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.replaceIndexPatterns",
"type": "Function",
"tags": [],
"label": "replaceIndexPatterns",
"description": [],
"signature": [
"(savedObject: ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackSavedObject",
"text": "ContentPackSavedObject"
},
", patternReplacements: Record<string, string>) => ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackSavedObject",
"text": "ContentPackSavedObject"
}
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/helpers/index_pattern.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.replaceIndexPatterns.$1",
"type": "CompoundType",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackSavedObject",
"text": "ContentPackSavedObject"
}
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/helpers/index_pattern.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.replaceIndexPatterns.$2",
"type": "Object",
"tags": [],
"label": "patternReplacements",
"description": [],
"signature": [
"Record<string, string>"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/helpers/index_pattern.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPack",
"type": "Interface",
"tags": [],
"label": "ContentPack",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPack",
"text": "ContentPack"
},
" extends ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackManifest",
"text": "ContentPackManifest"
}
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPack.entries",
"type": "Array",
"tags": [],
"label": "entries",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackSavedObject",
"text": "ContentPackSavedObject"
},
"[]"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackIncludeAll",
"type": "Interface",
"tags": [],
"label": "ContentPackIncludeAll",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackIncludeAll.all",
"type": "Object",
"tags": [],
"label": "all",
"description": [],
"signature": [
"{}"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/api.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackIncludeObjects",
"type": "Interface",
"tags": [],
"label": "ContentPackIncludeObjects",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackIncludeObjects.objects",
"type": "Object",
"tags": [],
"label": "objects",
"description": [],
"signature": [
"{ dashboards: string[]; }"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/api.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackManifest",
"type": "Interface",
"tags": [],
"label": "ContentPackManifest",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackManifest.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackManifest.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackManifest.version",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackPreview",
"type": "Interface",
"tags": [],
"label": "ContentPackPreview",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackPreview",
"text": "ContentPackPreview"
},
" extends ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackManifest",
"text": "ContentPackManifest"
}
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackPreview.entries",
"type": "Array",
"tags": [],
"label": "entries",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackPreviewEntry",
"text": "ContentPackPreviewEntry"
},
"[]"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackPreviewEntry",
"type": "Interface",
"tags": [],
"label": "ContentPackPreviewEntry",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackPreviewEntry.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackPreviewEntry.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackPreviewEntry.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackPreviewEntry.errors",
"type": "Array",
"tags": [],
"label": "errors",
"description": [],
"signature": [
"{ severity: \"warning\" | \"fatal\"; message: string; }[]"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackSavedObjectLinks",
"type": "Interface",
"tags": [],
"label": "ContentPackSavedObjectLinks",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackSavedObjectLinks.dashboards",
"type": "Array",
"tags": [],
"label": "dashboards",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.SavedObjectLinkWithReferences",
"text": "SavedObjectLinkWithReferences"
},
"[]"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.SavedObjectLink",
"type": "Interface",
"tags": [],
"label": "SavedObjectLink",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.SavedObjectLink.source_id",
"type": "string",
"tags": [],
"label": "source_id",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.SavedObjectLink.target_id",
"type": "string",
"tags": [],
"label": "target_id",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackDashboard",
"type": "Type",
"tags": [],
"label": "ContentPackDashboard",
"description": [],
"signature": [
"SavedObject",
"<",
"DashboardAttributes",
"> & { type: \"dashboard\"; }"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackDataView",
"type": "Type",
"tags": [],
"label": "ContentPackDataView",
"description": [],
"signature": [
"SavedObject",
"<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSavedObjectAttrs",
"text": "DataViewSavedObjectAttrs"
},
"> & { type: \"index-pattern\"; }"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackEntry",
"type": "Type",
"tags": [],
"label": "ContentPackEntry",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackDashboard",
"text": "ContentPackDashboard"
},
" | ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackDataView",
"text": "ContentPackDataView"
},
" | ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackLens",
"text": "ContentPackLens"
}
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackIncludedObjects",
"type": "Type",
"tags": [],
"label": "ContentPackIncludedObjects",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackIncludeObjects",
"text": "ContentPackIncludeObjects"
},
" | ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackIncludeAll",
"text": "ContentPackIncludeAll"
}
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/api.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackLens",
"type": "Type",
"tags": [],
"label": "ContentPackLens",
"description": [],
"signature": [
"SavedObject",
"<{ title: string; description?: string | undefined; references: ",
"SavedObjectReference",
"[]; visualizationType: \"lnsXY\"; state: { query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
"; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; needsRefresh?: boolean | undefined; adHocDataViews?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"> | undefined; internalReferences?: ",
"SavedObjectReference",
"[] | undefined; datasourceStates: { formBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormBasedPersistedState",
"text": "FormBasedPersistedState"
},
" | undefined; textBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.TextBasedPersistedState",
"text": "TextBasedPersistedState"
},
" | undefined; }; visualization: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.XYState",
"text": "XYState"
},
"; }; } | { title: string; description?: string | undefined; references: ",
"SavedObjectReference",
"[]; visualizationType: \"lnsPie\"; state: { query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
"; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; needsRefresh?: boolean | undefined; adHocDataViews?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"> | undefined; internalReferences?: ",
"SavedObjectReference",
"[] | undefined; datasourceStates: { formBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormBasedPersistedState",
"text": "FormBasedPersistedState"
},
" | undefined; textBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.TextBasedPersistedState",
"text": "TextBasedPersistedState"
},
" | undefined; }; visualization: ",
"PieVisualizationState",
"; }; } | { title: string; description?: string | undefined; references: ",
"SavedObjectReference",
"[]; visualizationType: \"lnsHeatmap\"; state: { query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
"; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; needsRefresh?: boolean | undefined; adHocDataViews?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"> | undefined; internalReferences?: ",
"SavedObjectReference",
"[] | undefined; datasourceStates: { formBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormBasedPersistedState",
"text": "FormBasedPersistedState"
},
" | undefined; textBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.TextBasedPersistedState",
"text": "TextBasedPersistedState"
},
" | undefined; }; visualization: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.HeatmapVisualizationState",
"text": "HeatmapVisualizationState"
},
"; }; } | { title: string; description?: string | undefined; references: ",
"SavedObjectReference",
"[]; visualizationType: \"lnsGauge\"; state: { query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
"; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; needsRefresh?: boolean | undefined; adHocDataViews?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"> | undefined; internalReferences?: ",
"SavedObjectReference",
"[] | undefined; datasourceStates: { formBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormBasedPersistedState",
"text": "FormBasedPersistedState"
},
" | undefined; textBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.TextBasedPersistedState",
"text": "TextBasedPersistedState"
},
" | undefined; }; visualization: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.GaugeVisualizationState",
"text": "GaugeVisualizationState"
},
"; }; } | { title: string; description?: string | undefined; references: ",
"SavedObjectReference",
"[]; visualizationType: \"lnsDatatable\"; state: { query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
"; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; needsRefresh?: boolean | undefined; adHocDataViews?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"> | undefined; internalReferences?: ",
"SavedObjectReference",
"[] | undefined; datasourceStates: { formBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormBasedPersistedState",
"text": "FormBasedPersistedState"
},
" | undefined; textBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.TextBasedPersistedState",
"text": "TextBasedPersistedState"
},
" | undefined; }; visualization: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.DatatableVisualizationState",
"text": "DatatableVisualizationState"
},
"; }; } | { title: string; description?: string | undefined; references: ",
"SavedObjectReference",
"[]; visualizationType: \"lnsLegacyMetric\"; state: { query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
"; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; needsRefresh?: boolean | undefined; adHocDataViews?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"> | undefined; internalReferences?: ",
"SavedObjectReference",
"[] | undefined; datasourceStates: { formBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormBasedPersistedState",
"text": "FormBasedPersistedState"
},
" | undefined; textBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.TextBasedPersistedState",
"text": "TextBasedPersistedState"
},
" | undefined; }; visualization: ",
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.LegacyMetricState",
"text": "LegacyMetricState"
},
"; }; } | { title: string; description?: string | undefined; references: ",
"SavedObjectReference",
"[]; visualizationType: \"lnsMetric\"; state: { query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
"; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; needsRefresh?: boolean | undefined; adHocDataViews?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"> | undefined; internalReferences?: ",
"SavedObjectReference",
"[] | undefined; datasourceStates: { formBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormBasedPersistedState",
"text": "FormBasedPersistedState"
},
" | undefined; textBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.TextBasedPersistedState",
"text": "TextBasedPersistedState"
},
" | undefined; }; visualization: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.MetricVisualizationState",
"text": "MetricVisualizationState"
},
"; }; } | { title: string; description?: string | undefined; references: ",
"SavedObjectReference",
"[]; visualizationType: string; state: { query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
"; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; needsRefresh?: boolean | undefined; adHocDataViews?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"> | undefined; internalReferences?: ",
"SavedObjectReference",
"[] | undefined; datasourceStates: { formBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormBasedPersistedState",
"text": "FormBasedPersistedState"
},
" | undefined; textBased?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.TextBasedPersistedState",
"text": "TextBasedPersistedState"
},
" | undefined; }; visualization: unknown; }; }> & { type: \"lens\"; }"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.ContentPackSavedObject",
"type": "Type",
"tags": [],
"label": "ContentPackSavedObject",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackDashboard",
"text": "ContentPackDashboard"
},
" | ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackDataView",
"text": "ContentPackDataView"
},
" | ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackLens",
"text": "ContentPackLens"
}
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.INDEX_PLACEHOLDER",
"type": "string",
"tags": [],
"label": "INDEX_PLACEHOLDER",
"description": [],
"signature": [
"\"<stream_name_placeholder>\""
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/helpers/index_pattern.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.SavedObjectLinkWithReferences",
"type": "Type",
"tags": [],
"label": "SavedObjectLinkWithReferences",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.SavedObjectLink",
"text": "SavedObjectLink"
},
" & { references: ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.SavedObjectLink",
"text": "SavedObjectLink"
},
"[]; }"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.SupportedEntryType",
"type": "Type",
"tags": [],
"label": "SupportedEntryType",
"description": [],
"signature": [
"\"dashboard\" | \"index-pattern\" | \"lens\""
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.contentPackIncludedObjectsSchema",
"type": "Object",
"tags": [],
"label": "contentPackIncludedObjectsSchema",
"description": [],
"signature": [
"Zod.ZodType<",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackIncludedObjects",
"text": "ContentPackIncludedObjects"
},
", Zod.ZodTypeDef, ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackIncludedObjects",
"text": "ContentPackIncludedObjects"
},
">"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/api.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.contentPackManifestSchema",
"type": "Object",
"tags": [],
"label": "contentPackManifestSchema",
"description": [],
"signature": [
"Zod.ZodType<",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackManifest",
"text": "ContentPackManifest"
},
", Zod.ZodTypeDef, ",
{
"pluginId": "@kbn/content-packs-schema",
"scope": "common",
"docId": "kibKbnContentPacksSchemaPluginApi",
"section": "def-common.ContentPackManifest",
"text": "ContentPackManifest"
},
">"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.SUPPORTED_ENTRY_TYPE",
"type": "Object",
"tags": [],
"label": "SUPPORTED_ENTRY_TYPE",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.SUPPORTED_ENTRY_TYPE.Unnamed",
"type": "Any",
"tags": [],
"label": "Unnamed",
"description": [],
"signature": [
"any"
],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.SUPPORTED_SAVED_OBJECT_TYPE",
"type": "Object",
"tags": [],
"label": "SUPPORTED_SAVED_OBJECT_TYPE",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.SUPPORTED_SAVED_OBJECT_TYPE.dashboard",
"type": "string",
"tags": [],
"label": "dashboard",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.SUPPORTED_SAVED_OBJECT_TYPE.indexpattern",
"type": "string",
"tags": [],
"label": "'index-pattern'",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/content-packs-schema",
"id": "def-common.SUPPORTED_SAVED_OBJECT_TYPE.lens",
"type": "string",
"tags": [],
"label": "lens",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/saved_object.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
]
}
}