maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/newsfeed.json
Stacey Gammon 2117e1324c
API DOCS Step 3/3 (#92929) (#93530) 
* update api_docs from gitignore

* api doc files

* Update api_welcome.mdx

* Pretty print json

* Add new lines and extra frontmatter to warn github viewers

* update api_docs with new lines and frontmatter

* Remove all apis tagged @internal and add tests

* Update docs with all internal APIs removed

* fix typescript error in test fixtures

* Update core.json

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
# Conflicts:
#	api_docs/core.json
#	api_docs/core_application.json
#	api_docs/core_http.json
#	api_docs/core_saved_objects.json
2021-03-03 20:12:24 -05:00

275 lines
8.5 KiB
JSON
Raw Blame History

{
"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,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/newsfeed/public/types.ts#L46"
}
},
{
"tags": [],
"id": "def-public.FetchResult.hasNew",
"type": "boolean",
"label": "hasNew",
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 47,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/newsfeed/public/types.ts#L47"
}
},
{
"tags": [],
"id": "def-public.FetchResult.feedItems",
"type": "Array",
"label": "feedItems",
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 48,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/newsfeed/public/types.ts#L48"
},
"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,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/newsfeed/public/types.ts#L49"
},
"signature": [
"Error | null"
]
}
],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 45,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/newsfeed/public/types.ts#L45"
},
"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,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/newsfeed/public/types.ts#L35"
}
},
{
"tags": [],
"id": "def-public.NewsfeedItem.description",
"type": "string",
"label": "description",
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 36,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/newsfeed/public/types.ts#L36"
}
},
{
"tags": [],
"id": "def-public.NewsfeedItem.linkText",
"type": "CompoundType",
"label": "linkText",
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 37,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/newsfeed/public/types.ts#L37"
},
"signature": [
"string | null"
]
},
{
"tags": [],
"id": "def-public.NewsfeedItem.linkUrl",
"type": "string",
"label": "linkUrl",
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 38,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/newsfeed/public/types.ts#L38"
}
},
{
"tags": [],
"id": "def-public.NewsfeedItem.badge",
"type": "CompoundType",
"label": "badge",
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 39,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/newsfeed/public/types.ts#L39"
},
"signature": [
"string | null"
]
},
{
"tags": [],
"id": "def-public.NewsfeedItem.publishOn",
"type": "Object",
"label": "publishOn",
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/newsfeed/public/types.ts#L40"
},
"signature": [
"moment.Moment"
]
},
{
"tags": [],
"id": "def-public.NewsfeedItem.expireOn",
"type": "Object",
"label": "expireOn",
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/newsfeed/public/types.ts#L41"
},
"signature": [
"moment.Moment"
]
},
{
"tags": [],
"id": "def-public.NewsfeedItem.hash",
"type": "string",
"label": "hash",
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/newsfeed/public/types.ts#L42"
}
}
],
"source": {
"path": "src/plugins/newsfeed/public/types.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/newsfeed/public/types.ts#L34"
},
"initialIsOpen": false
}
],
"enums": [
{
"id": "def-public.NewsfeedApiEndpoint",
"type": "Enum",
"label": "NewsfeedApiEndpoint",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/newsfeed/public/lib/api.ts",
"lineNumber": 25,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/newsfeed/public/lib/api.ts#L25"
},
"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,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/newsfeed/public/plugin.tsx#L20"
},
"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,
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/newsfeed/public/plugin.tsx#L21"
},
"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": []
}
}
Reference in a new issue View git blame Copy permalink