* Update api docs * update api docs after merge from master # Conflicts: # api_docs/core.json # api_docs/data.json # api_docs/data_index_patterns.json # api_docs/licensing.json # api_docs/saved_objects.json
310 lines
8.4 KiB
JSON
310 lines
8.4 KiB
JSON
{
|
|
"id": "newsfeed",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "newsfeed",
|
|
"id": "def-public.FetchResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FetchResult",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 49
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "newsfeed",
|
|
"id": "def-public.FetchResult.kibanaVersion",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "kibanaVersion",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 50
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "newsfeed",
|
|
"id": "def-public.FetchResult.hasNew",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "hasNew",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "newsfeed",
|
|
"id": "def-public.FetchResult.feedItems",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "feedItems",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "newsfeed",
|
|
"scope": "public",
|
|
"docId": "kibNewsfeedPluginApi",
|
|
"section": "def-public.NewsfeedItem",
|
|
"text": "NewsfeedItem"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 52
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "newsfeed",
|
|
"id": "def-public.FetchResult.error",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"Error | null"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 53
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "newsfeed",
|
|
"id": "def-public.NewsfeedItem",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "NewsfeedItem",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "newsfeed",
|
|
"id": "def-public.NewsfeedItem.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 39
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "newsfeed",
|
|
"id": "def-public.NewsfeedItem.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 40
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "newsfeed",
|
|
"id": "def-public.NewsfeedItem.linkText",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "linkText",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 41
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "newsfeed",
|
|
"id": "def-public.NewsfeedItem.linkUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "linkUrl",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "newsfeed",
|
|
"id": "def-public.NewsfeedItem.badge",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "badge",
|
|
"description": [],
|
|
"signature": [
|
|
"string | null"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "newsfeed",
|
|
"id": "def-public.NewsfeedItem.publishOn",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "publishOn",
|
|
"description": [],
|
|
"signature": [
|
|
"moment.Moment"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "newsfeed",
|
|
"id": "def-public.NewsfeedItem.expireOn",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "expireOn",
|
|
"description": [],
|
|
"signature": [
|
|
"moment.Moment"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "newsfeed",
|
|
"id": "def-public.NewsfeedItem.hash",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "hash",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/types.ts",
|
|
"lineNumber": 46
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "newsfeed",
|
|
"id": "def-public.NewsfeedApiEndpoint",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "NewsfeedApiEndpoint",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/lib/api.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "newsfeed",
|
|
"id": "def-public.NewsfeedPublicPluginSetup",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "NewsfeedPublicPluginSetup",
|
|
"description": [],
|
|
"signature": [
|
|
"{}"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/plugin.tsx",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "newsfeed",
|
|
"id": "def-public.NewsfeedPublicPluginStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "NewsfeedPublicPluginStart",
|
|
"description": [],
|
|
"signature": [
|
|
"{ createNewsFeed$: (endpoint: ",
|
|
{
|
|
"pluginId": "newsfeed",
|
|
"scope": "public",
|
|
"docId": "kibNewsfeedPluginApi",
|
|
"section": "def-public.NewsfeedApiEndpoint",
|
|
"text": "NewsfeedApiEndpoint"
|
|
},
|
|
") => ",
|
|
"Observable",
|
|
"<void | ",
|
|
{
|
|
"pluginId": "newsfeed",
|
|
"scope": "public",
|
|
"docId": "kibNewsfeedPluginApi",
|
|
"section": "def-public.FetchResult",
|
|
"text": "FetchResult"
|
|
},
|
|
" | null>; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/newsfeed/public/plugin.tsx",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false,
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |