503cfcf8c9
* Track stats and add extra output information * Update api docs output * Clean up id names * update api docs * Consolidate error messages and fix a bug * Update docs * Update get_declaration_nodes_for_plugin.ts * Fix bug with removeBrokenLinks not being recursive * Update docs Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
1372 lines
42 KiB
JSON
1372 lines
42 KiB
JSON
{
|
|
"id": "home",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"id": "def-public.getDisplayText",
|
|
"type": "Function",
|
|
"label": "getDisplayText",
|
|
"signature": [
|
|
"(id: \"ESC\" | \"OSX\" | \"DEB\" | \"RPM\" | \"DOCKER\" | \"WINDOWS\" | \"NODE\" | \"DJANGO\" | \"FLASK\" | \"RAILS\" | \"RACK\" | \"JS\" | \"GO\" | \"JAVA\" | \"DOTNET\" | \"LINUX\" | \"PHP\") => string"
|
|
],
|
|
"description": [
|
|
"\nConvert instruction variant id into display text.\n"
|
|
],
|
|
"children": [
|
|
{
|
|
"id": "def-public.getDisplayText.$1",
|
|
"type": "CompoundType",
|
|
"label": "id",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"\"ESC\" | \"OSX\" | \"DEB\" | \"RPM\" | \"DOCKER\" | \"WINDOWS\" | \"NODE\" | \"DJANGO\" | \"FLASK\" | \"RAILS\" | \"RACK\" | \"JS\" | \"GO\" | \"JAVA\" | \"DOTNET\" | \"LINUX\" | \"PHP\""
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 55
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"params",
|
|
"return"
|
|
],
|
|
"returnComment": [
|
|
"display name"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-public.Environment",
|
|
"type": "Interface",
|
|
"label": "Environment",
|
|
"description": [],
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.Environment.cloud",
|
|
"type": "boolean",
|
|
"label": "cloud",
|
|
"description": [
|
|
"\nFlag whether the home app should advertise cloud features"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/environment/environment.ts",
|
|
"lineNumber": 14
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.Environment.apmUi",
|
|
"type": "boolean",
|
|
"label": "apmUi",
|
|
"description": [
|
|
"\nFlag whether the home app should advertise apm features"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/environment/environment.ts",
|
|
"lineNumber": 18
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.Environment.ml",
|
|
"type": "boolean",
|
|
"label": "ml",
|
|
"description": [
|
|
"\nFlag whether the home app should advertise ml features"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/environment/environment.ts",
|
|
"lineNumber": 22
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/environment/environment.ts",
|
|
"lineNumber": 10
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.FeatureCatalogueEntry",
|
|
"type": "Interface",
|
|
"label": "FeatureCatalogueEntry",
|
|
"description": [],
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueEntry.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [
|
|
"Unique string identifier for this feature."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 22
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueEntry.title",
|
|
"type": "string",
|
|
"label": "title",
|
|
"description": [
|
|
"Title of feature displayed to the user."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 24
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueEntry.category",
|
|
"type": "Enum",
|
|
"label": "category",
|
|
"description": [
|
|
"{@link FeatureCatalogueCategory} to display this feature in."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "home",
|
|
"scope": "public",
|
|
"docId": "kibHomePluginApi",
|
|
"section": "def-public.FeatureCatalogueCategory",
|
|
"text": "FeatureCatalogueCategory"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueEntry.subtitle",
|
|
"type": "string",
|
|
"label": "subtitle",
|
|
"description": [
|
|
"A tagline of feature displayed to the user."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueEntry.description",
|
|
"type": "string",
|
|
"label": "description",
|
|
"description": [
|
|
"One-line description of feature displayed to the user."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 30
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueEntry.icon",
|
|
"type": "CompoundType",
|
|
"label": "icon",
|
|
"description": [
|
|
"EUI `IconType` for icon to be displayed to the user. EUI supports any known EUI icon, SVG URL, or ReactElement."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"signature": [
|
|
"IconType"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueEntry.path",
|
|
"type": "string",
|
|
"label": "path",
|
|
"description": [
|
|
"URL path to link to this future. Should not include the basePath."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 34
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueEntry.showOnHomePage",
|
|
"type": "boolean",
|
|
"label": "showOnHomePage",
|
|
"description": [
|
|
"Whether or not this link should be shown on the front page of Kibana."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 36
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueEntry.order",
|
|
"type": "number",
|
|
"label": "order",
|
|
"description": [
|
|
"An ordinal used to sort features relative to one another for display on the home page"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"signature": [
|
|
"number | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueEntry.visible",
|
|
"type": "Function",
|
|
"label": "visible",
|
|
"description": [
|
|
"Optional function to control visibility of this feature."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 40
|
|
},
|
|
"signature": [
|
|
"(() => boolean) | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueEntry.solutionId",
|
|
"type": "string",
|
|
"label": "solutionId",
|
|
"description": [
|
|
"Unique string identifier of the solution this feature belongs to"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.FeatureCatalogueSolution",
|
|
"type": "Interface",
|
|
"label": "FeatureCatalogueSolution",
|
|
"description": [],
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueSolution.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [
|
|
"Unique string identifier for this solution."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 48
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueSolution.title",
|
|
"type": "string",
|
|
"label": "title",
|
|
"description": [
|
|
"Title of solution displayed to the user."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 50
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueSolution.subtitle",
|
|
"type": "string",
|
|
"label": "subtitle",
|
|
"description": [
|
|
"The tagline of the solution displayed to the user."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 52
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueSolution.description",
|
|
"type": "string",
|
|
"label": "description",
|
|
"description": [
|
|
"One-line description of the solution displayed to the user."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueSolution.appDescriptions",
|
|
"type": "Array",
|
|
"label": "appDescriptions",
|
|
"description": [
|
|
"A list of use cases for this solution displayed to the user."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 56
|
|
},
|
|
"signature": [
|
|
"string[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueSolution.icon",
|
|
"type": "CompoundType",
|
|
"label": "icon",
|
|
"description": [
|
|
"EUI `IconType` for icon to be displayed to the user. EUI supports any known EUI icon, SVG URL, or ReactElement."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 58
|
|
},
|
|
"signature": [
|
|
"IconType"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueSolution.path",
|
|
"type": "string",
|
|
"label": "path",
|
|
"description": [
|
|
"URL path to link to this future. Should not include the basePath."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 60
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FeatureCatalogueSolution.order",
|
|
"type": "number",
|
|
"label": "order",
|
|
"description": [
|
|
"An ordinal used to sort solutions relative to one another for display on the home page"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 62
|
|
},
|
|
"signature": [
|
|
"number | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 46
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"id": "def-public.FeatureCatalogueCategory",
|
|
"type": "Enum",
|
|
"label": "FeatureCatalogueCategory",
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"id": "def-public.EnvironmentSetup",
|
|
"type": "Type",
|
|
"label": "EnvironmentSetup",
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/public/plugin.ts",
|
|
"lineNumber": 161
|
|
},
|
|
"signature": [
|
|
"{ update: (update: Partial<",
|
|
{
|
|
"pluginId": "home",
|
|
"scope": "public",
|
|
"docId": "kibHomePluginApi",
|
|
"section": "def-public.Environment",
|
|
"text": "Environment"
|
|
},
|
|
">) => void; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.FeatureCatalogueSetup",
|
|
"type": "Type",
|
|
"label": "FeatureCatalogueSetup",
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/public/plugin.ts",
|
|
"lineNumber": 158
|
|
},
|
|
"signature": [
|
|
"{ register: (feature: ",
|
|
{
|
|
"pluginId": "home",
|
|
"scope": "public",
|
|
"docId": "kibHomePluginApi",
|
|
"section": "def-public.FeatureCatalogueEntry",
|
|
"text": "FeatureCatalogueEntry"
|
|
},
|
|
") => void; registerSolution: (solution: ",
|
|
{
|
|
"pluginId": "home",
|
|
"scope": "public",
|
|
"docId": "kibHomePluginApi",
|
|
"section": "def-public.FeatureCatalogueSolution",
|
|
"text": "FeatureCatalogueSolution"
|
|
},
|
|
") => void; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.TutorialDirectoryHeaderLinkComponent",
|
|
"type": "Type",
|
|
"label": "TutorialDirectoryHeaderLinkComponent",
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/tutorials/tutorial_service.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"signature": [
|
|
"(props: { children?: React.ReactNode; }, context: any) => React.ReactElement<any, any> | null"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.TutorialDirectoryNoticeComponent",
|
|
"type": "Type",
|
|
"label": "TutorialDirectoryNoticeComponent",
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/tutorials/tutorial_service.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"signature": [
|
|
"(props: { children?: React.ReactNode; }, context: any) => React.ReactElement<any, any> | null"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.TutorialModuleNoticeComponent",
|
|
"type": "Type",
|
|
"label": "TutorialModuleNoticeComponent",
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/tutorials/tutorial_service.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"signature": [
|
|
"(props: React.PropsWithChildren<{ moduleName: string; }>, context: any) => React.ReactElement<any, any> | null"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.TutorialSetup",
|
|
"type": "Type",
|
|
"label": "TutorialSetup",
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/public/plugin.ts",
|
|
"lineNumber": 164
|
|
},
|
|
"signature": [
|
|
"{ setVariable: (key: string, value: unknown) => void; registerDirectoryNotice: (id: string, component: ",
|
|
"FC",
|
|
"<{}>) => void; registerDirectoryHeaderLink: (id: string, component: ",
|
|
"FC",
|
|
"<{}>) => void; registerModuleNotice: (id: string, component: ",
|
|
"FC",
|
|
"<{ moduleName: string; }>) => void; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.TutorialVariables",
|
|
"type": "Type",
|
|
"label": "TutorialVariables",
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/public/services/tutorials/tutorial_service.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"id": "def-public.INSTRUCTION_VARIANT",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INSTRUCTION_VARIANT.ESC",
|
|
"type": "string",
|
|
"label": "ESC",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 10
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INSTRUCTION_VARIANT.OSX",
|
|
"type": "string",
|
|
"label": "OSX",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 11
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INSTRUCTION_VARIANT.DEB",
|
|
"type": "string",
|
|
"label": "DEB",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 12
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INSTRUCTION_VARIANT.RPM",
|
|
"type": "string",
|
|
"label": "RPM",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 13
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INSTRUCTION_VARIANT.DOCKER",
|
|
"type": "string",
|
|
"label": "DOCKER",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 14
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INSTRUCTION_VARIANT.WINDOWS",
|
|
"type": "string",
|
|
"label": "WINDOWS",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 15
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INSTRUCTION_VARIANT.NODE",
|
|
"type": "string",
|
|
"label": "NODE",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 16
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INSTRUCTION_VARIANT.DJANGO",
|
|
"type": "string",
|
|
"label": "DJANGO",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 17
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INSTRUCTION_VARIANT.FLASK",
|
|
"type": "string",
|
|
"label": "FLASK",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 18
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INSTRUCTION_VARIANT.RAILS",
|
|
"type": "string",
|
|
"label": "RAILS",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 19
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INSTRUCTION_VARIANT.RACK",
|
|
"type": "string",
|
|
"label": "RACK",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 20
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INSTRUCTION_VARIANT.JS",
|
|
"type": "string",
|
|
"label": "JS",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 21
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INSTRUCTION_VARIANT.GO",
|
|
"type": "string",
|
|
"label": "GO",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 22
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INSTRUCTION_VARIANT.JAVA",
|
|
"type": "string",
|
|
"label": "JAVA",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 23
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INSTRUCTION_VARIANT.DOTNET",
|
|
"type": "string",
|
|
"label": "DOTNET",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 24
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INSTRUCTION_VARIANT.LINUX",
|
|
"type": "string",
|
|
"label": "LINUX",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 25
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.INSTRUCTION_VARIANT.PHP",
|
|
"type": "string",
|
|
"label": "PHP",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 26
|
|
}
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "INSTRUCTION_VARIANT",
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"setup": {
|
|
"id": "def-public.HomePublicPluginSetup",
|
|
"type": "Interface",
|
|
"label": "HomePublicPluginSetup",
|
|
"description": [],
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.HomePublicPluginSetup.tutorials",
|
|
"type": "Object",
|
|
"label": "tutorials",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/public/plugin.ts",
|
|
"lineNumber": 168
|
|
},
|
|
"signature": [
|
|
"{ setVariable: (key: string, value: unknown) => void; registerDirectoryNotice: (id: string, component: React.FC<{}>) => void; registerDirectoryHeaderLink: (id: string, component: React.FC<{}>) => void; registerModuleNotice: (id: string, component: React.FC<{ moduleName: string; }>) => void; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.HomePublicPluginSetup.featureCatalogue",
|
|
"type": "Object",
|
|
"label": "featureCatalogue",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/public/plugin.ts",
|
|
"lineNumber": 169
|
|
},
|
|
"signature": [
|
|
"{ register: (feature: ",
|
|
{
|
|
"pluginId": "home",
|
|
"scope": "public",
|
|
"docId": "kibHomePluginApi",
|
|
"section": "def-public.FeatureCatalogueEntry",
|
|
"text": "FeatureCatalogueEntry"
|
|
},
|
|
") => void; registerSolution: (solution: ",
|
|
{
|
|
"pluginId": "home",
|
|
"scope": "public",
|
|
"docId": "kibHomePluginApi",
|
|
"section": "def-public.FeatureCatalogueSolution",
|
|
"text": "FeatureCatalogueSolution"
|
|
},
|
|
") => void; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"id": "def-public.HomePublicPluginSetup.environment",
|
|
"type": "Object",
|
|
"label": "environment",
|
|
"description": [
|
|
"\nThe environment service is only available for a transition period and will\nbe replaced by display specific extension points."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/plugin.ts",
|
|
"lineNumber": 176
|
|
},
|
|
"signature": [
|
|
"{ update: (update: Partial<",
|
|
{
|
|
"pluginId": "home",
|
|
"scope": "public",
|
|
"docId": "kibHomePluginApi",
|
|
"section": "def-public.Environment",
|
|
"text": "Environment"
|
|
},
|
|
">) => void; }"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/plugin.ts",
|
|
"lineNumber": 167
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"id": "def-public.HomePublicPluginStart",
|
|
"type": "Interface",
|
|
"label": "HomePublicPluginStart",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.HomePublicPluginStart.featureCatalogue",
|
|
"type": "Object",
|
|
"label": "featureCatalogue",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/public/plugin.ts",
|
|
"lineNumber": 179
|
|
},
|
|
"signature": [
|
|
"FeatureCatalogueRegistry"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/public/plugin.ts",
|
|
"lineNumber": 178
|
|
},
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-server.ArtifactsSchema",
|
|
"type": "Interface",
|
|
"label": "ArtifactsSchema",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ArtifactsSchema.exportedFields",
|
|
"type": "Object",
|
|
"label": "exportedFields",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"signature": [
|
|
"{ documentationUrl: string; } | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ArtifactsSchema.dashboards",
|
|
"type": "Array",
|
|
"label": "dashboards",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
|
"lineNumber": 63
|
|
},
|
|
"signature": [
|
|
"DashboardSchema",
|
|
"[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ArtifactsSchema.application",
|
|
"type": "Object",
|
|
"label": "application",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
|
"lineNumber": 64
|
|
},
|
|
"signature": [
|
|
"{ path: string; label: string; } | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
|
"lineNumber": 59
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"id": "def-server.TutorialsCategory",
|
|
"type": "Enum",
|
|
"label": "TutorialsCategory",
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"id": "def-server.SampleDataRegistrySetup",
|
|
"type": "Type",
|
|
"label": "SampleDataRegistrySetup",
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/server/services/sample_data/sample_data_registry.ts",
|
|
"lineNumber": 168
|
|
},
|
|
"signature": [
|
|
"{ registerSampleDataset: (specProvider: SampleDatasetProvider) => void; getSampleDatasets: () => SampleDatasetSchema<unknown>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: SavedObject<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: AppLinkSchema[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: SampleDatasetDashboardPanel) => void; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.SampleDatasetProvider",
|
|
"type": "Type",
|
|
"label": "SampleDatasetProvider",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts",
|
|
"lineNumber": 82
|
|
},
|
|
"signature": [
|
|
"() => ",
|
|
"SampleDatasetSchema",
|
|
"<unknown>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.TutorialProvider",
|
|
"type": "Type",
|
|
"label": "TutorialProvider",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
|
"lineNumber": 100
|
|
},
|
|
"signature": [
|
|
"(context: ",
|
|
"TutorialContext",
|
|
") => ",
|
|
"TutorialSchema"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"id": "def-server.INSTRUCTION_VARIANT",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.INSTRUCTION_VARIANT.ESC",
|
|
"type": "string",
|
|
"label": "ESC",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 10
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.INSTRUCTION_VARIANT.OSX",
|
|
"type": "string",
|
|
"label": "OSX",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 11
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.INSTRUCTION_VARIANT.DEB",
|
|
"type": "string",
|
|
"label": "DEB",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 12
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.INSTRUCTION_VARIANT.RPM",
|
|
"type": "string",
|
|
"label": "RPM",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 13
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.INSTRUCTION_VARIANT.DOCKER",
|
|
"type": "string",
|
|
"label": "DOCKER",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 14
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.INSTRUCTION_VARIANT.WINDOWS",
|
|
"type": "string",
|
|
"label": "WINDOWS",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 15
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.INSTRUCTION_VARIANT.NODE",
|
|
"type": "string",
|
|
"label": "NODE",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 16
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.INSTRUCTION_VARIANT.DJANGO",
|
|
"type": "string",
|
|
"label": "DJANGO",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 17
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.INSTRUCTION_VARIANT.FLASK",
|
|
"type": "string",
|
|
"label": "FLASK",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 18
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.INSTRUCTION_VARIANT.RAILS",
|
|
"type": "string",
|
|
"label": "RAILS",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 19
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.INSTRUCTION_VARIANT.RACK",
|
|
"type": "string",
|
|
"label": "RACK",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 20
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.INSTRUCTION_VARIANT.JS",
|
|
"type": "string",
|
|
"label": "JS",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 21
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.INSTRUCTION_VARIANT.GO",
|
|
"type": "string",
|
|
"label": "GO",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 22
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.INSTRUCTION_VARIANT.JAVA",
|
|
"type": "string",
|
|
"label": "JAVA",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 23
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.INSTRUCTION_VARIANT.DOTNET",
|
|
"type": "string",
|
|
"label": "DOTNET",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 24
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.INSTRUCTION_VARIANT.LINUX",
|
|
"type": "string",
|
|
"label": "LINUX",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 25
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.INSTRUCTION_VARIANT.PHP",
|
|
"type": "string",
|
|
"label": "PHP",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 26
|
|
}
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "INSTRUCTION_VARIANT",
|
|
"source": {
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"setup": {
|
|
"id": "def-server.HomeServerPluginSetup",
|
|
"type": "Interface",
|
|
"label": "HomeServerPluginSetup",
|
|
"description": [],
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.HomeServerPluginSetup.tutorials",
|
|
"type": "Object",
|
|
"label": "tutorials",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/server/plugin.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"signature": [
|
|
"{ registerTutorial: (specProvider: ",
|
|
{
|
|
"pluginId": "home",
|
|
"scope": "server",
|
|
"docId": "kibHomePluginApi",
|
|
"section": "def-server.TutorialProvider",
|
|
"text": "TutorialProvider"
|
|
},
|
|
") => void; unregisterTutorial: (specProvider: ",
|
|
{
|
|
"pluginId": "home",
|
|
"scope": "server",
|
|
"docId": "kibHomePluginApi",
|
|
"section": "def-server.TutorialProvider",
|
|
"text": "TutorialProvider"
|
|
},
|
|
") => void; addScopedTutorialContextFactory: (scopedTutorialContextFactory: ",
|
|
"ScopedTutorialContextFactory",
|
|
") => void; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.HomeServerPluginSetup.sampleData",
|
|
"type": "Object",
|
|
"label": "sampleData",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/server/plugin.ts",
|
|
"lineNumber": 56
|
|
},
|
|
"signature": [
|
|
"{ registerSampleDataset: (specProvider: ",
|
|
{
|
|
"pluginId": "home",
|
|
"scope": "server",
|
|
"docId": "kibHomePluginApi",
|
|
"section": "def-server.SampleDatasetProvider",
|
|
"text": "SampleDatasetProvider"
|
|
},
|
|
") => void; getSampleDatasets: () => ",
|
|
"SampleDatasetSchema",
|
|
"<unknown>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
|
|
"SavedObject",
|
|
"<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: ",
|
|
"AppLinkSchema",
|
|
"[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ",
|
|
"SampleDatasetDashboardPanel"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/server/plugin.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"id": "def-server.HomeServerPluginStart",
|
|
"type": "Interface",
|
|
"label": "HomeServerPluginStart",
|
|
"description": [],
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.HomeServerPluginStart.tutorials",
|
|
"type": "Object",
|
|
"label": "tutorials",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/server/plugin.ts",
|
|
"lineNumber": 61
|
|
},
|
|
"signature": [
|
|
"{}"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.HomeServerPluginStart.sampleData",
|
|
"type": "Object",
|
|
"label": "sampleData",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/home/server/plugin.ts",
|
|
"lineNumber": 62
|
|
},
|
|
"signature": [
|
|
"{}"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/home/server/plugin.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |