2021-03-04 02:12:24 +01:00
{
"id" : "spaces" ,
"client" : {
"classes" : [ ] ,
"functions" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.getSpaceColor" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "getSpaceColor" ,
2021-05-06 23:59:11 +02:00
"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"
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"(space: Partial<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
">) => string"
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts" ,
"lineNumber" : 24
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-public.getSpaceColor.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "space" ,
2021-05-06 23:59:11 +02:00
"description" : [
"the space."
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"Partial<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
">"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 24
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.getSpaceImageUrl" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "getSpaceImageUrl" ,
2021-05-06 23:59:11 +02:00
"description" : [
"\nDetermines the avatar image for the provided space.\n"
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"(space: Partial<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
">) => string"
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts" ,
"lineNumber" : 64
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-public.getSpaceImageUrl.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "space" ,
2021-05-06 23:59:11 +02:00
"description" : [
"the space."
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"Partial<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
">"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 64
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.getSpaceInitials" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "getSpaceInitials" ,
2021-05-06 23:59:11 +02:00
"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"
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"(space: Partial<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
">) => string"
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts" ,
"lineNumber" : 43
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-public.getSpaceInitials.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "space" ,
2021-05-06 23:59:11 +02:00
"description" : [
"the space."
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"Partial<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
">"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 43
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
}
] ,
"interfaces" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.GetSpaceResult" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "GetSpaceResult" ,
2021-05-06 23:59:11 +02:00
"description" : [
"\nResponse format when querying for spaces."
] ,
2021-03-04 02:12:24 +01:00
"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"
}
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 47
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.GetSpaceResult.authorizedPurposes" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "authorizedPurposes" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nA set of flags indicating which purposes the user is authorized for."
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"Record<" ,
{
"pluginId" : "spaces" ,
"scope" : "common" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-common.GetAllSpacesPurpose" ,
"text" : "GetAllSpacesPurpose"
} ,
", boolean> | undefined"
2021-05-06 23:59:11 +02:00
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 51
} ,
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.Space" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "Space" ,
2021-05-05 18:45:41 +02:00
"description" : [
2021-05-06 21:08:20 +02:00
"\nA Space."
2021-05-05 18:45:41 +02:00
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
"lineNumber" : 12
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.Space.id" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "id" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nThe unique identifier for this space.\nThe id becomes part of the \"URL Identifier\" of the space.\n\nExample: an id of `marketing` would result in the URL identifier of `/s/marketing`."
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 19
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.Space.name" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "name" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nDisplay name for this space."
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 24
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.Space.description" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "description" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nOptional description for this space."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | undefined"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 29
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.Space.color" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "color" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nOptional color (hex code) for this space.\nIf neither `color` nor `imageUrl` is specified, then a color will be automatically generated."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | undefined"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 35
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.Space.initials" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "initials" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nOptional display initials for this space's avatar. Supports a maximum of 2 characters.\nIf initials are not provided, then they will be derived from the space name automatically.\n\nInitials are not displayed if an `imageUrl` has been specified."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | undefined"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 43
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-public.Space.imageUrl" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-05 18:45:41 +02:00
"label" : "imageUrl" ,
"description" : [
"\nOptional base-64 encoded data image url to show as this space's avatar.\nThis setting takes precedence over any configured `color` or `initials`."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | undefined"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 49
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-public.Space.disabledFeatures" ,
"type" : "Array" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-05 18:45:41 +02:00
"label" : "disabledFeatures" ,
"description" : [
"\nThe set of feature ids that should be hidden within this space."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string[]"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 54
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
"id" : "def-public.Space._reserved" ,
"type" : "CompoundType" ,
2021-05-05 18:45:41 +02:00
"tags" : [
"private"
] ,
"label" : "_reserved" ,
"description" : [
"\nIndicates that this space is reserved (system controlled).\nReserved spaces cannot be created or deleted by end-users."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"boolean | undefined"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 61
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.GetAllSpacesPurpose" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "GetAllSpacesPurpose" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nThe set of purposes to retrieve spaces:\n- `any`: retrieves all spaces the user is authorized to see.\n- `copySavedObjectsIntoSpace`: retrieves all spaces the user is authorized to copy saved objects into.\n- `findSavedObjects`: retrieves all spaces the user is authorized to search within.\n- `shareSavedObjectsIntoSpace`: retrieves all spaces the user is authorized to share saved objects into."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\""
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 38
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
}
] ,
"objects" : [ ] ,
"setup" : {
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.SpacesPluginSetup" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "SpacesPluginSetup" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nSetup contract for the Spaces plugin."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"{}"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/public/plugin.tsx" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 42
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-public.SpacesPluginStart" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "SpacesPluginStart" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nStart contract for the Spaces plugin."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-05-20 22:11:31 +02:00
{
"pluginId" : "spacesOss" ,
"scope" : "public" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-public.SpacesApi" ,
"text" : "SpacesApi"
}
2021-05-06 23:59:11 +02:00
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/public/plugin.tsx" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 47
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"server" : {
"classes" : [ ] ,
"functions" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.addSpaceIdToPath" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "addSpaceIdToPath" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nGiven a server base path, space id, and requested resource, this will construct a space-aware path\nthat includes a URL identifier with the space id.\n"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"(basePath: string, spaceId: string, requestedPath: string) => string"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
"lineNumber" : 61
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-server.addSpaceIdToPath.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "basePath" ,
2021-05-05 18:45:41 +02:00
"description" : [
"the server's base path."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 62
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-server.addSpaceIdToPath.$2" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "spaceId" ,
2021-05-05 18:45:41 +02:00
"description" : [
"the space id."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 63
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-server.addSpaceIdToPath.$3" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "requestedPath" ,
2021-05-05 18:45:41 +02:00
"description" : [
"the requested path (e.g. `/app/dashboard`)."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 64
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
2021-05-05 18:45:41 +02:00
"returnComment" : [
"the space-aware version of the requested path, inclusive of the server's base path."
] ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
}
] ,
"interfaces" : [
2021-03-06 16:05:27 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.GetAllSpacesOptions" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "GetAllSpacesOptions" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nControls how spaces are retrieved."
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 13
} ,
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
"id" : "def-server.GetAllSpacesOptions.purpose" ,
"type" : "CompoundType" ,
2021-05-05 18:45:41 +02:00
"tags" : [
"see"
] ,
2021-03-06 16:05:27 +01:00
"label" : "purpose" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nAn optional purpose describing how the set of spaces will be used.\nThe default purpose (`any`) will retrieve all spaces the user is authorized to see,\nwhereas a more specific purpose will retrieve all spaces the user is authorized to perform a specific action within.\n"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\" | undefined"
] ,
2021-03-06 16:05:27 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 21
2021-03-06 16:05:27 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
"id" : "def-server.GetAllSpacesOptions.includeAuthorizedPurposes" ,
"type" : "CompoundType" ,
2021-05-05 18:45:41 +02:00
"tags" : [
"see"
] ,
2021-03-06 16:05:27 +01:00
"label" : "includeAuthorizedPurposes" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nSet to true to return a set of flags indicating which purposes the user is authorized for.\n"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"boolean | undefined"
] ,
2021-03-06 16:05:27 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 28
2021-03-06 16:05:27 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.GetSpaceResult" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "GetSpaceResult" ,
2021-05-06 23:59:11 +02:00
"description" : [
"\nResponse format when querying for spaces."
] ,
2021-03-06 16:05:27 +01:00
"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"
}
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 47
} ,
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.GetSpaceResult.authorizedPurposes" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "authorizedPurposes" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nA set of flags indicating which purposes the user is authorized for."
] ,
2021-03-06 16:05:27 +01:00
"signature" : [
"Record<" ,
{
"pluginId" : "spaces" ,
"scope" : "common" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-common.GetAllSpacesPurpose" ,
"text" : "GetAllSpacesPurpose"
} ,
", boolean> | undefined"
2021-05-06 23:59:11 +02:00
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 51
} ,
"deprecated" : false
2021-03-06 16:05:27 +01:00
}
] ,
2021-05-05 18:45:41 +02:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-server.ISpacesClient" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-05 18:45:41 +02:00
"label" : "ISpacesClient" ,
"description" : [
"\nClient interface for interacting with spaces."
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 35
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-05-05 18:45:41 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-server.ISpacesClient.getAll" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-05 18:45:41 +02:00
"label" : "getAll" ,
2021-05-06 23:59:11 +02:00
"description" : [
"\nRetrieve all available spaces."
] ,
2021-05-05 18:45:41 +02:00
"signature" : [
"(options?: " ,
{
"pluginId" : "spaces" ,
"scope" : "common" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-common.GetAllSpacesOptions" ,
"text" : "GetAllSpacesOptions"
} ,
" | undefined) => Promise<" ,
{
"pluginId" : "spaces" ,
"scope" : "common" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-common.GetSpaceResult" ,
"text" : "GetSpaceResult"
} ,
"[]>"
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 40
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-05-05 18:45:41 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-server.ISpacesClient.getAll.$1" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-05 18:45:41 +02:00
"label" : "options" ,
2021-05-06 23:59:11 +02:00
"description" : [
"controls which spaces are retrieved."
] ,
2021-05-05 18:45:41 +02:00
"signature" : [
{
"pluginId" : "spaces" ,
"scope" : "common" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-common.GetAllSpacesOptions" ,
"text" : "GetAllSpacesOptions"
} ,
" | undefined"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 40
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : false
2021-05-05 18:45:41 +02:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-05-05 18:45:41 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-server.ISpacesClient.get" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-05 18:45:41 +02:00
"label" : "get" ,
2021-05-06 23:59:11 +02:00
"description" : [
"\nRetrieve a space by its id."
] ,
2021-05-05 18:45:41 +02:00
"signature" : [
"(id: string) => Promise<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
">"
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 46
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-05-05 18:45:41 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-server.ISpacesClient.get.$1" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-05 18:45:41 +02:00
"label" : "id" ,
"description" : [
"the space id."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string"
] ,
2021-05-05 18:45:41 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 46
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-05-05 18:45:41 +02:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-05-05 18:45:41 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-server.ISpacesClient.create" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-05 18:45:41 +02:00
"label" : "create" ,
2021-05-06 23:59:11 +02:00
"description" : [
"\nCreates a space."
] ,
2021-05-05 18:45:41 +02:00
"signature" : [
"(space: " ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
") => Promise<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
">"
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 52
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-05-05 18:45:41 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-server.ISpacesClient.create.$1" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-05 18:45:41 +02:00
"label" : "space" ,
2021-05-06 23:59:11 +02:00
"description" : [
"the space to create."
] ,
2021-05-05 18:45:41 +02:00
"signature" : [
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
}
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 52
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-05-05 18:45:41 +02:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-05-05 18:45:41 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-server.ISpacesClient.update" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-05 18:45:41 +02:00
"label" : "update" ,
2021-05-06 23:59:11 +02:00
"description" : [
"\nUpdates a space."
] ,
2021-05-05 18:45:41 +02:00
"signature" : [
"(id: string, space: " ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
") => Promise<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
">"
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 59
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-05-05 18:45:41 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-server.ISpacesClient.update.$1" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-05 18:45:41 +02:00
"label" : "id" ,
"description" : [
"the id of the space to update."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string"
] ,
2021-05-05 18:45:41 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 59
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-05-05 18:45:41 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-server.ISpacesClient.update.$2" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-05 18:45:41 +02:00
"label" : "space" ,
2021-05-06 23:59:11 +02:00
"description" : [
"the updated space."
] ,
2021-05-05 18:45:41 +02:00
"signature" : [
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
}
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 59
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-05-05 18:45:41 +02:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-05-05 18:45:41 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-server.ISpacesClient.delete" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-05 18:45:41 +02:00
"label" : "delete" ,
"description" : [
"\nDeletes a space, and all saved objects belonging to that space."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"(id: string) => Promise<void>"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 65
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
2021-05-05 18:45:41 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-server.ISpacesClient.delete.$1" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-05 18:45:41 +02:00
"label" : "id" ,
"description" : [
"the id of the space to delete."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string"
] ,
2021-05-05 18:45:41 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 65
} ,
"deprecated" : false ,
"isRequired" : true
}
] ,
"returnComment" : [ ]
} ,
{
"parentPluginId" : "spaces" ,
"id" : "def-server.ISpacesClient.disableLegacyUrlAliases" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "disableLegacyUrlAliases" ,
"description" : [
"\nDisables the specified legacy URL aliases."
] ,
"signature" : [
"(aliases: " ,
{
"pluginId" : "spaces" ,
"scope" : "common" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-common.LegacyUrlAliasTarget" ,
"text" : "LegacyUrlAliasTarget"
} ,
"[]) => Promise<void>"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts" ,
"lineNumber" : 71
} ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "spaces" ,
"id" : "def-server.ISpacesClient.disableLegacyUrlAliases.$1" ,
"type" : "Array" ,
"tags" : [ ] ,
"label" : "aliases" ,
"description" : [
"the aliases to disable."
] ,
"signature" : [
{
"pluginId" : "spaces" ,
"scope" : "common" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-common.LegacyUrlAliasTarget" ,
"text" : "LegacyUrlAliasTarget"
} ,
"[]"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts" ,
"lineNumber" : 71
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-05-05 18:45:41 +02:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-05-05 18:45:41 +02:00
}
] ,
2021-03-06 16:05:27 +01:00
"initialIsOpen" : false
} ,
2021-06-30 19:04:59 +02:00
{
"parentPluginId" : "spaces" ,
"id" : "def-server.LegacyUrlAliasTarget" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "LegacyUrlAliasTarget" ,
"description" : [
"\nClient interface for interacting with legacy URL aliases."
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 57
} ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "spaces" ,
"id" : "def-server.LegacyUrlAliasTarget.targetSpace" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "targetSpace" ,
"description" : [
"\nThe namespace that the object existed in when it was converted."
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 61
} ,
"deprecated" : false
} ,
{
"parentPluginId" : "spaces" ,
"id" : "def-server.LegacyUrlAliasTarget.targetType" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "targetType" ,
"description" : [
"\nThe type of the object when it was converted."
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 65
} ,
"deprecated" : false
} ,
{
"parentPluginId" : "spaces" ,
"id" : "def-server.LegacyUrlAliasTarget.sourceId" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "sourceId" ,
"description" : [
"\nThe original ID of the object, before it was converted."
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 69
} ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
} ,
2021-03-06 16:05:27 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.Space" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "Space" ,
2021-05-05 18:45:41 +02:00
"description" : [
2021-05-06 21:08:20 +02:00
"\nA Space."
2021-05-05 18:45:41 +02:00
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
"lineNumber" : 12
} ,
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.Space.id" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "id" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nThe unique identifier for this space.\nThe id becomes part of the \"URL Identifier\" of the space.\n\nExample: an id of `marketing` would result in the URL identifier of `/s/marketing`."
] ,
2021-03-06 16:05:27 +01:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 19
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.Space.name" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "name" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nDisplay name for this space."
] ,
2021-03-06 16:05:27 +01:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 24
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.Space.description" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "description" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nOptional description for this space."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | undefined"
] ,
2021-03-06 16:05:27 +01:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 29
2021-03-06 16:05:27 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.Space.color" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "color" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nOptional color (hex code) for this space.\nIf neither `color` nor `imageUrl` is specified, then a color will be automatically generated."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | undefined"
] ,
2021-03-06 16:05:27 +01:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 35
2021-03-06 16:05:27 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.Space.initials" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "initials" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nOptional display initials for this space's avatar. Supports a maximum of 2 characters.\nIf initials are not provided, then they will be derived from the space name automatically.\n\nInitials are not displayed if an `imageUrl` has been specified."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | undefined"
] ,
2021-03-06 16:05:27 +01:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 43
2021-03-06 16:05:27 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-server.Space.imageUrl" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-05 18:45:41 +02:00
"label" : "imageUrl" ,
"description" : [
"\nOptional base-64 encoded data image url to show as this space's avatar.\nThis setting takes precedence over any configured `color` or `initials`."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | undefined"
] ,
2021-03-06 16:05:27 +01:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 49
2021-03-06 16:05:27 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-server.Space.disabledFeatures" ,
"type" : "Array" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-05-05 18:45:41 +02:00
"label" : "disabledFeatures" ,
"description" : [
"\nThe set of feature ids that should be hidden within this space."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string[]"
] ,
2021-03-06 16:05:27 +01:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 54
2021-03-06 16:05:27 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
"id" : "def-server.Space._reserved" ,
"type" : "CompoundType" ,
2021-05-05 18:45:41 +02:00
"tags" : [
"private"
] ,
"label" : "_reserved" ,
"description" : [
"\nIndicates that this space is reserved (system controlled).\nReserved spaces cannot be created or deleted by end-users."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"boolean | undefined"
] ,
2021-03-06 16:05:27 +01:00
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 61
2021-03-06 16:05:27 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-06 16:05:27 +01:00
}
] ,
"initialIsOpen" : false
} ,
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.SpacesServiceSetup" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "SpacesServiceSetup" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nThe Spaces service setup contract."
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
"lineNumber" : 19
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.SpacesServiceSetup.getSpaceId" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [
"deprecated"
] ,
2021-03-04 02:12:24 +01:00
"label" : "getSpaceId" ,
2021-05-06 23:59:11 +02:00
"description" : [
"\nRetrieves the space id associated with the provided request."
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"(request: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>) => string"
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
"lineNumber" : 27
} ,
"deprecated" : true ,
"removeBy" : "7.16" ,
"references" : [
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/audit/audit_service.ts" ,
"lineNumber" : 56
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_privileges_dynamically.ts" ,
"lineNumber" : 34
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/plugin.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 266
2021-05-06 23:59:11 +02:00
}
} ,
{
"plugin" : "reporting" ,
"link" : {
"path" : "x-pack/plugins/reporting/server/core.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 269
2021-05-06 23:59:11 +02:00
}
} ,
{
"plugin" : "apm" ,
"link" : {
"path" : "x-pack/plugins/apm/server/routes/index_pattern.ts" ,
"lineNumber" : 33
}
} ,
{
"plugin" : "infra" ,
"link" : {
"path" : "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts" ,
"lineNumber" : 239
}
} ,
{
"plugin" : "infra" ,
"link" : {
"path" : "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts" ,
"lineNumber" : 241
}
} ,
{
"plugin" : "infra" ,
"link" : {
"path" : "x-pack/plugins/infra/server/plugin.ts" ,
"lineNumber" : 153
}
} ,
2021-05-31 19:33:12 +02:00
{
"plugin" : "securitySolution" ,
"link" : {
"path" : "x-pack/plugins/security_solution/server/plugin.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 190
2021-05-31 19:33:12 +02:00
}
} ,
2021-05-06 23:59:11 +02:00
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_privileges_dynamically.test.ts" ,
"lineNumber" : 24
}
}
] ,
"children" : [
{
"parentPluginId" : "spaces" ,
"id" : "def-server.SpacesServiceSetup.getSpaceId.$1" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "request" ,
2021-05-05 18:45:41 +02:00
"description" : [
"the request."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 27
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.SpacesServiceSetup.spaceIdToNamespace" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [
"deprecated"
2021-03-04 02:12:24 +01:00
] ,
2021-05-06 23:59:11 +02:00
"label" : "spaceIdToNamespace" ,
2021-03-04 02:12:24 +01:00
"description" : [
"\nConverts the provided space id into the corresponding Saved Objects `namespace` id."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"(spaceId: string) => string | undefined"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
"lineNumber" : 36
} ,
"deprecated" : true ,
"removeBy" : "7.16" ,
"references" : [ ] ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-server.SpacesServiceSetup.spaceIdToNamespace.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "spaceId" ,
2021-05-05 18:45:41 +02:00
"description" : [
"the space id to convert."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 36
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.SpacesServiceSetup.namespaceToSpaceId" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [
"deprecated"
] ,
2021-03-04 02:12:24 +01:00
"label" : "namespaceToSpaceId" ,
2021-05-06 23:59:11 +02:00
"description" : [
"\nConverts the provided namespace into the corresponding space id."
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"(namespace: string | undefined) => string"
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
"lineNumber" : 45
} ,
"deprecated" : true ,
"removeBy" : "7.16" ,
"references" : [
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.ts" ,
"lineNumber" : 48
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.ts" ,
"lineNumber" : 56
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/saved_objects/secure_saved_objects_client_wrapper.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 1004
2021-05-06 23:59:11 +02:00
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/saved_objects/secure_saved_objects_client_wrapper.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 1031
2021-05-06 23:59:11 +02:00
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_privileges_dynamically.test.ts" ,
"lineNumber" : 25
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts" ,
"lineNumber" : 66
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts" ,
"lineNumber" : 67
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts" ,
"lineNumber" : 68
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts" ,
"lineNumber" : 72
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts" ,
"lineNumber" : 85
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts" ,
"lineNumber" : 86
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts" ,
"lineNumber" : 87
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts" ,
"lineNumber" : 88
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts" ,
"lineNumber" : 89
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts" ,
"lineNumber" : 94
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts" ,
"lineNumber" : 95
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts" ,
"lineNumber" : 142
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts" ,
"lineNumber" : 143
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts" ,
"lineNumber" : 147
}
}
2021-03-04 02:12:24 +01:00
] ,
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-server.SpacesServiceSetup.namespaceToSpaceId.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "namespace" ,
2021-05-05 18:45:41 +02:00
"description" : [
"the namespace to convert."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | undefined"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 45
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : false
2021-03-04 02:12:24 +01:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.SpacesServiceStart" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "SpacesServiceStart" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nThe Spaces service start contract."
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
"lineNumber" : 51
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.SpacesServiceStart.createSpacesClient" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "createSpacesClient" ,
"description" : [
"\nCreates a scoped instance of the SpacesClient."
] ,
"signature" : [
"(request: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
2021-05-05 18:45:41 +02:00
"<unknown, unknown, unknown, any>) => " ,
{
"pluginId" : "spaces" ,
"scope" : "server" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-server.ISpacesClient" ,
"text" : "ISpacesClient"
}
2021-05-06 23:59:11 +02:00
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
"lineNumber" : 56
} ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "spaces" ,
"id" : "def-server.request" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "request" ,
"description" : [
"the request."
] ,
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
"lineNumber" : 56
} ,
"deprecated" : false
}
]
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.SpacesServiceStart.getSpaceId" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "getSpaceId" ,
2021-05-06 23:59:11 +02:00
"description" : [
"\nRetrieves the space id associated with the provided request."
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"(request: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>) => string"
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
"lineNumber" : 62
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-server.SpacesServiceStart.getSpaceId.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "request" ,
2021-05-06 23:59:11 +02:00
"description" : [
"the request."
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 62
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.SpacesServiceStart.isInDefaultSpace" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "isInDefaultSpace" ,
2021-05-06 23:59:11 +02:00
"description" : [
"\nIndicates if the provided request is executing within the context of the `default` space."
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"(request: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>) => boolean"
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
"lineNumber" : 68
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-server.SpacesServiceStart.isInDefaultSpace.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "request" ,
2021-05-06 23:59:11 +02:00
"description" : [
"the request."
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 68
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.SpacesServiceStart.getActiveSpace" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "getActiveSpace" ,
2021-05-06 23:59:11 +02:00
"description" : [
"\nRetrieves the Space associated with the provided request."
] ,
2021-03-04 02:12:24 +01:00
"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"
} ,
">"
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
"lineNumber" : 74
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-server.SpacesServiceStart.getActiveSpace.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "request" ,
2021-05-06 23:59:11 +02:00
"description" : [
"the request."
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 74
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.SpacesServiceStart.spaceIdToNamespace" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "spaceIdToNamespace" ,
"description" : [
"\nConverts the provided space id into the corresponding Saved Objects `namespace` id."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"(spaceId: string) => string | undefined"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
"lineNumber" : 80
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-server.SpacesServiceStart.spaceIdToNamespace.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "spaceId" ,
2021-05-05 18:45:41 +02:00
"description" : [
"the space id to convert."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 80
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.SpacesServiceStart.namespaceToSpaceId" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "namespaceToSpaceId" ,
"description" : [
"\nConverts the provided namespace into the corresponding space id."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"(namespace: string | undefined) => string"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
"lineNumber" : 86
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-server.SpacesServiceStart.namespaceToSpaceId.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "namespace" ,
2021-05-05 18:45:41 +02:00
"description" : [
"the namespace to convert."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | undefined"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 86
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : false
2021-03-04 02:12:24 +01:00
}
] ,
2021-05-06 23:59:11 +02:00
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
2021-03-06 16:05:27 +01:00
}
] ,
"enums" : [ ] ,
"misc" : [
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.GetAllSpacesPurpose" ,
"type" : "Type" ,
2021-03-04 02:12:24 +01:00
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "GetAllSpacesPurpose" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nThe set of purposes to retrieve spaces:\n- `any`: retrieves all spaces the user is authorized to see.\n- `copySavedObjectsIntoSpace`: retrieves all spaces the user is authorized to copy saved objects into.\n- `findSavedObjects`: retrieves all spaces the user is authorized to search within.\n- `shareSavedObjectsIntoSpace`: retrieves all spaces the user is authorized to share saved objects into."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\""
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 38
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-server.SpacesClientRepositoryFactory" ,
2021-03-06 16:05:27 +01:00
"type" : "Type" ,
2021-05-05 18:45:41 +02:00
"tags" : [
"private"
] ,
2021-05-06 23:59:11 +02:00
"label" : "SpacesClientRepositoryFactory" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nFor consumption by the security plugin only."
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
2021-05-05 18:45:41 +02:00
"(request: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>, savedObjectsStart: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsServiceStart" ,
"text" : "SavedObjectsServiceStart"
} ,
") => Pick<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsRepository" ,
"text" : "SavedObjectsRepository"
} ,
2021-05-14 22:43:17 +02:00
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">"
2021-05-05 18:45:41 +02:00
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts" ,
"lineNumber" : 34
} ,
"deprecated" : false ,
2021-05-05 18:45:41 +02:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-05-05 18:45:41 +02:00
"id" : "def-server.SpacesClientWrapper" ,
"type" : "Type" ,
"tags" : [
"private"
] ,
2021-05-06 23:59:11 +02:00
"label" : "SpacesClientWrapper" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nFor consumption by the security plugin only."
] ,
"signature" : [
"(request: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>, baseClient: " ,
{
"pluginId" : "spaces" ,
"scope" : "server" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-server.ISpacesClient" ,
"text" : "ISpacesClient"
} ,
") => " ,
{
"pluginId" : "spaces" ,
"scope" : "server" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-server.ISpacesClient" ,
"text" : "ISpacesClient"
}
2021-03-04 02:12:24 +01:00
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts" ,
"lineNumber" : 25
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
}
] ,
"objects" : [ ] ,
"setup" : {
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.SpacesPluginSetup" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "SpacesPluginSetup" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nSetup contract for the Spaces plugin."
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/plugin.ts" ,
"lineNumber" : 57
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.SpacesPluginSetup.spacesService" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [
"deprecated"
] ,
2021-03-04 02:12:24 +01:00
"label" : "spacesService" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nService for interacting with spaces.\n"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
{
"pluginId" : "spaces" ,
"scope" : "server" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-server.SpacesServiceSetup" ,
"text" : "SpacesServiceSetup"
}
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/server/plugin.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 64
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : true ,
"removeBy" : "7.16" ,
"references" : [
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/plugin.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 59
2021-05-06 23:59:11 +02:00
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/plugin.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 266
2021-05-06 23:59:11 +02:00
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/plugin.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 284
2021-05-06 23:59:11 +02:00
}
} ,
{
"plugin" : "security" ,
"link" : {
"path" : "x-pack/plugins/security/server/plugin.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 300
2021-05-06 23:59:11 +02:00
}
} ,
{
"plugin" : "reporting" ,
"link" : {
"path" : "x-pack/plugins/reporting/server/core.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 267
2021-05-06 23:59:11 +02:00
}
} ,
{
"plugin" : "reporting" ,
"link" : {
"path" : "x-pack/plugins/reporting/server/core.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 289
2021-05-06 23:59:11 +02:00
}
} ,
{
"plugin" : "reporting" ,
"link" : {
"path" : "x-pack/plugins/reporting/server/core.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 301
2021-05-06 23:59:11 +02:00
}
} ,
{
"plugin" : "apm" ,
"link" : {
"path" : "x-pack/plugins/apm/server/routes/index_pattern.ts" ,
"lineNumber" : 33
}
} ,
{
"plugin" : "infra" ,
"link" : {
"path" : "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts" ,
"lineNumber" : 238
}
} ,
{
"plugin" : "infra" ,
"link" : {
"path" : "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts" ,
"lineNumber" : 239
}
} ,
{
"plugin" : "infra" ,
"link" : {
"path" : "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts" ,
"lineNumber" : 241
}
} ,
{
"plugin" : "infra" ,
"link" : {
"path" : "x-pack/plugins/infra/server/plugin.ts" ,
"lineNumber" : 153
}
2021-05-31 19:33:12 +02:00
} ,
{
"plugin" : "securitySolution" ,
"link" : {
"path" : "x-pack/plugins/security_solution/server/plugin.ts" ,
2021-06-30 19:04:59 +02:00
"lineNumber" : 190
2021-05-31 19:33:12 +02:00
}
2021-03-04 02:12:24 +01:00
}
]
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
"id" : "def-server.SpacesPluginSetup.spacesClient" ,
"type" : "Object" ,
2021-05-05 18:45:41 +02:00
"tags" : [
"private"
] ,
2021-03-04 02:12:24 +01:00
"label" : "spacesClient" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nRegistries exposed for the security plugin to transparently provide authorization and audit logging."
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"{ setClientRepositoryFactory: (factory: " ,
2021-05-05 18:45:41 +02:00
{
"pluginId" : "spaces" ,
"scope" : "server" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-server.SpacesClientRepositoryFactory" ,
"text" : "SpacesClientRepositoryFactory"
} ,
2021-03-04 02:12:24 +01:00
") => void; registerClientWrapper: (wrapper: " ,
2021-05-05 18:45:41 +02:00
{
"pluginId" : "spaces" ,
"scope" : "server" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-server.SpacesClientWrapper" ,
"text" : "SpacesClientWrapper"
} ,
2021-03-04 02:12:24 +01:00
") => void; }"
2021-05-06 23:59:11 +02:00
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/plugin.ts" ,
"lineNumber" : 70
} ,
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.SpacesPluginStart" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "SpacesPluginStart" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nStart contract for the Spaces plugin."
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/server/plugin.ts" ,
"lineNumber" : 87
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.SpacesPluginStart.spacesService" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "spacesService" ,
2021-05-05 18:45:41 +02:00
"description" : [
"Service for interacting with spaces."
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
{
"pluginId" : "spaces" ,
"scope" : "server" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-server.SpacesServiceStart" ,
"text" : "SpacesServiceStart"
}
2021-05-06 23:59:11 +02:00
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/plugin.ts" ,
"lineNumber" : 89
} ,
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"common" : {
"classes" : [ ] ,
"functions" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.addSpaceIdToPath" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "addSpaceIdToPath" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nGiven a server base path, space id, and requested resource, this will construct a space-aware path\nthat includes a URL identifier with the space id.\n"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"(basePath: string, spaceId: string, requestedPath: string) => string"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
"lineNumber" : 61
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-common.addSpaceIdToPath.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "basePath" ,
2021-05-05 18:45:41 +02:00
"description" : [
"the server's base path."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 62
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-common.addSpaceIdToPath.$2" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "spaceId" ,
2021-05-05 18:45:41 +02:00
"description" : [
"the space id."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 63
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-common.addSpaceIdToPath.$3" ,
2021-03-04 02:12:24 +01:00
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "requestedPath" ,
2021-05-05 18:45:41 +02:00
"description" : [
"the requested path (e.g. `/app/dashboard`)."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 64
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-04 02:12:24 +01:00
}
] ,
2021-05-05 18:45:41 +02:00
"returnComment" : [
"the space-aware version of the requested path, inclusive of the server's base path."
] ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.getSpaceIdFromPath" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [
"private"
2021-03-04 02:12:24 +01:00
] ,
2021-05-06 23:59:11 +02:00
"label" : "getSpaceIdFromPath" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nExtracts the space id from the given path.\n"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"(requestBasePath: string | null | undefined, serverBasePath: string | null | undefined) => { spaceId: string; pathHasExplicitSpaceIdentifier: boolean; }"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
"lineNumber" : 21
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-common.getSpaceIdFromPath.$1" ,
2021-03-04 02:12:24 +01:00
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "requestBasePath" ,
2021-05-05 18:45:41 +02:00
"description" : [
"The base path of the current request."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | null | undefined"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 22
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-common.getSpaceIdFromPath.$2" ,
2021-03-04 02:12:24 +01:00
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "serverBasePath" ,
2021-05-05 18:45:41 +02:00
"description" : [
"The server's base path."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | null | undefined"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 23
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : false
2021-03-04 02:12:24 +01:00
}
] ,
2021-05-05 18:45:41 +02:00
"returnComment" : [
"the space id."
] ,
2021-03-06 16:05:27 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.isReservedSpace" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "isReservedSpace" ,
2021-05-06 23:59:11 +02:00
"description" : [
"\nReturns whether the given Space is reserved or not.\n"
] ,
2021-03-06 16:05:27 +01:00
"signature" : [
"(space: Partial<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
"> | null | undefined) => boolean"
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/common/is_reserved_space.ts" ,
"lineNumber" : 18
} ,
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-04-15 22:47:21 +02:00
"id" : "def-common.isReservedSpace.$1" ,
2021-03-06 16:05:27 +01:00
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "space" ,
2021-05-06 23:59:11 +02:00
"description" : [
"the space"
] ,
2021-03-06 16:05:27 +01:00
"signature" : [
"Partial<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
"> | null | undefined"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/is_reserved_space.ts" ,
"lineNumber" : 18
2021-05-06 23:59:11 +02:00
} ,
"deprecated" : false ,
"isRequired" : false
2021-03-06 16:05:27 +01:00
}
] ,
"returnComment" : [
"boolean"
] ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
}
] ,
"interfaces" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.GetAllSpacesOptions" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "GetAllSpacesOptions" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nControls how spaces are retrieved."
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 13
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
"id" : "def-common.GetAllSpacesOptions.purpose" ,
"type" : "CompoundType" ,
2021-05-05 18:45:41 +02:00
"tags" : [
"see"
] ,
2021-03-04 02:12:24 +01:00
"label" : "purpose" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nAn optional purpose describing how the set of spaces will be used.\nThe default purpose (`any`) will retrieve all spaces the user is authorized to see,\nwhereas a more specific purpose will retrieve all spaces the user is authorized to perform a specific action within.\n"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\" | undefined"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 21
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
"id" : "def-common.GetAllSpacesOptions.includeAuthorizedPurposes" ,
"type" : "CompoundType" ,
2021-05-05 18:45:41 +02:00
"tags" : [
"see"
] ,
2021-03-04 02:12:24 +01:00
"label" : "includeAuthorizedPurposes" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nSet to true to return a set of flags indicating which purposes the user is authorized for.\n"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"boolean | undefined"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 28
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.GetSpaceResult" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "GetSpaceResult" ,
2021-05-06 23:59:11 +02:00
"description" : [
"\nResponse format when querying for spaces."
] ,
2021-03-04 02:12:24 +01:00
"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"
}
] ,
2021-05-06 23:59:11 +02:00
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 47
} ,
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-04 02:12:24 +01:00
"id" : "def-common.GetSpaceResult.authorizedPurposes" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "authorizedPurposes" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nA set of flags indicating which purposes the user is authorized for."
] ,
2021-03-04 02:12:24 +01:00
"signature" : [
"Record<" ,
{
"pluginId" : "spaces" ,
"scope" : "common" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-common.GetAllSpacesPurpose" ,
"text" : "GetAllSpacesPurpose"
} ,
", boolean> | undefined"
2021-05-06 23:59:11 +02:00
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 51
} ,
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
2021-06-30 19:04:59 +02:00
} ,
{
"parentPluginId" : "spaces" ,
"id" : "def-common.LegacyUrlAliasTarget" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "LegacyUrlAliasTarget" ,
"description" : [
"\nClient interface for interacting with legacy URL aliases."
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 57
} ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "spaces" ,
"id" : "def-common.LegacyUrlAliasTarget.targetSpace" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "targetSpace" ,
"description" : [
"\nThe namespace that the object existed in when it was converted."
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 61
} ,
"deprecated" : false
} ,
{
"parentPluginId" : "spaces" ,
"id" : "def-common.LegacyUrlAliasTarget.targetType" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "targetType" ,
"description" : [
"\nThe type of the object when it was converted."
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 65
} ,
"deprecated" : false
} ,
{
"parentPluginId" : "spaces" ,
"id" : "def-common.LegacyUrlAliasTarget.sourceId" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "sourceId" ,
"description" : [
"\nThe original ID of the object, before it was converted."
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 69
} ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
2021-03-04 02:12:24 +01:00
}
] ,
"enums" : [ ] ,
"misc" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.ENTER_SPACE_PATH" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "ENTER_SPACE_PATH" ,
2021-03-04 02:12:24 +01:00
"description" : [
2021-03-06 16:05:27 +01:00
"\nThe path to enter a space."
2021-03-04 02:12:24 +01:00
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"/spaces/enter\""
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/common/constants.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 33
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.GetAllSpacesPurpose" ,
"type" : "Type" ,
2021-03-04 02:12:24 +01:00
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "GetAllSpacesPurpose" ,
2021-05-05 18:45:41 +02:00
"description" : [
"\nThe set of purposes to retrieve spaces:\n- `any`: retrieves all spaces the user is authorized to see.\n- `copySavedObjectsIntoSpace`: retrieves all spaces the user is authorized to copy saved objects into.\n- `findSavedObjects`: retrieves all spaces the user is authorized to search within.\n- `shareSavedObjectsIntoSpace`: retrieves all spaces the user is authorized to share saved objects into."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\""
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "x-pack/plugins/spaces/common/types.ts" ,
2021-05-05 18:45:41 +02:00
"lineNumber" : 38
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.MAX_SPACE_INITIALS" ,
"type" : "number" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "MAX_SPACE_INITIALS" ,
2021-03-04 02:12:24 +01:00
"description" : [
2021-03-06 16:05:27 +01:00
"\nThe maximum number of characters allowed in the Space Avatar's initials"
2021-03-04 02:12:24 +01:00
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"2"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/common/constants.ts" ,
2021-03-06 16:05:27 +01:00
"lineNumber" : 28
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "spaces" ,
2021-03-06 16:05:27 +01:00
"id" : "def-common.SPACE_SEARCH_COUNT_THRESHOLD" ,
"type" : "number" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-06 16:05:27 +01:00
"label" : "SPACE_SEARCH_COUNT_THRESHOLD" ,
"description" : [
"\nThe minimum number of spaces required to show a search control."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"8"
] ,
2021-03-04 02:12:24 +01:00
"source" : {
2021-03-06 16:05:27 +01:00
"path" : "x-pack/plugins/spaces/common/constants.ts" ,
"lineNumber" : 23
2021-03-04 02:12:24 +01:00
} ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
}
] ,
"objects" : [ ]
}
}