{ "id": "savedObjectsTagging", "client": { "classes": [], "functions": [], "interfaces": [ { "id": "def-public.Tag", "type": "Interface", "label": "Tag", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.Tag.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 10 } }, { "tags": [], "id": "def-public.Tag.name", "type": "string", "label": "name", "description": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 11 } }, { "tags": [], "id": "def-public.Tag.description", "type": "string", "label": "description", "description": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 12 } }, { "tags": [], "id": "def-public.Tag.color", "type": "string", "label": "color", "description": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 13 } } ], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 9 }, "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [], "start": { "id": "def-public.SavedObjectTaggingPluginStart", "type": "Type", "label": "SavedObjectTaggingPluginStart", "tags": [], "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/public/types.ts", "lineNumber": 10 }, "signature": [ "SavedObjectsTaggingApi" ], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [ { "id": "def-common.getTagsCapabilities", "type": "Function", "children": [ { "type": "Object", "label": "capabilities", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "common", "docId": "kibCorePluginApi", "section": "def-common.Capabilities", "text": "Capabilities" } ], "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/capabilities.ts", "lineNumber": 23 } } ], "signature": [ "(capabilities: ", "Capabilities", ") => ", { "pluginId": "savedObjectsTagging", "scope": "common", "docId": "kibSavedObjectsTaggingPluginApi", "section": "def-common.TagsCapabilities", "text": "TagsCapabilities" } ], "description": [], "label": "getTagsCapabilities", "source": { "path": "x-pack/plugins/saved_objects_tagging/common/capabilities.ts", "lineNumber": 23 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.validateTagColor", "type": "Function", "children": [ { "type": "string", "label": "color", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/validation.ts", "lineNumber": 27 } } ], "signature": [ "(color: string) => string | undefined" ], "description": [], "label": "validateTagColor", "source": { "path": "x-pack/plugins/saved_objects_tagging/common/validation.ts", "lineNumber": 27 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.validateTagDescription", "type": "Function", "children": [ { "type": "string", "label": "description", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/validation.ts", "lineNumber": 54 } } ], "signature": [ "(description: string) => string | undefined" ], "description": [], "label": "validateTagDescription", "source": { "path": "x-pack/plugins/saved_objects_tagging/common/validation.ts", "lineNumber": 54 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.validateTagName", "type": "Function", "children": [ { "type": "string", "label": "name", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/validation.ts", "lineNumber": 35 } } ], "signature": [ "(name: string) => string | undefined" ], "description": [], "label": "validateTagName", "source": { "path": "x-pack/plugins/saved_objects_tagging/common/validation.ts", "lineNumber": 35 }, "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "id": "def-common.ITagsClient", "type": "Interface", "label": "ITagsClient", "description": [], "tags": [], "children": [ { "id": "def-common.ITagsClient.create", "type": "Function", "label": "create", "signature": [ "(attributes: ", { "pluginId": "savedObjects", "scope": "common", "docId": "kibSavedObjectsPluginApi", "section": "def-common.TagAttributes", "text": "TagAttributes" }, ") => Promise<", { "pluginId": "savedObjects", "scope": "common", "docId": "kibSavedObjectsPluginApi", "section": "def-common.Tag", "text": "Tag" }, ">" ], "description": [], "children": [ { "type": "Object", "label": "attributes", "isRequired": true, "signature": [ { "pluginId": "savedObjects", "scope": "common", "docId": "kibSavedObjectsPluginApi", "section": "def-common.TagAttributes", "text": "TagAttributes" } ], "description": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 27 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 27 } }, { "id": "def-common.ITagsClient.get", "type": "Function", "label": "get", "signature": [ "(id: string) => Promise<", { "pluginId": "savedObjects", "scope": "common", "docId": "kibSavedObjectsPluginApi", "section": "def-common.Tag", "text": "Tag" }, ">" ], "description": [], "children": [ { "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 28 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 28 } }, { "id": "def-common.ITagsClient.getAll", "type": "Function", "label": "getAll", "signature": [ "(options?: ", { "pluginId": "savedObjects", "scope": "common", "docId": "kibSavedObjectsPluginApi", "section": "def-common.GetAllTagsOptions", "text": "GetAllTagsOptions" }, " | undefined) => Promise<", { "pluginId": "savedObjects", "scope": "common", "docId": "kibSavedObjectsPluginApi", "section": "def-common.Tag", "text": "Tag" }, "[]>" ], "description": [], "children": [ { "type": "Object", "label": "options", "isRequired": false, "signature": [ { "pluginId": "savedObjects", "scope": "common", "docId": "kibSavedObjectsPluginApi", "section": "def-common.GetAllTagsOptions", "text": "GetAllTagsOptions" }, " | undefined" ], "description": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 29 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 29 } }, { "id": "def-common.ITagsClient.delete", "type": "Function", "label": "delete", "signature": [ "(id: string) => Promise" ], "description": [], "children": [ { "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 30 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 30 } }, { "id": "def-common.ITagsClient.update", "type": "Function", "label": "update", "signature": [ "(id: string, attributes: ", { "pluginId": "savedObjects", "scope": "common", "docId": "kibSavedObjectsPluginApi", "section": "def-common.TagAttributes", "text": "TagAttributes" }, ") => Promise<", { "pluginId": "savedObjects", "scope": "common", "docId": "kibSavedObjectsPluginApi", "section": "def-common.Tag", "text": "Tag" }, ">" ], "description": [], "children": [ { "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 31 } }, { "type": "Object", "label": "attributes", "isRequired": true, "signature": [ { "pluginId": "savedObjects", "scope": "common", "docId": "kibSavedObjectsPluginApi", "section": "def-common.TagAttributes", "text": "TagAttributes" } ], "description": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 31 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 31 } } ], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 26 }, "initialIsOpen": false }, { "id": "def-common.Tag", "type": "Interface", "label": "Tag", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.Tag.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 10 } }, { "tags": [], "id": "def-common.Tag.name", "type": "string", "label": "name", "description": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 11 } }, { "tags": [], "id": "def-common.Tag.description", "type": "string", "label": "description", "description": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 12 } }, { "tags": [], "id": "def-common.Tag.color", "type": "string", "label": "color", "description": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 13 } } ], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 9 }, "initialIsOpen": false }, { "id": "def-common.TagAttributes", "type": "Interface", "label": "TagAttributes", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.TagAttributes.name", "type": "string", "label": "name", "description": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 17 } }, { "tags": [], "id": "def-common.TagAttributes.description", "type": "string", "label": "description", "description": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 18 } }, { "tags": [], "id": "def-common.TagAttributes.color", "type": "string", "label": "color", "description": [], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 19 } } ], "source": { "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", "lineNumber": 16 }, "initialIsOpen": false }, { "id": "def-common.TagsCapabilities", "type": "Interface", "label": "TagsCapabilities", "description": [ "\nRepresent the UI capabilities for the `savedObjectsTagging` section of `Capabilities`" ], "tags": [], "children": [ { "tags": [], "id": "def-common.TagsCapabilities.view", "type": "boolean", "label": "view", "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/capabilities.ts", "lineNumber": 15 } }, { "tags": [], "id": "def-common.TagsCapabilities.create", "type": "boolean", "label": "create", "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/capabilities.ts", "lineNumber": 16 } }, { "tags": [], "id": "def-common.TagsCapabilities.edit", "type": "boolean", "label": "edit", "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/capabilities.ts", "lineNumber": 17 } }, { "tags": [], "id": "def-common.TagsCapabilities.delete", "type": "boolean", "label": "delete", "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/capabilities.ts", "lineNumber": 18 } }, { "tags": [], "id": "def-common.TagsCapabilities.assign", "type": "boolean", "label": "assign", "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/capabilities.ts", "lineNumber": 19 } }, { "tags": [], "id": "def-common.TagsCapabilities.viewConnections", "type": "boolean", "label": "viewConnections", "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/capabilities.ts", "lineNumber": 20 } } ], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/capabilities.ts", "lineNumber": 14 }, "initialIsOpen": false }, { "id": "def-common.TagValidation", "type": "Interface", "label": "TagValidation", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.TagValidation.valid", "type": "boolean", "label": "valid", "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/validation.ts", "lineNumber": 18 } }, { "tags": [], "id": "def-common.TagValidation.warnings", "type": "Array", "label": "warnings", "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/validation.ts", "lineNumber": 19 }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-common.TagValidation.errors", "type": "Object", "label": "errors", "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/validation.ts", "lineNumber": 20 }, "signature": [ "Partial>" ] } ], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/validation.ts", "lineNumber": 17 }, "initialIsOpen": false } ], "enums": [], "misc": [ { "tags": [], "id": "def-common.tagDescriptionMaxLength", "type": "number", "label": "tagDescriptionMaxLength", "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/validation.ts", "lineNumber": 13 }, "signature": [ "100" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.tagFeatureId", "type": "string", "label": "tagFeatureId", "description": [ "\nThe id of the tagging feature as registered to `features` plugin" ], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/constants.ts", "lineNumber": 11 }, "signature": [ "\"savedObjectsTagging\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.tagManagementSectionId", "type": "string", "label": "tagManagementSectionId", "description": [ "\nThe management section id as registered to the `management` plugin" ], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/constants.ts", "lineNumber": 19 }, "signature": [ "\"tags\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.tagNameMaxLength", "type": "number", "label": "tagNameMaxLength", "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/validation.ts", "lineNumber": 12 }, "signature": [ "50" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.tagNameMinLength", "type": "number", "label": "tagNameMinLength", "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/validation.ts", "lineNumber": 11 }, "signature": [ "2" ], "initialIsOpen": false }, { "id": "def-common.TagSavedObject", "type": "Type", "label": "TagSavedObject", "tags": [], "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/types.ts", "lineNumber": 11 }, "signature": [ "SavedObject" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.tagSavedObjectTypeName", "type": "string", "label": "tagSavedObjectTypeName", "description": [ "\nThe saved object type for `tag` objects" ], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/constants.ts", "lineNumber": 15 }, "signature": [ "\"tag\"" ], "initialIsOpen": false }, { "id": "def-common.TagWithRelations", "type": "Type", "label": "TagWithRelations", "tags": [], "description": [], "source": { "path": "x-pack/plugins/saved_objects_tagging/common/types.ts", "lineNumber": 13 }, "signature": [ "Tag & { relationCount: number; }" ], "initialIsOpen": false } ], "objects": [] } }