mirror of
https://github.com/elastic/kibana.git
synced 2025-04-18 23:21:39 -04:00
1286 lines
No EOL
48 KiB
JSON
1286 lines
No EOL
48 KiB
JSON
{
|
|
"id": "@kbn/object-versioning",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.compile",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "compile",
|
|
"description": [
|
|
"\nConvert a versionned service definition to a flattened service definition\nwhere _each object_ is versioned (at the leaf).\n"
|
|
],
|
|
"signature": [
|
|
"(definitions: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ServiceDefinitionVersioned",
|
|
"text": "ServiceDefinitionVersioned"
|
|
},
|
|
") => { [path: string]: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectMigrationDefinition",
|
|
"text": "ObjectMigrationDefinition"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_services_versioning.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.compile.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "definitions",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ServiceDefinitionVersioned",
|
|
"text": "ServiceDefinitionVersioned"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_services_versioning.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.getTransforms",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getTransforms",
|
|
"description": [],
|
|
"signature": [
|
|
"(definitions: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ServiceDefinitionVersioned",
|
|
"text": "ServiceDefinitionVersioned"
|
|
},
|
|
", requestVersion: number, _compiled?: { [path: string]: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectMigrationDefinition",
|
|
"text": "ObjectMigrationDefinition"
|
|
},
|
|
"; } | undefined) => ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ServiceTransforms",
|
|
"text": "ServiceTransforms"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_services_versioning.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.getTransforms.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "definitions",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ServiceDefinitionVersioned",
|
|
"text": "ServiceDefinitionVersioned"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_services_versioning.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.getTransforms.$2",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "requestVersion",
|
|
"description": [],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_services_versioning.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.getTransforms.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "_compiled",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_services_versioning.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.getTransforms.$3.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[path: string]: ObjectMigrationDefinition",
|
|
"description": [],
|
|
"signature": [
|
|
"[path: string]: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectMigrationDefinition",
|
|
"text": "ObjectMigrationDefinition"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_services_versioning.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.initTransform",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "initTransform",
|
|
"description": [
|
|
"\nInitiate a transform for a specific request version. After we initiate the transforms\nfor a specific version we can then pass different `ObjectMigrationDefinition` to the provided\nhandler to start up/down transforming different object based on this request version.\n"
|
|
],
|
|
"signature": [
|
|
"<UpIn = unknown, UpOut = unknown, DownIn = unknown, DownOut = unknown>(requestVersion: number) => (migrationDefinition: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectMigrationDefinition",
|
|
"text": "ObjectMigrationDefinition"
|
|
},
|
|
") => { up: <I = UpIn, O = UpOut>(obj: I, to?: number | \"latest\", { validate }?: { validate?: boolean | undefined; }) => { error: Error; value: null; } | { value: O; error: null; }; down: <I = DownIn, O = DownOut>(obj: I, from?: number | \"latest\", { validate }?: { validate?: boolean | undefined; }) => { error: Error; value: null; } | { value: any; error: null; }; validate: (value: unknown, version?: number) => ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.ValidationError",
|
|
"text": "ValidationError"
|
|
},
|
|
" | null; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/object_transform.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.initTransform.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "requestVersion",
|
|
"description": [
|
|
"The starting version before up/down transforming"
|
|
],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/object_transform.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"A handler to pass an object migration definition"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectMigrationDefinition",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ObjectMigrationDefinition",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectMigrationDefinition.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[version: number]: VersionableObject<any, any, any, any>",
|
|
"description": [],
|
|
"signature": [
|
|
"[version: number]: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.VersionableObject",
|
|
"text": "VersionableObject"
|
|
},
|
|
"<any, any, any, any>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectTransforms",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ObjectTransforms",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransforms",
|
|
"text": "ObjectTransforms"
|
|
},
|
|
"<UpIn, UpOut, DownIn, DownOut>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectTransforms.up",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "up",
|
|
"description": [],
|
|
"signature": [
|
|
"<I = UpIn, O = UpOut>(obj: I, version?: number | \"latest\" | undefined, options?: { validate?: boolean | undefined; } | undefined) => ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.TransformReturn",
|
|
"text": "TransformReturn"
|
|
},
|
|
"<O>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectTransforms.up.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "obj",
|
|
"description": [],
|
|
"signature": [
|
|
"I"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectTransforms.up.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"signature": [
|
|
"number | \"latest\" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectTransforms.up.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectTransforms.up.$3.validate",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "validate",
|
|
"description": [
|
|
"Validate the object _before_ up transform"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectTransforms.down",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "down",
|
|
"description": [],
|
|
"signature": [
|
|
"<I = DownIn, O = DownOut>(obj: DownIn, version?: number | \"latest\" | undefined, options?: { validate?: boolean | undefined; } | undefined) => ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.TransformReturn",
|
|
"text": "TransformReturn"
|
|
},
|
|
"<O>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectTransforms.down.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "obj",
|
|
"description": [],
|
|
"signature": [
|
|
"DownIn"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectTransforms.down.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"signature": [
|
|
"number | \"latest\" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectTransforms.down.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectTransforms.down.$3.validate",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "validate",
|
|
"description": [
|
|
"Validate the object _before_ down transform"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectTransforms.validate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "validate",
|
|
"description": [],
|
|
"signature": [
|
|
"(obj: any, version?: number | undefined) => ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.ValidationError",
|
|
"text": "ValidationError"
|
|
},
|
|
" | null"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectTransforms.validate.$1",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "obj",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectTransforms.validate.$2",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServiceDefinitionVersioned",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ServiceDefinitionVersioned",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServiceDefinitionVersioned.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[version: number]: ServicesDefinition",
|
|
"description": [],
|
|
"signature": [
|
|
"[version: number]: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ServicesDefinition",
|
|
"text": "ServicesDefinition"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServicesDefinition",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ServicesDefinition",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServicesDefinition.get",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [],
|
|
"signature": [
|
|
"{ in?: { options?: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.VersionableObject",
|
|
"text": "VersionableObject"
|
|
},
|
|
"<any, any, any, any> | undefined; } | undefined; out?: { result?: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.VersionableObject",
|
|
"text": "VersionableObject"
|
|
},
|
|
"<any, any, any, any> | undefined; } | undefined; } | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServicesDefinition.bulkGet",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "bulkGet",
|
|
"description": [],
|
|
"signature": [
|
|
"{ in?: { options?: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.VersionableObject",
|
|
"text": "VersionableObject"
|
|
},
|
|
"<any, any, any, any> | undefined; } | undefined; out?: { result?: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.VersionableObject",
|
|
"text": "VersionableObject"
|
|
},
|
|
"<any, any, any, any> | undefined; } | undefined; } | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServicesDefinition.create",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "create",
|
|
"description": [],
|
|
"signature": [
|
|
"{ in?: { data?: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.VersionableObject",
|
|
"text": "VersionableObject"
|
|
},
|
|
"<any, any, any, any> | undefined; options?: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.VersionableObject",
|
|
"text": "VersionableObject"
|
|
},
|
|
"<any, any, any, any> | undefined; } | undefined; out?: { result?: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.VersionableObject",
|
|
"text": "VersionableObject"
|
|
},
|
|
"<any, any, any, any> | undefined; } | undefined; } | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServicesDefinition.update",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "update",
|
|
"description": [],
|
|
"signature": [
|
|
"{ in?: { data?: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.VersionableObject",
|
|
"text": "VersionableObject"
|
|
},
|
|
"<any, any, any, any> | undefined; options?: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.VersionableObject",
|
|
"text": "VersionableObject"
|
|
},
|
|
"<any, any, any, any> | undefined; } | undefined; out?: { result?: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.VersionableObject",
|
|
"text": "VersionableObject"
|
|
},
|
|
"<any, any, any, any> | undefined; } | undefined; } | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServicesDefinition.delete",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "delete",
|
|
"description": [],
|
|
"signature": [
|
|
"{ in?: { options?: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.VersionableObject",
|
|
"text": "VersionableObject"
|
|
},
|
|
"<any, any, any, any> | undefined; } | undefined; out?: { result?: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.VersionableObject",
|
|
"text": "VersionableObject"
|
|
},
|
|
"<any, any, any, any> | undefined; } | undefined; } | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServicesDefinition.search",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "search",
|
|
"description": [],
|
|
"signature": [
|
|
"{ in?: { options?: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.VersionableObject",
|
|
"text": "VersionableObject"
|
|
},
|
|
"<any, any, any, any> | undefined; } | undefined; out?: { result?: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.VersionableObject",
|
|
"text": "VersionableObject"
|
|
},
|
|
"<any, any, any, any> | undefined; } | undefined; } | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServicesDefinition.mSearch",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "mSearch",
|
|
"description": [],
|
|
"signature": [
|
|
"{ out?: { result?: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.VersionableObject",
|
|
"text": "VersionableObject"
|
|
},
|
|
"<any, any, any, any> | undefined; } | undefined; } | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServiceTransforms",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ServiceTransforms",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServiceTransforms.get",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [],
|
|
"signature": [
|
|
"{ in: { options: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransforms",
|
|
"text": "ObjectTransforms"
|
|
},
|
|
"<any, any, any, any>; }; out: { result: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransforms",
|
|
"text": "ObjectTransforms"
|
|
},
|
|
"<any, any, any, any>; }; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServiceTransforms.bulkGet",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "bulkGet",
|
|
"description": [],
|
|
"signature": [
|
|
"{ in: { options: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransforms",
|
|
"text": "ObjectTransforms"
|
|
},
|
|
"<any, any, any, any>; }; out: { result: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransforms",
|
|
"text": "ObjectTransforms"
|
|
},
|
|
"<any, any, any, any>; }; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServiceTransforms.create",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "create",
|
|
"description": [],
|
|
"signature": [
|
|
"{ in: { data: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransforms",
|
|
"text": "ObjectTransforms"
|
|
},
|
|
"<any, any, any, any>; options: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransforms",
|
|
"text": "ObjectTransforms"
|
|
},
|
|
"<any, any, any, any>; }; out: { result: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransforms",
|
|
"text": "ObjectTransforms"
|
|
},
|
|
"<any, any, any, any>; }; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServiceTransforms.update",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "update",
|
|
"description": [],
|
|
"signature": [
|
|
"{ in: { data: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransforms",
|
|
"text": "ObjectTransforms"
|
|
},
|
|
"<any, any, any, any>; options: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransforms",
|
|
"text": "ObjectTransforms"
|
|
},
|
|
"<any, any, any, any>; }; out: { result: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransforms",
|
|
"text": "ObjectTransforms"
|
|
},
|
|
"<any, any, any, any>; }; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServiceTransforms.delete",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "delete",
|
|
"description": [],
|
|
"signature": [
|
|
"{ in: { options: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransforms",
|
|
"text": "ObjectTransforms"
|
|
},
|
|
"<any, any, any, any>; }; out: { result: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransforms",
|
|
"text": "ObjectTransforms"
|
|
},
|
|
"<any, any, any, any>; }; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServiceTransforms.search",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "search",
|
|
"description": [],
|
|
"signature": [
|
|
"{ in: { options: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransforms",
|
|
"text": "ObjectTransforms"
|
|
},
|
|
"<any, any, any, any>; }; out: { result: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransforms",
|
|
"text": "ObjectTransforms"
|
|
},
|
|
"<any, any, any, any>; }; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ServiceTransforms.mSearch",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "mSearch",
|
|
"description": [],
|
|
"signature": [
|
|
"{ out: { result: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransforms",
|
|
"text": "ObjectTransforms"
|
|
},
|
|
"<any, any, any, any>; }; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.VersionableObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "VersionableObject",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.VersionableObject",
|
|
"text": "VersionableObject"
|
|
},
|
|
"<UpIn, UpOut, DownIn, DownOut>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.VersionableObject.schema",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "schema",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.Type",
|
|
"text": "Type"
|
|
},
|
|
"<any> | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.VersionableObject.down",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "down",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransform",
|
|
"text": "ObjectTransform"
|
|
},
|
|
"<DownIn, DownOut> | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.VersionableObject.up",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "up",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectTransform",
|
|
"text": "ObjectTransform"
|
|
},
|
|
"<UpIn, UpOut> | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.GetTransformsFn",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "GetTransformsFn",
|
|
"description": [],
|
|
"signature": [
|
|
"(definitions: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ServiceDefinitionVersioned",
|
|
"text": "ServiceDefinitionVersioned"
|
|
},
|
|
", requestVersion: number, _compiled?: { [path: string]: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectMigrationDefinition",
|
|
"text": "ObjectMigrationDefinition"
|
|
},
|
|
"; } | undefined) => ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ServiceTransforms",
|
|
"text": "ServiceTransforms"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_services_versioning.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.GetTransformsFn.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "definitions",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ServiceDefinitionVersioned",
|
|
"text": "ServiceDefinitionVersioned"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_services_versioning.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.GetTransformsFn.$2",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "requestVersion",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_services_versioning.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.GetTransformsFn.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "_compiled",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [path: string]: ",
|
|
{
|
|
"pluginId": "@kbn/object-versioning",
|
|
"scope": "server",
|
|
"docId": "kibKbnObjectVersioningPluginApi",
|
|
"section": "def-server.ObjectMigrationDefinition",
|
|
"text": "ObjectMigrationDefinition"
|
|
},
|
|
"; } | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/content_management_services_versioning.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectTransform",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ObjectTransform",
|
|
"description": [],
|
|
"signature": [
|
|
"(input: I) => O"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.ObjectTransform.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"I"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.TransformReturn",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "TransformReturn",
|
|
"description": [],
|
|
"signature": [
|
|
"{ value: T; error: null; } | { value: null; error: Error | ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.ValidationError",
|
|
"text": "ValidationError"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/object-versioning",
|
|
"id": "def-server.Version",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "Version",
|
|
"description": [],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-object-versioning/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |