6b8ebbfa18
* Fix links to github * Fix links to github * Update docs to latest * Sort, remove unneccessary path info, reduce tags * Go back to having DocDef create the link to avoid backport conflicts * update api docs # Conflicts: # api_docs/actions.json # api_docs/advanced_settings.json # api_docs/alerting.json # api_docs/apm.json # api_docs/apm_oss.json # api_docs/banners.json # api_docs/beats_management.json # api_docs/bfetch.json # api_docs/canvas.json # api_docs/case.json # api_docs/charts.json # api_docs/cloud.json # api_docs/console.json # api_docs/core.json # api_docs/core_application.json # api_docs/core_chrome.json # api_docs/core_http.json # api_docs/core_saved_objects.json # api_docs/dashboard.json # api_docs/dashboard_enhanced.json # api_docs/dashboard_mode.json # api_docs/data.json # api_docs/data_autocomplete.json # api_docs/data_enhanced.json # api_docs/data_field_formats.json # api_docs/data_index_patterns.json # api_docs/data_query.json # api_docs/data_search.json # api_docs/data_ui.json # api_docs/dev_tools.json # api_docs/discover.json # api_docs/discover_enhanced.json # api_docs/embeddable.json # api_docs/embeddable_enhanced.json # api_docs/encrypted_saved_objects.json # api_docs/enterprise_search.json # api_docs/es_ui_shared.json # api_docs/event_log.json # api_docs/expressions.json # api_docs/features.json # api_docs/file_upload.json # api_docs/fleet.json # api_docs/global_search.json # api_docs/home.json # api_docs/index_lifecycle_management.json # api_docs/index_management.json # api_docs/index_pattern_field_editor.json # api_docs/index_pattern_management.json # api_docs/infra.json # api_docs/ingest_pipelines.json # api_docs/inspector.json # api_docs/kibana_legacy.json # api_docs/kibana_react.json # api_docs/kibana_utils.json # api_docs/lens.json # api_docs/license_management.json # api_docs/licensing.json # api_docs/lists.json # api_docs/management.json # api_docs/maps.json # api_docs/maps_legacy.json # api_docs/ml.json # api_docs/monitoring.json # api_docs/navigation.json # api_docs/newsfeed.json # api_docs/observability.json # api_docs/osquery.json # api_docs/presentation_util.json # api_docs/remote_clusters.json # api_docs/reporting.json # api_docs/rollup.json # api_docs/runtime_fields.json # api_docs/saved_objects.json # api_docs/saved_objects_management.json # api_docs/saved_objects_tagging.json # api_docs/saved_objects_tagging_oss.json # api_docs/security.json # api_docs/security_oss.json # api_docs/security_solution.json # api_docs/share.json # api_docs/snapshot_restore.json # api_docs/spaces.json # api_docs/spaces_oss.json # api_docs/stack_alerts.json # api_docs/task_manager.json # api_docs/telemetry.json # api_docs/telemetry_collection_manager.json # api_docs/telemetry_collection_xpack.json # api_docs/telemetry_management_section.json # api_docs/triggers_actions_ui.json # api_docs/ui_actions.json # api_docs/ui_actions_enhanced.json # api_docs/uptime.json # api_docs/url_forwarding.json # api_docs/usage_collection.json # api_docs/vis_type_timeseries.json # api_docs/visualizations.json
296 lines
No EOL
9.9 KiB
JSON
296 lines
No EOL
9.9 KiB
JSON
{
|
|
"id": "urlForwarding",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"id": "def-public.UrlForwardingPlugin",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "UrlForwardingPlugin",
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-public.UrlForwardingPlugin.setup",
|
|
"type": "Function",
|
|
"label": "setup",
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<{}, { navigateToDefaultApp: ({ overwriteHash }?: { overwriteHash: boolean; }) => void; navigateToLegacyKibanaUrl: (hash: string) => { navigated: boolean; }; getForwards: () => ",
|
|
{
|
|
"pluginId": "urlForwarding",
|
|
"scope": "public",
|
|
"docId": "kibUrlForwardingPluginApi",
|
|
"section": "def-public.ForwardDefinition",
|
|
"text": "ForwardDefinition"
|
|
},
|
|
"[]; }>) => { forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "core",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<{}, { navigateToDefaultApp: ({ overwriteHash }?: { overwriteHash: boolean; }) => void; navigateToLegacyKibanaUrl: (hash: string) => { navigated: boolean; }; getForwards: () => ",
|
|
{
|
|
"pluginId": "urlForwarding",
|
|
"scope": "public",
|
|
"docId": "kibUrlForwardingPluginApi",
|
|
"section": "def-public.ForwardDefinition",
|
|
"text": "ForwardDefinition"
|
|
},
|
|
"[]; }>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/url_forwarding/public/plugin.ts",
|
|
"lineNumber": 27
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/url_forwarding/public/plugin.ts",
|
|
"lineNumber": 27
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.UrlForwardingPlugin.start",
|
|
"type": "Function",
|
|
"label": "start",
|
|
"signature": [
|
|
"({ application, http: { basePath }, uiSettings }: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
", { kibanaLegacy }: { kibanaLegacy: { dashboardConfig: ",
|
|
{
|
|
"pluginId": "kibanaLegacy",
|
|
"scope": "public",
|
|
"docId": "kibKibanaLegacyPluginApi",
|
|
"section": "def-public.DashboardConfig",
|
|
"text": "DashboardConfig"
|
|
},
|
|
"; loadFontAwesome: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }; }) => { navigateToDefaultApp: ({ overwriteHash }?: { overwriteHash: boolean; }) => void; navigateToLegacyKibanaUrl: (hash: string) => { navigated: boolean; }; getForwards: () => ",
|
|
{
|
|
"pluginId": "urlForwarding",
|
|
"scope": "public",
|
|
"docId": "kibUrlForwardingPluginApi",
|
|
"section": "def-public.ForwardDefinition",
|
|
"text": "ForwardDefinition"
|
|
},
|
|
"[]; }"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "{ application, http: { basePath }, uiSettings }",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/url_forwarding/public/plugin.ts",
|
|
"lineNumber": 75
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.UrlForwardingPlugin.start.{-kibanaLegacy }",
|
|
"type": "Object",
|
|
"label": "{ kibanaLegacy }",
|
|
"tags": [],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.UrlForwardingPlugin.start.{-kibanaLegacy }.kibanaLegacy",
|
|
"type": "Object",
|
|
"label": "kibanaLegacy",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/url_forwarding/public/plugin.ts",
|
|
"lineNumber": 76
|
|
},
|
|
"signature": [
|
|
"{ dashboardConfig: ",
|
|
{
|
|
"pluginId": "kibanaLegacy",
|
|
"scope": "public",
|
|
"docId": "kibKibanaLegacyPluginApi",
|
|
"section": "def-public.DashboardConfig",
|
|
"text": "DashboardConfig"
|
|
},
|
|
"; loadFontAwesome: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; }"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/url_forwarding/public/plugin.ts",
|
|
"lineNumber": 76
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/url_forwarding/public/plugin.ts",
|
|
"lineNumber": 74
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.UrlForwardingPlugin.stop",
|
|
"type": "Function",
|
|
"label": "stop",
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/url_forwarding/public/plugin.ts",
|
|
"lineNumber": 115
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/url_forwarding/public/plugin.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-public.ForwardDefinition",
|
|
"type": "Interface",
|
|
"label": "ForwardDefinition",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ForwardDefinition.legacyAppId",
|
|
"type": "string",
|
|
"label": "legacyAppId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/url_forwarding/public/plugin.ts",
|
|
"lineNumber": 17
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ForwardDefinition.newAppId",
|
|
"type": "string",
|
|
"label": "newAppId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/url_forwarding/public/plugin.ts",
|
|
"lineNumber": 18
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ForwardDefinition.rewritePath",
|
|
"type": "Function",
|
|
"label": "rewritePath",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/url_forwarding/public/plugin.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"signature": [
|
|
"(legacyPath: string) => string"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/url_forwarding/public/plugin.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"id": "def-public.UrlForwardingSetup",
|
|
"type": "Type",
|
|
"label": "UrlForwardingSetup",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/url_forwarding/public/plugin.ts",
|
|
"lineNumber": 122
|
|
},
|
|
"signature": [
|
|
"{ forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.UrlForwardingStart",
|
|
"type": "Type",
|
|
"label": "UrlForwardingStart",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/url_forwarding/public/plugin.ts",
|
|
"lineNumber": 123
|
|
},
|
|
"signature": [
|
|
"{ navigateToDefaultApp: ({ overwriteHash }?: { overwriteHash: boolean; }) => void; navigateToLegacyKibanaUrl: (hash: string) => { navigated: boolean; }; getForwards: () => ForwardDefinition[]; }"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |