kibana/api_docs/rollup.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

343 lines
10 KiB
JSON

{
"id": "rollup",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-common.CONFIG_ROLLUPS",
"type": "string",
"label": "CONFIG_ROLLUPS",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/index.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/index.ts#L17"
},
"signature": [
"\"rollups:enableIndexPatterns\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.API_BASE_PATH",
"type": "string",
"label": "API_BASE_PATH",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/index.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/index.ts#L19"
},
"signature": [
"\"/api/rollup\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UIM_APP_NAME",
"type": "string",
"label": "UIM_APP_NAME",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 8,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/ui_metric.ts#L8"
},
"signature": [
"\"rollup_jobs\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UIM_APP_LOAD",
"type": "string",
"label": "UIM_APP_LOAD",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 10,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/ui_metric.ts#L10"
},
"signature": [
"\"app_load\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UIM_JOB_CREATE",
"type": "string",
"label": "UIM_JOB_CREATE",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/ui_metric.ts#L11"
},
"signature": [
"\"job_create\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UIM_JOB_DELETE",
"type": "string",
"label": "UIM_JOB_DELETE",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 12,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/ui_metric.ts#L12"
},
"signature": [
"\"job_delete\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UIM_JOB_DELETE_MANY",
"type": "string",
"label": "UIM_JOB_DELETE_MANY",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/ui_metric.ts#L13"
},
"signature": [
"\"job_delete_many\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UIM_JOB_START",
"type": "string",
"label": "UIM_JOB_START",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/ui_metric.ts#L14"
},
"signature": [
"\"job_start\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UIM_JOB_START_MANY",
"type": "string",
"label": "UIM_JOB_START_MANY",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/ui_metric.ts#L15"
},
"signature": [
"\"job_start_many\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UIM_JOB_STOP",
"type": "string",
"label": "UIM_JOB_STOP",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/ui_metric.ts#L16"
},
"signature": [
"\"job_stop\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UIM_JOB_STOP_MANY",
"type": "string",
"label": "UIM_JOB_STOP_MANY",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/ui_metric.ts#L17"
},
"signature": [
"\"job_stop_many\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UIM_SHOW_DETAILS_CLICK",
"type": "string",
"label": "UIM_SHOW_DETAILS_CLICK",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/ui_metric.ts#L18"
},
"signature": [
"\"show_details_click\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UIM_DETAIL_PANEL_SUMMARY_TAB_CLICK",
"type": "string",
"label": "UIM_DETAIL_PANEL_SUMMARY_TAB_CLICK",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/ui_metric.ts#L19"
},
"signature": [
"\"detail_panel_summary_tab_click\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UIM_DETAIL_PANEL_TERMS_TAB_CLICK",
"type": "string",
"label": "UIM_DETAIL_PANEL_TERMS_TAB_CLICK",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/ui_metric.ts#L20"
},
"signature": [
"\"detail_panel_terms_tab_click\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UIM_DETAIL_PANEL_HISTOGRAM_TAB_CLICK",
"type": "string",
"label": "UIM_DETAIL_PANEL_HISTOGRAM_TAB_CLICK",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/ui_metric.ts#L21"
},
"signature": [
"\"detail_panel_histogram_tab_click\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UIM_DETAIL_PANEL_METRICS_TAB_CLICK",
"type": "string",
"label": "UIM_DETAIL_PANEL_METRICS_TAB_CLICK",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 22,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/ui_metric.ts#L22"
},
"signature": [
"\"detail_panel_metrics_tab_click\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UIM_DETAIL_PANEL_JSON_TAB_CLICK",
"type": "string",
"label": "UIM_DETAIL_PANEL_JSON_TAB_CLICK",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/ui_metric.ts",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/ui_metric.ts#L23"
},
"signature": [
"\"detail_panel_json_tab_click\""
],
"initialIsOpen": false
}
],
"objects": [
{
"id": "def-common.PLUGIN",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PLUGIN.ID",
"type": "string",
"label": "ID",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/index.ts",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/index.ts#L13"
}
},
{
"tags": [],
"id": "def-common.PLUGIN.minimumLicenseType",
"type": "string",
"label": "minimumLicenseType",
"description": [],
"source": {
"path": "x-pack/plugins/rollup/common/index.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/index.ts#L14"
},
"signature": [
"\"basic\""
]
}
],
"description": [],
"label": "PLUGIN",
"source": {
"path": "x-pack/plugins/rollup/common/index.ts",
"lineNumber": 12,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/rollup/common/index.ts#L12"
},
"initialIsOpen": false
}
]
}
}