218 lines
7.1 KiB
JSON
218 lines
7.1 KiB
JSON
{
|
|
"id": "licenseApiGuard",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "licenseApiGuard",
|
|
"id": "def-server.License",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "License",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/license_api_guard/server/license.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licenseApiGuard",
|
|
"id": "def-server.License.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"({ pluginName, logger }: SetupSettings) => void"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/license_api_guard/server/license.ts",
|
|
"lineNumber": 41
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licenseApiGuard",
|
|
"id": "def-server.License.setup.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ pluginName, logger }",
|
|
"description": [],
|
|
"signature": [
|
|
"SetupSettings"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/license_api_guard/server/license.ts",
|
|
"lineNumber": 41
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "licenseApiGuard",
|
|
"id": "def-server.License.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"({ pluginId, minimumLicenseType, licensing }: StartSettings) => void"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/license_api_guard/server/license.ts",
|
|
"lineNumber": 46
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licenseApiGuard",
|
|
"id": "def-server.License.start.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ pluginId, minimumLicenseType, licensing }",
|
|
"description": [],
|
|
"signature": [
|
|
"StartSettings"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/license_api_guard/server/license.ts",
|
|
"lineNumber": 46
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "licenseApiGuard",
|
|
"id": "def-server.License.guardApiRoute",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "guardApiRoute",
|
|
"description": [],
|
|
"signature": [
|
|
"<Context extends ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.RequestHandlerContext",
|
|
"text": "RequestHandlerContext"
|
|
},
|
|
", Params, Query, Body>(handler: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.RequestHandler",
|
|
"text": "RequestHandler"
|
|
},
|
|
"<Params, Query, Body, Context, any, { custom: <T extends string | Record<string, any> | Error | { message: string | Error; attributes?: Record<string, any> | undefined; } | Buffer | ",
|
|
"Stream",
|
|
" | undefined>(options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.CustomHttpResponseOptions",
|
|
"text": "CustomHttpResponseOptions"
|
|
},
|
|
"<T>) => ",
|
|
"KibanaResponse"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/license_api_guard/server/license.ts",
|
|
"lineNumber": 92
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licenseApiGuard",
|
|
"id": "def-server.License.guardApiRoute.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.RequestHandler",
|
|
"text": "RequestHandler"
|
|
},
|
|
"<Params, Query, Body, Context, any, { custom: <T extends string | Record<string, any> | Error | { message: string | Error; attributes?: Record<string, any> | undefined; } | Buffer | ",
|
|
"Stream",
|
|
" | undefined>(options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.CustomHttpResponseOptions",
|
|
"text": "CustomHttpResponseOptions"
|
|
},
|
|
"<T>) => ",
|
|
"KibanaResponse",
|
|
"<T>; badRequest: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ErrorHttpResponseOptions",
|
|
"text": "ErrorHttpResponseOptions"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/license_api_guard/server/license.ts",
|
|
"lineNumber": 93
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "licenseApiGuard",
|
|
"id": "def-server.License.isEsSecurityEnabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isEsSecurityEnabled",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/license_api_guard/server/license.ts",
|
|
"lineNumber": 116
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |