kibana/api_docs/metrics_entities.json
Stacey Gammon 88f9c4ae02
Add support for building a deprecation list with usage (#99154) (#99538)
* Add support for building a deprecation list with usage

* Update API docs
2021-05-06 17:59:11 -04:00

167 lines
4.2 KiB
JSON

{
"id": "metricsEntities",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "metricsEntities",
"id": "def-server.MetricsEntitiesPluginSetup",
"type": "Interface",
"tags": [],
"label": "MetricsEntitiesPluginSetup",
"description": [],
"source": {
"path": "x-pack/plugins/metrics_entities/server/types.ts",
"lineNumber": 14
},
"deprecated": false,
"children": [
{
"parentPluginId": "metricsEntities",
"id": "def-server.MetricsEntitiesPluginSetup.getMetricsEntitiesClient",
"type": "Function",
"tags": [],
"label": "getMetricsEntitiesClient",
"description": [],
"signature": [
"GetMetricsEntitiesClientType"
],
"source": {
"path": "x-pack/plugins/metrics_entities/server/types.ts",
"lineNumber": 15
},
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "metricsEntities",
"id": "def-server.MetricsEntitiesPluginStart",
"type": "Type",
"tags": [],
"label": "MetricsEntitiesPluginStart",
"description": [],
"signature": [
"void"
],
"source": {
"path": "x-pack/plugins/metrics_entities/server/types.ts",
"lineNumber": 18
},
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "metricsEntities",
"id": "def-common.ELASTIC_NAME",
"type": "string",
"tags": [],
"label": "ELASTIC_NAME",
"description": [
"\nGlobal prefix for all the transform jobs"
],
"signature": [
"\"estc\""
],
"source": {
"path": "x-pack/plugins/metrics_entities/common/constants.ts",
"lineNumber": 21
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "metricsEntities",
"id": "def-common.METRICS_ENTITIES_TRANSFORMS",
"type": "string",
"tags": [],
"label": "METRICS_ENTITIES_TRANSFORMS",
"description": [
"\nTransforms route"
],
"source": {
"path": "x-pack/plugins/metrics_entities/common/constants.ts",
"lineNumber": 16
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "metricsEntities",
"id": "def-common.METRICS_ENTITIES_URL",
"type": "string",
"tags": [],
"label": "METRICS_ENTITIES_URL",
"description": [
"\nBase route"
],
"signature": [
"\"/api/metrics_entities\""
],
"source": {
"path": "x-pack/plugins/metrics_entities/common/constants.ts",
"lineNumber": 11
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "metricsEntities",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"metricsEntities\""
],
"source": {
"path": "x-pack/plugins/metrics_entities/common/index.ts",
"lineNumber": 8
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "metricsEntities",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"metrics_entities\""
],
"source": {
"path": "x-pack/plugins/metrics_entities/common/index.ts",
"lineNumber": 9
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}