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
258 lines
No EOL
6.8 KiB
JSON
258 lines
No EOL
6.8 KiB
JSON
{
|
|
"id": "newsfeed",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-public.FetchResult",
|
|
"type": "Interface",
|
|
"label": "FetchResult",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FetchResult.kibanaVersion",
|
|
"type": "string",
|
|
"label": "kibanaVersion",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 46
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FetchResult.hasNew",
|
|
"type": "boolean",
|
|
"label": "hasNew",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 47
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FetchResult.feedItems",
|
|
"type": "Array",
|
|
"label": "feedItems",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 48
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "newsfeed",
|
|
"scope": "public",
|
|
"docId": "kibNewsfeedPluginApi",
|
|
"section": "def-public.NewsfeedItem",
|
|
"text": "NewsfeedItem"
|
|
},
|
|
"[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FetchResult.error",
|
|
"type": "CompoundType",
|
|
"label": "error",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 49
|
|
},
|
|
"signature": [
|
|
"Error | null"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.NewsfeedItem",
|
|
"type": "Interface",
|
|
"label": "NewsfeedItem",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.NewsfeedItem.title",
|
|
"type": "string",
|
|
"label": "title",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 35
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.NewsfeedItem.description",
|
|
"type": "string",
|
|
"label": "description",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 36
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.NewsfeedItem.linkText",
|
|
"type": "CompoundType",
|
|
"label": "linkText",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"signature": [
|
|
"string | null"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.NewsfeedItem.linkUrl",
|
|
"type": "string",
|
|
"label": "linkUrl",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 38
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.NewsfeedItem.badge",
|
|
"type": "CompoundType",
|
|
"label": "badge",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 39
|
|
},
|
|
"signature": [
|
|
"string | null"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.NewsfeedItem.publishOn",
|
|
"type": "Object",
|
|
"label": "publishOn",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 40
|
|
},
|
|
"signature": [
|
|
"moment.Moment"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.NewsfeedItem.expireOn",
|
|
"type": "Object",
|
|
"label": "expireOn",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 41
|
|
},
|
|
"signature": [
|
|
"moment.Moment"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.NewsfeedItem.hash",
|
|
"type": "string",
|
|
"label": "hash",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 42
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"id": "def-public.NewsfeedApiEndpoint",
|
|
"type": "Enum",
|
|
"label": "NewsfeedApiEndpoint",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/lib/api.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-public.NewsfeedPublicPluginSetup",
|
|
"type": "Type",
|
|
"label": "NewsfeedPublicPluginSetup",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/plugin.tsx",
|
|
"lineNumber": 20
|
|
},
|
|
"signature": [
|
|
"{}"
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"id": "def-public.NewsfeedPublicPluginStart",
|
|
"type": "Type",
|
|
"label": "NewsfeedPublicPluginStart",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/plugin.tsx",
|
|
"lineNumber": 21
|
|
},
|
|
"signature": [
|
|
"{ createNewsFeed$: (endpoint: NewsfeedApiEndpoint) => Rx.Observable<void | FetchResult | null>; }"
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |