cecdcc538e
* Fix links to github * Fix links to github * Update docs to latest * Sort, remove unneccessary path info, reduce tags * Go back to having DocDef create the link to avoid backport conflicts * update api docs
1510 lines
No EOL
44 KiB
JSON
1510 lines
No EOL
44 KiB
JSON
{
|
|
"id": "spaces",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"id": "def-public.getSpaceColor",
|
|
"type": "Function",
|
|
"label": "getSpaceColor",
|
|
"signature": [
|
|
"(space: Partial<",
|
|
{
|
|
"pluginId": "spacesOss",
|
|
"scope": "common",
|
|
"docId": "kibSpacesOssPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">) => string"
|
|
],
|
|
"description": [
|
|
"\nDetermines the color for the provided space.\nIf a color is present on the Space itself, then that is used.\nOtherwise, a color is provided from EUI's Visualization Colors based on the space name.\n"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "space",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "spacesOss",
|
|
"scope": "common",
|
|
"docId": "kibSpacesOssPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
|
|
"lineNumber": 24
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.getSpaceImageUrl",
|
|
"type": "Function",
|
|
"label": "getSpaceImageUrl",
|
|
"signature": [
|
|
"(space: Partial<",
|
|
{
|
|
"pluginId": "spacesOss",
|
|
"scope": "common",
|
|
"docId": "kibSpacesOssPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">) => string"
|
|
],
|
|
"description": [
|
|
"\nDetermines the avatar image for the provided space.\n"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "space",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "spacesOss",
|
|
"scope": "common",
|
|
"docId": "kibSpacesOssPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
|
|
"lineNumber": 64
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
|
|
"lineNumber": 64
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.getSpaceInitials",
|
|
"type": "Function",
|
|
"label": "getSpaceInitials",
|
|
"signature": [
|
|
"(space: Partial<",
|
|
{
|
|
"pluginId": "spacesOss",
|
|
"scope": "common",
|
|
"docId": "kibSpacesOssPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">) => string"
|
|
],
|
|
"description": [
|
|
"\nDetermines the initials for the provided space.\nIf initials are present on the Space itself, then that is used.\nOtherwise, the initials are calculated based off the words in the space name, with a max length of 2 characters.\n"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "space",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "spacesOss",
|
|
"scope": "common",
|
|
"docId": "kibSpacesOssPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
|
|
"lineNumber": 43
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-public.GetSpaceResult",
|
|
"type": "Interface",
|
|
"label": "GetSpaceResult",
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetSpaceResult",
|
|
"text": "GetSpaceResult"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "spacesOss",
|
|
"scope": "common",
|
|
"docId": "kibSpacesOssPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
}
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GetSpaceResult.authorizedPurposes",
|
|
"type": "Object",
|
|
"label": "authorizedPurposes",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"signature": [
|
|
"Record<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetAllSpacesPurpose",
|
|
"text": "GetAllSpacesPurpose"
|
|
},
|
|
", boolean> | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.Space",
|
|
"type": "Interface",
|
|
"label": "Space",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.Space.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 10
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.Space.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 11
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.Space.description",
|
|
"type": "string",
|
|
"label": "description",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.Space.color",
|
|
"type": "string",
|
|
"label": "color",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.Space.initials",
|
|
"type": "string",
|
|
"label": "initials",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.Space.disabledFeatures",
|
|
"type": "Array",
|
|
"label": "disabledFeatures",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"signature": [
|
|
"string[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.Space._reserved",
|
|
"type": "CompoundType",
|
|
"label": "_reserved",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.Space.imageUrl",
|
|
"type": "string",
|
|
"label": "imageUrl",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"id": "def-public.GetAllSpacesPurpose",
|
|
"type": "Type",
|
|
"label": "GetAllSpacesPurpose",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"signature": [
|
|
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\""
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-public.SpacesPluginSetup",
|
|
"type": "Type",
|
|
"label": "SpacesPluginSetup",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/public/plugin.tsx",
|
|
"lineNumber": 39
|
|
},
|
|
"signature": [
|
|
"{}"
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"id": "def-public.SpacesPluginStart",
|
|
"type": "Type",
|
|
"label": "SpacesPluginStart",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/public/plugin.tsx",
|
|
"lineNumber": 40
|
|
},
|
|
"signature": [
|
|
"SpacesApi"
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"id": "def-server.addSpaceIdToPath",
|
|
"type": "Function",
|
|
"label": "addSpaceIdToPath",
|
|
"signature": [
|
|
"(basePath: string, spaceId: string, requestedPath: string) => string"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "basePath",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"lineNumber": 44
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "spaceId",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"lineNumber": 45
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "requestedPath",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"lineNumber": 46
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-server.GetAllSpacesOptions",
|
|
"type": "Interface",
|
|
"label": "GetAllSpacesOptions",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GetAllSpacesOptions.purpose",
|
|
"type": "CompoundType",
|
|
"label": "purpose",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"signature": [
|
|
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\" | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GetAllSpacesOptions.includeAuthorizedPurposes",
|
|
"type": "CompoundType",
|
|
"label": "includeAuthorizedPurposes",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"lineNumber": 10
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.GetSpaceResult",
|
|
"type": "Interface",
|
|
"label": "GetSpaceResult",
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetSpaceResult",
|
|
"text": "GetSpaceResult"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "spacesOss",
|
|
"scope": "common",
|
|
"docId": "kibSpacesOssPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
}
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GetSpaceResult.authorizedPurposes",
|
|
"type": "Object",
|
|
"label": "authorizedPurposes",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"signature": [
|
|
"Record<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetAllSpacesPurpose",
|
|
"text": "GetAllSpacesPurpose"
|
|
},
|
|
", boolean> | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.Space",
|
|
"type": "Interface",
|
|
"label": "Space",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.Space.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 10
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.Space.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 11
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.Space.description",
|
|
"type": "string",
|
|
"label": "description",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.Space.color",
|
|
"type": "string",
|
|
"label": "color",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.Space.initials",
|
|
"type": "string",
|
|
"label": "initials",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.Space.disabledFeatures",
|
|
"type": "Array",
|
|
"label": "disabledFeatures",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"signature": [
|
|
"string[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.Space._reserved",
|
|
"type": "CompoundType",
|
|
"label": "_reserved",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.Space.imageUrl",
|
|
"type": "string",
|
|
"label": "imageUrl",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/spaces_oss/common/types.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.SpacesServiceSetup",
|
|
"type": "Interface",
|
|
"label": "SpacesServiceSetup",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"id": "def-server.SpacesServiceSetup.getSpaceId",
|
|
"type": "Function",
|
|
"label": "getSpaceId",
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => string"
|
|
],
|
|
"description": [
|
|
"\nRetrieves the space id associated with the provided request."
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "request",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 23
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 23
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.SpacesServiceSetup.spaceIdToNamespace",
|
|
"type": "Function",
|
|
"label": "spaceIdToNamespace",
|
|
"signature": [
|
|
"(spaceId: string) => string | undefined"
|
|
],
|
|
"description": [
|
|
"\nConverts the provided space id into the corresponding Saved Objects `namespace` id."
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "spaceId",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 31
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 31
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.SpacesServiceSetup.namespaceToSpaceId",
|
|
"type": "Function",
|
|
"label": "namespaceToSpaceId",
|
|
"signature": [
|
|
"(namespace: string | undefined) => string"
|
|
],
|
|
"description": [
|
|
"\nConverts the provided namespace into the corresponding space id."
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "namespace",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 39
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 39
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.SpacesServiceStart",
|
|
"type": "Interface",
|
|
"label": "SpacesServiceStart",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.SpacesServiceStart.createSpacesClient",
|
|
"type": "Function",
|
|
"label": "createSpacesClient",
|
|
"description": [
|
|
"\nCreates a scoped instance of the SpacesClient."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 46
|
|
},
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => Pick<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "server",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-server.SpacesClient",
|
|
"text": "SpacesClient"
|
|
},
|
|
", \"get\" | \"delete\" | \"create\" | \"update\" | \"getAll\">"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-server.SpacesServiceStart.getSpaceId",
|
|
"type": "Function",
|
|
"label": "getSpaceId",
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => string"
|
|
],
|
|
"description": [
|
|
"\nRetrieves the space id associated with the provided request."
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "request",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 52
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 52
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.SpacesServiceStart.isInDefaultSpace",
|
|
"type": "Function",
|
|
"label": "isInDefaultSpace",
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => boolean"
|
|
],
|
|
"description": [
|
|
"\nIndicates if the provided request is executing within the context of the `default` space."
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "request",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 58
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 58
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.SpacesServiceStart.getActiveSpace",
|
|
"type": "Function",
|
|
"label": "getActiveSpace",
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => Promise<",
|
|
{
|
|
"pluginId": "spacesOss",
|
|
"scope": "common",
|
|
"docId": "kibSpacesOssPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">"
|
|
],
|
|
"description": [
|
|
"\nRetrieves the Space associated with the provided request."
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "request",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 64
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 64
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.SpacesServiceStart.spaceIdToNamespace",
|
|
"type": "Function",
|
|
"label": "spaceIdToNamespace",
|
|
"signature": [
|
|
"(spaceId: string) => string | undefined"
|
|
],
|
|
"description": [
|
|
"\nConverts the provided space id into the corresponding Saved Objects `namespace` id."
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "spaceId",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 70
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 70
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.SpacesServiceStart.namespaceToSpaceId",
|
|
"type": "Function",
|
|
"label": "namespaceToSpaceId",
|
|
"signature": [
|
|
"(namespace: string | undefined) => string"
|
|
],
|
|
"description": [
|
|
"\nConverts the provided namespace into the corresponding space id."
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "namespace",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 76
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 76
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"id": "def-server.GetAllSpacesPurpose",
|
|
"type": "Type",
|
|
"label": "GetAllSpacesPurpose",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"signature": [
|
|
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ISpacesClient",
|
|
"type": "Type",
|
|
"label": "ISpacesClient",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"signature": [
|
|
"{ get: (id: string) => Promise<Space>; delete: (id: string) => Promise<void>; create: (space: Space) => Promise<Space>; update: (id: string, space: Space) => Promise<Space>; getAll: (options?: GetAllSpacesOptions) => Promise<GetSpaceResult[]>; }"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-server.SpacesPluginSetup",
|
|
"type": "Interface",
|
|
"label": "SpacesPluginSetup",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.SpacesPluginSetup.spacesService",
|
|
"type": "Object",
|
|
"label": "spacesService",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/plugin.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "server",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-server.SpacesServiceSetup",
|
|
"text": "SpacesServiceSetup"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.SpacesPluginSetup.spacesClient",
|
|
"type": "Object",
|
|
"label": "spacesClient",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/plugin.ts",
|
|
"lineNumber": 56
|
|
},
|
|
"signature": [
|
|
"{ setClientRepositoryFactory: (factory: ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "server",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-server.SpacesClientRepositoryFactory",
|
|
"text": "SpacesClientRepositoryFactory"
|
|
},
|
|
") => void; registerClientWrapper: (wrapper: ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "server",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-server.SpacesClientWrapper",
|
|
"text": "SpacesClientWrapper"
|
|
},
|
|
") => void; }"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/plugin.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"id": "def-server.SpacesPluginStart",
|
|
"type": "Interface",
|
|
"label": "SpacesPluginStart",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.SpacesPluginStart.spacesService",
|
|
"type": "Object",
|
|
"label": "spacesService",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/plugin.ts",
|
|
"lineNumber": 63
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "server",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-server.SpacesServiceStart",
|
|
"text": "SpacesServiceStart"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/server/plugin.ts",
|
|
"lineNumber": 62
|
|
},
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"id": "def-common.addSpaceIdToPath",
|
|
"type": "Function",
|
|
"label": "addSpaceIdToPath",
|
|
"signature": [
|
|
"(basePath: string, spaceId: string, requestedPath: string) => string"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "basePath",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"lineNumber": 44
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "spaceId",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"lineNumber": 45
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "requestedPath",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"lineNumber": 46
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.getSpaceIdFromPath",
|
|
"type": "Function",
|
|
"label": "getSpaceIdFromPath",
|
|
"signature": [
|
|
"(requestBasePath: string | null | undefined, serverBasePath: string | null | undefined) => { spaceId: string; pathHasExplicitSpaceIdentifier: boolean; }"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "requestBasePath",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"string | null | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"lineNumber": 13
|
|
}
|
|
},
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "serverBasePath",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"string | null | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"lineNumber": 14
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.isReservedSpace",
|
|
"type": "Function",
|
|
"label": "isReservedSpace",
|
|
"signature": [
|
|
"(space: Partial<",
|
|
{
|
|
"pluginId": "spacesOss",
|
|
"scope": "common",
|
|
"docId": "kibSpacesOssPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
"> | null | undefined) => boolean"
|
|
],
|
|
"description": [
|
|
"\nReturns whether the given Space is reserved or not.\n"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "space",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "spacesOss",
|
|
"scope": "common",
|
|
"docId": "kibSpacesOssPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
"> | null | undefined"
|
|
],
|
|
"description": [
|
|
"the space"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/is_reserved_space.ts",
|
|
"lineNumber": 18
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [
|
|
"boolean"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/is_reserved_space.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-common.GetAllSpacesOptions",
|
|
"type": "Interface",
|
|
"label": "GetAllSpacesOptions",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.GetAllSpacesOptions.purpose",
|
|
"type": "CompoundType",
|
|
"label": "purpose",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"signature": [
|
|
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\" | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.GetAllSpacesOptions.includeAuthorizedPurposes",
|
|
"type": "CompoundType",
|
|
"label": "includeAuthorizedPurposes",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"lineNumber": 10
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.GetSpaceResult",
|
|
"type": "Interface",
|
|
"label": "GetSpaceResult",
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetSpaceResult",
|
|
"text": "GetSpaceResult"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "spacesOss",
|
|
"scope": "common",
|
|
"docId": "kibSpacesOssPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
}
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.GetSpaceResult.authorizedPurposes",
|
|
"type": "Object",
|
|
"label": "authorizedPurposes",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"signature": [
|
|
"Record<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetAllSpacesPurpose",
|
|
"text": "GetAllSpacesPurpose"
|
|
},
|
|
", boolean> | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ENTER_SPACE_PATH",
|
|
"type": "string",
|
|
"label": "ENTER_SPACE_PATH",
|
|
"description": [
|
|
"\nThe path to enter a space."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/constants.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"signature": [
|
|
"\"/spaces/enter\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.GetAllSpacesPurpose",
|
|
"type": "Type",
|
|
"label": "GetAllSpacesPurpose",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"signature": [
|
|
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.MAX_SPACE_INITIALS",
|
|
"type": "number",
|
|
"label": "MAX_SPACE_INITIALS",
|
|
"description": [
|
|
"\nThe maximum number of characters allowed in the Space Avatar's initials"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/constants.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"signature": [
|
|
"2"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.SPACE_SEARCH_COUNT_THRESHOLD",
|
|
"type": "number",
|
|
"label": "SPACE_SEARCH_COUNT_THRESHOLD",
|
|
"description": [
|
|
"\nThe minimum number of spaces required to show a search control."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/spaces/common/constants.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"signature": [
|
|
"8"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |