kibana/api_docs/license_api_guard.json
Stacey Gammon 81fd64c838
Remove line numbers from the json files (#107158)
* Stop tracking line numbers

* Updated api docs

* Fix type error and update tests

* wrap label in encodeURIComponent for the links

* Update docs after encodeUriComponent change
2021-08-02 12:57:22 -04:00

710 lines
25 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": [],
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "licenseApiGuard",
"id": "def-server.License.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"({ pluginName, logger }: SetupSettings) => void"
],
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "licenseApiGuard",
"id": "def-server.License.setup.$1",
"type": "Object",
"tags": [],
"label": "{ pluginName, logger }",
"description": [],
"signature": [
"SetupSettings"
],
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "licenseApiGuard",
"id": "def-server.License.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"({ pluginId, minimumLicenseType, licensing }: StartSettings) => void"
],
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "licenseApiGuard",
"id": "def-server.License.start.$1",
"type": "Object",
"tags": [],
"label": "{ pluginId, minimumLicenseType, licensing }",
"description": [],
"signature": [
"StartSettings"
],
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"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",
"<T>; badRequest: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ErrorHttpResponseOptions",
"text": "ErrorHttpResponseOptions"
},
") => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; unauthorized: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ErrorHttpResponseOptions",
"text": "ErrorHttpResponseOptions"
},
") => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; forbidden: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ErrorHttpResponseOptions",
"text": "ErrorHttpResponseOptions"
},
") => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; notFound: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ErrorHttpResponseOptions",
"text": "ErrorHttpResponseOptions"
},
") => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; conflict: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ErrorHttpResponseOptions",
"text": "ErrorHttpResponseOptions"
},
") => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; customError: (options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.CustomHttpResponseOptions",
"text": "CustomHttpResponseOptions"
},
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">) => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; redirected: (options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.RedirectResponseOptions",
"text": "RedirectResponseOptions"
},
") => ",
"KibanaResponse",
"<string | Record<string, any> | Buffer | ",
"Stream",
">; ok: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.HttpResponseOptions",
"text": "HttpResponseOptions"
},
") => ",
"KibanaResponse",
"<string | Record<string, any> | Buffer | ",
"Stream",
">; accepted: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.HttpResponseOptions",
"text": "HttpResponseOptions"
},
") => ",
"KibanaResponse",
"<string | Record<string, any> | Buffer | ",
"Stream",
">; noContent: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.HttpResponseOptions",
"text": "HttpResponseOptions"
},
") => ",
"KibanaResponse",
"<undefined>; }>) => (ctx: Context, request: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<Params, Query, Body, any>, response: { 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"
},
") => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; unauthorized: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ErrorHttpResponseOptions",
"text": "ErrorHttpResponseOptions"
},
") => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; forbidden: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ErrorHttpResponseOptions",
"text": "ErrorHttpResponseOptions"
},
") => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; notFound: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ErrorHttpResponseOptions",
"text": "ErrorHttpResponseOptions"
},
") => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; conflict: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ErrorHttpResponseOptions",
"text": "ErrorHttpResponseOptions"
},
") => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; customError: (options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.CustomHttpResponseOptions",
"text": "CustomHttpResponseOptions"
},
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">) => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; redirected: (options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.RedirectResponseOptions",
"text": "RedirectResponseOptions"
},
") => ",
"KibanaResponse",
"<string | Record<string, any> | Buffer | ",
"Stream",
">; ok: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.HttpResponseOptions",
"text": "HttpResponseOptions"
},
") => ",
"KibanaResponse",
"<string | Record<string, any> | Buffer | ",
"Stream",
">; accepted: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.HttpResponseOptions",
"text": "HttpResponseOptions"
},
") => ",
"KibanaResponse",
"<string | Record<string, any> | Buffer | ",
"Stream",
">; noContent: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.HttpResponseOptions",
"text": "HttpResponseOptions"
},
") => ",
"KibanaResponse",
"<undefined>; }) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.IKibanaResponse",
"text": "IKibanaResponse"
},
"<any> | Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.IKibanaResponse",
"text": "IKibanaResponse"
},
"<any>>"
],
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"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"
},
") => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; unauthorized: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ErrorHttpResponseOptions",
"text": "ErrorHttpResponseOptions"
},
") => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; forbidden: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ErrorHttpResponseOptions",
"text": "ErrorHttpResponseOptions"
},
") => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; notFound: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ErrorHttpResponseOptions",
"text": "ErrorHttpResponseOptions"
},
") => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; conflict: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ErrorHttpResponseOptions",
"text": "ErrorHttpResponseOptions"
},
") => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; customError: (options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.CustomHttpResponseOptions",
"text": "CustomHttpResponseOptions"
},
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">) => ",
"KibanaResponse",
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ResponseError",
"text": "ResponseError"
},
">; redirected: (options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.RedirectResponseOptions",
"text": "RedirectResponseOptions"
},
") => ",
"KibanaResponse",
"<string | Record<string, any> | Buffer | ",
"Stream",
">; ok: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.HttpResponseOptions",
"text": "HttpResponseOptions"
},
") => ",
"KibanaResponse",
"<string | Record<string, any> | Buffer | ",
"Stream",
">; accepted: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.HttpResponseOptions",
"text": "HttpResponseOptions"
},
") => ",
"KibanaResponse",
"<string | Record<string, any> | Buffer | ",
"Stream",
">; noContent: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.HttpResponseOptions",
"text": "HttpResponseOptions"
},
") => ",
"KibanaResponse",
"<undefined>; }>"
],
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "licenseApiGuard",
"id": "def-server.License.isEsSecurityEnabled",
"type": "boolean",
"tags": [],
"label": "isEsSecurityEnabled",
"description": [],
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}