8aa370ba3b
* Add explicit security types * Remove sessionTimeout, seems unused * add comments * Add comments and fix test since removing the unused APIs * remove unused import * wording cleanup * Export some types that are part of the public API but not exported * more improvements for api docs * update security docs * Update x-pack/plugins/security/public/nav_control/nav_control_service.tsx Co-authored-by: Larry Gregory <lgregorydev@gmail.com> * Update x-pack/plugins/security/public/nav_control/nav_control_service.tsx Co-authored-by: Larry Gregory <lgregorydev@gmail.com> * Update x-pack/plugins/security/public/plugin.tsx Co-authored-by: Larry Gregory <lgregorydev@gmail.com> * Update x-pack/plugins/security/public/plugin.tsx Co-authored-by: Larry Gregory <lgregorydev@gmail.com> * remove unneccessary readonly prefix * Update all api docs Co-authored-by: Larry Gregory <lgregorydev@gmail.com>
205 lines
6.7 KiB
JSON
205 lines
6.7 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": [
|
|
"(esClient: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.ElasticsearchClient",
|
|
"text": "ElasticsearchClient"
|
|
},
|
|
") => ",
|
|
"MetricsEntitiesClient"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/metrics_entities/server/types.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "metricsEntities",
|
|
"id": "def-server.esClient",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "esClient",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
"KibanaClient",
|
|
", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"helpers\" | \"count\" | \"search\" | \"security\" | \"eql\" | \"on\" | \"off\" | \"transform\" | \"emit\" | \"once\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"fleet\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"monitoring\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"shutdown\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termsEnum\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ",
|
|
"TransportRequestParams",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): ",
|
|
"TransportRequestPromise",
|
|
"<",
|
|
"ApiResponse",
|
|
"<Record<string, any>, unknown>>; }; }"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/metrics_entities/server/types.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"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": []
|
|
}
|
|
} |