Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SavedObjects tagging MVP #79096

Merged
merged 155 commits into from
Nov 3, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
155 commits
Select commit Hold shift + click to select a range
d85b4cb
create xpack plugin skeleton, start to implement management section
pgayvallet Sep 30, 2020
47203ff
add tag creation modal
pgayvallet Oct 1, 2020
7c560fa
first implementation of the tags table
pgayvallet Oct 1, 2020
9be845f
use InMemoryTable
pgayvallet Oct 1, 2020
e06d908
add edit modal and delete action
pgayvallet Oct 2, 2020
3505924
update plugin list
pgayvallet Oct 2, 2020
a6372c7
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 2, 2020
9e16b30
add tag list, fix types
pgayvallet Oct 2, 2020
2879ef0
add capabilities check on client-side
pgayvallet Oct 2, 2020
f1fab2f
add tag combo box component
pgayvallet Oct 2, 2020
8d66595
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 5, 2020
56ac96e
add missing i18n keys
pgayvallet Oct 5, 2020
c4c4d04
fix privilege FTR tests
pgayvallet Oct 5, 2020
1f8f8c4
add base structure for FTR tests
pgayvallet Oct 6, 2020
7a9e96f
fix feature ftr test
pgayvallet Oct 6, 2020
e516d95
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 6, 2020
4c222d5
use string literals for i18n
pgayvallet Oct 6, 2020
a22d37c
create savedObjectsTaggingOss plugin, move API types to oss plugin, s…
pgayvallet Oct 6, 2020
1f7e5aa
update plugin list
pgayvallet Oct 6, 2020
7aa86bb
fix types
pgayvallet Oct 6, 2020
f2bd458
allow to use `_find` with multiple references
pgayvallet Oct 7, 2020
a898b58
add FTR test for _find API on references fields
pgayvallet Oct 7, 2020
2805cde
add _find integration tests
pgayvallet Oct 7, 2020
28dc003
update generated doc
pgayvallet Oct 7, 2020
5e8dd37
start to implement tag filtering on SO management section
pgayvallet Oct 7, 2020
2324a7d
update generated docs
pgayvallet Oct 7, 2020
fdec460
wire tagging API to dashboard listing page
pgayvallet Oct 7, 2020
a8b4184
fix i18n namespace
pgayvallet Oct 7, 2020
9dd9afc
fix type & tests
pgayvallet Oct 7, 2020
c78db2a
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 8, 2020
7b21fe5
update dashboard listing snapshots
pgayvallet Oct 8, 2020
2252418
adapt FTR listingTable service to search for parsable queries
pgayvallet Oct 8, 2020
ad8ff65
wite tagging API to visualize listing
pgayvallet Oct 8, 2020
1cddeb9
update tagging plugin limits
pgayvallet Oct 8, 2020
9ad8f04
add server-side and client-side validation for tag create/edit
pgayvallet Oct 9, 2020
679c426
rename title field to name
pgayvallet Oct 11, 2020
35346a4
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 11, 2020
59c30b0
fix types
pgayvallet Oct 11, 2020
d6ad41c
fix types bis
pgayvallet Oct 11, 2020
3f4fb59
add removeReferencesTo API to SOR/SOC
pgayvallet Oct 12, 2020
1a094b9
update generated doc
pgayvallet Oct 12, 2020
45ac3d6
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 12, 2020
a7dacca
add server-side unit test for `savedObjectsTagging` plugin
pgayvallet Oct 12, 2020
eb65128
move tagging API types to its own file
pgayvallet Oct 12, 2020
f3035ba
add savedObjectsTaggingOss mock
pgayvallet Oct 12, 2020
509a764
add tags_cache tests
pgayvallet Oct 12, 2020
b15f862
add tests for client-side tag client
pgayvallet Oct 13, 2020
9f6ca19
extract uiApi to distinct files
pgayvallet Oct 13, 2020
c38d0e0
various API improvements
pgayvallet Oct 13, 2020
88233c2
add more tests
pgayvallet Oct 13, 2020
22cdab6
add link between tag and so management sections + add connection counts
pgayvallet Oct 13, 2020
f130788
add base functional test suite for tagging
pgayvallet Oct 14, 2020
3f19401
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 14, 2020
24c13fe
add more FTR tests
pgayvallet Oct 14, 2020
3ffbfc2
improve feature control func test
pgayvallet Oct 14, 2020
490a098
update codeowners
pgayvallet Oct 14, 2020
5b2bcc5
update generated doc
pgayvallet Oct 14, 2020
23aa215
fix access to proxy modal
pgayvallet Oct 14, 2020
1563611
adapt SO save modal to allow to add tag field
pgayvallet Oct 14, 2020
da8c273
add SO decorator registry and tag implementation
pgayvallet Oct 15, 2020
59e058e
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 15, 2020
43903c0
add unit tests for SO tag decorator
pgayvallet Oct 15, 2020
5df8d94
add functional tests for visualize integration
pgayvallet Oct 15, 2020
79472af
add tag SO read permission for vis/dash feature
pgayvallet Oct 15, 2020
3ea667b
add RBAC api integ tests
pgayvallet Oct 16, 2020
ca03045
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 16, 2020
5590bf1
add API integration tests
pgayvallet Oct 16, 2020
f9624fb
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 19, 2020
ce90b0c
add test for getTagConnectionsUrl
pgayvallet Oct 19, 2020
c618514
add SOM test suite
pgayvallet Oct 19, 2020
9483323
add dashboard integration suite
pgayvallet Oct 19, 2020
26efd95
remove test line
pgayvallet Oct 19, 2020
d31a8c2
add missing unit tests
pgayvallet Oct 19, 2020
ae360dc
improve API types doc
pgayvallet Oct 19, 2020
4f26837
fix create modal save button label
pgayvallet Oct 19, 2020
a5f6eb4
remove console.log
pgayvallet Oct 19, 2020
50842b3
improve doc
pgayvallet Oct 19, 2020
c016b1b
self review
pgayvallet Oct 19, 2020
e916f73
add refresh interval for tag cache
pgayvallet Oct 20, 2020
badedb0
improve page object doc
pgayvallet Oct 20, 2020
286671e
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 20, 2020
77f89ce
minor cleanup
pgayvallet Oct 20, 2020
d814183
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 20, 2020
aebf8f7
address review comments
pgayvallet Oct 20, 2020
0269a7a
small layout fixes
pgayvallet Oct 20, 2020
8d21491
add initial focus
pgayvallet Oct 20, 2020
6ed426e
use lazy accessor for tag request handler context
pgayvallet Oct 20, 2020
e3cbdd2
adapt SOM export and export route to handle references
pgayvallet Oct 21, 2020
088587b
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 21, 2020
7fbef77
remove icon from feature config due to master changes
pgayvallet Oct 21, 2020
3ab65c8
fix SO table tests
pgayvallet Oct 21, 2020
9a4aeff
update generated docs
pgayvallet Oct 21, 2020
58d9142
sort tags by name in filter dropdown and listing component
pgayvallet Oct 21, 2020
a2944a3
wire SO tagging to dashboard save modal
pgayvallet Oct 21, 2020
98222d0
fix types
pgayvallet Oct 21, 2020
6c4b5f1
- add 'create tag' action in tag selector
pgayvallet Oct 22, 2020
871ab88
add description max length validation
pgayvallet Oct 22, 2020
015bfea
remove real-time validation
pgayvallet Oct 22, 2020
688ef2e
fix i18n bundle id
pgayvallet Oct 22, 2020
1c9d73c
update expected size of savedObjectsTagging plugin
pgayvallet Oct 22, 2020
59c7ec6
use own useIfMounted
pgayvallet Oct 22, 2020
139e05e
update limit again, contract components cannot be lazy loaded atm.
pgayvallet Oct 22, 2020
b702113
math is hard
pgayvallet Oct 22, 2020
f433ab0
remove single usage of lodash for bundle size
pgayvallet Oct 22, 2020
5590c76
add async imports for create/edit modal
pgayvallet Oct 22, 2020
1f0c740
add FTR test for 'create tag' action from tag selector
pgayvallet Oct 22, 2020
15351d7
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 22, 2020
e4c1925
allow 'create new' option to prepopulate name field
pgayvallet Oct 26, 2020
226eea8
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 26, 2020
a21c442
extract savedObjectToTag
pgayvallet Oct 26, 2020
27f13c5
add advancedSettings read user for security api_integ suite
pgayvallet Oct 26, 2020
8a24f1f
add audit login for security client wrapper
pgayvallet Oct 26, 2020
53fd1b5
use import type when possible
pgayvallet Oct 26, 2020
38da2dd
wire SO tagging to lens visualization
pgayvallet Oct 26, 2020
136a8ac
fix lens jest test
pgayvallet Oct 26, 2020
9ed15f6
Fix `create tag` option being selected when closing the selector drop…
pgayvallet Oct 26, 2020
11b1aba
add sorting to tag column from getTableColumnDef
pgayvallet Oct 27, 2020
cbaabe4
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 27, 2020
9741ff9
address some of restrry comments
pgayvallet Oct 27, 2020
b5717e0
rename tag selector's setSelected option to onTagsSelected
pgayvallet Oct 27, 2020
5f66b49
fix audit logging even type for saved_object_remove_references
pgayvallet Oct 27, 2020
8ee1129
update plugin size limit to current size
pgayvallet Oct 28, 2020
a969329
adapt maxlength validation wording
pgayvallet Oct 28, 2020
ddbfe76
remove selection column until we have batch action menu
pgayvallet Oct 28, 2020
8c6cfad
remove connections link when user lack read privilege to savedObjectM…
pgayvallet Oct 28, 2020
c38219f
forbid registering multiple SO decorators with the same priority
pgayvallet Oct 28, 2020
2b2f85c
add so decorator test
pgayvallet Oct 28, 2020
6299659
extract getTagFindReferences and create API mock
pgayvallet Oct 28, 2020
af22352
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 28, 2020
7cddbfd
update audit-logging ascidoc
pgayvallet Oct 28, 2020
1aa5f48
doc nit
pgayvallet Oct 28, 2020
1941393
throw conflict error if update returns any failure
pgayvallet Oct 29, 2020
a4ced26
use refresh=true as default
pgayvallet Oct 29, 2020
ff00c5e
wording nits
pgayvallet Oct 29, 2020
2547231
export: rename `references` to `hasReference`
pgayvallet Oct 29, 2020
a9fc4e6
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 29, 2020
db45e0d
update generated doc
pgayvallet Oct 29, 2020
e1b1a0f
set description max length to 100
pgayvallet Oct 29, 2020
f2e0716
do not initialize tag cache on anonymous pages
pgayvallet Oct 29, 2020
c057cd2
split fetchObjectsToExport into two distinct functions
pgayvallet Oct 29, 2020
5ec1f53
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 29, 2020
cb15dbb
change tag client `delete` call order
pgayvallet Oct 29, 2020
ffc6425
tsdoc nits
pgayvallet Oct 29, 2020
7abf3e3
more nits
pgayvallet Oct 29, 2020
5eed582
add README for oss plugin
pgayvallet Oct 30, 2020
3648401
add oss plugin start tests
pgayvallet Oct 30, 2020
5727615
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Oct 30, 2020
c5324ee
SavedObject.find: rename `references` to `hasReference`
pgayvallet Oct 30, 2020
f6a5d7b
change section description label
pgayvallet Oct 30, 2020
1263600
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Nov 2, 2020
25d3680
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Nov 2, 2020
9a9779a
remove url prefix constants
pgayvallet Nov 2, 2020
80ae51e
last nits and comments
pgayvallet Nov 3, 2020
2a14363
Merge remote-tracking branch 'upstream/master' into kbn-74571-so-tagging
pgayvallet Nov 3, 2020
68e8de7
update generated doc
pgayvallet Nov 3, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -196,12 +196,15 @@

# Platform
/src/core/ @elastic/kibana-platform
/src/plugins/saved_objects_tagging_oss @elastic/kibana-platform
/config/kibana.yml @elastic/kibana-platform
/x-pack/plugins/features/ @elastic/kibana-platform
/x-pack/plugins/licensing/ @elastic/kibana-platform
/x-pack/plugins/global_search/ @elastic/kibana-platform
/x-pack/plugins/cloud/ @elastic/kibana-platform
/x-pack/plugins/saved_objects_tagging/ @elastic/kibana-platform
/x-pack/test/saved_objects_field_count/ @elastic/kibana-platform
/x-pack/test/saved_object_tagging/ @elastic/kibana-platform
/packages/kbn-config-schema/ @elastic/kibana-platform
/packages/kbn-std/ @elastic/kibana-platform
/src/legacy/server/config/ @elastic/kibana-platform
Expand Down
9 changes: 9 additions & 0 deletions docs/developer/plugin-list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,11 @@ Content is fetched from the remote (https://feeds.elastic.co and https://feeds-s
|WARNING: Missing README.


|{kib-repo}blob/{branch}/src/plugins/saved_objects_tagging_oss/README.md[savedObjectsTaggingOss]
|Bridge plugin for consumption of the saved object tagging feature from
oss plugins.


|{kib-repo}blob/{branch}/src/plugins/security_oss/README.md[securityOss]
|securityOss is responsible for educating users about Elastic's free security features,
so they can properly protect the data within their clusters.
Expand Down Expand Up @@ -466,6 +471,10 @@ Elastic.
|Welcome to the Kibana rollup plugin! This plugin provides Kibana support for Elasticsearch's rollup feature. Please refer to the Elasticsearch documentation to understand rollup indices and how to create rollup jobs.


|{kib-repo}blob/{branch}/x-pack/plugins/saved_objects_tagging/README.md[savedObjectsTagging]
|Add tagging capability to saved objects


|{kib-repo}blob/{branch}/x-pack/plugins/searchprofiler/README.md[searchprofiler]
|The search profiler consumes the Profile API
by sending a search API with profile: true enabled in the request body. The response contains
Expand Down
1 change: 1 addition & 0 deletions docs/development/core/public/kibana-plugin-core-public.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-public.savedobjectsbulkupdateoptions.md) | |
| [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) | |
| [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) | |
| [SavedObjectsFindOptionsReference](./kibana-plugin-core-public.savedobjectsfindoptionsreference.md) | |
| [SavedObjectsFindResponsePublic](./kibana-plugin-core-public.savedobjectsfindresponsepublic.md) | Return type of the Saved Objects <code>find()</code> method.<!-- -->\*Note\*: this type is different between the Public and Server Saved Objects clients. |
| [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md) | Represents a failure to import due to a conflict, which can be resolved in different ways with an overwrite. |
| [SavedObjectsImportConflictError](./kibana-plugin-core-public.savedobjectsimportconflicterror.md) | Represents a failure to import due to a conflict. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## SavedObjectsFindOptions.defaultSearchOperator property

The search operator to use with the provided filter. Defaults to `OR`

<b>Signature:</b>

```typescript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,10 @@

## SavedObjectsFindOptions.hasReference property

Search for documents having a reference to the specified objects. Use `hasReferenceOperator` to specify the operator to use when searching for multiple references.

<b>Signature:</b>

```typescript
hasReference?: {
type: string;
id: string;
};
hasReference?: SavedObjectsFindOptionsReference | SavedObjectsFindOptionsReference[];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) &gt; [hasReferenceOperator](./kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md)

## SavedObjectsFindOptions.hasReferenceOperator property

The operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`

<b>Signature:</b>

```typescript
hasReferenceOperator?: 'AND' | 'OR';
```
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,11 @@ export interface SavedObjectsFindOptions

| Property | Type | Description |
| --- | --- | --- |
| [defaultSearchOperator](./kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md) | <code>'AND' &#124; 'OR'</code> | |
| [defaultSearchOperator](./kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md) | <code>'AND' &#124; 'OR'</code> | The search operator to use with the provided filter. Defaults to <code>OR</code> |
| [fields](./kibana-plugin-core-public.savedobjectsfindoptions.fields.md) | <code>string[]</code> | An array of fields to include in the results |
| [filter](./kibana-plugin-core-public.savedobjectsfindoptions.filter.md) | <code>string &#124; KueryNode</code> | |
| [hasReference](./kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md) | <code>{</code><br/><code> type: string;</code><br/><code> id: string;</code><br/><code> }</code> | |
| [hasReference](./kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md) | <code>SavedObjectsFindOptionsReference &#124; SavedObjectsFindOptionsReference[]</code> | Search for documents having a reference to the specified objects. Use <code>hasReferenceOperator</code> to specify the operator to use when searching for multiple references. |
| [hasReferenceOperator](./kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md) | <code>'AND' &#124; 'OR'</code> | The operator to use when searching by multiple references using the <code>hasReference</code> option. Defaults to <code>OR</code> |
| [namespaces](./kibana-plugin-core-public.savedobjectsfindoptions.namespaces.md) | <code>string[]</code> | |
| [page](./kibana-plugin-core-public.savedobjectsfindoptions.page.md) | <code>number</code> | |
| [perPage](./kibana-plugin-core-public.savedobjectsfindoptions.perpage.md) | <code>number</code> | |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [SavedObjectsFindOptionsReference](./kibana-plugin-core-public.savedobjectsfindoptionsreference.md) &gt; [id](./kibana-plugin-core-public.savedobjectsfindoptionsreference.id.md)

## SavedObjectsFindOptionsReference.id property

<b>Signature:</b>

```typescript
id: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [SavedObjectsFindOptionsReference](./kibana-plugin-core-public.savedobjectsfindoptionsreference.md)

## SavedObjectsFindOptionsReference interface


<b>Signature:</b>

```typescript
export interface SavedObjectsFindOptionsReference
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [id](./kibana-plugin-core-public.savedobjectsfindoptionsreference.id.md) | <code>string</code> | |
| [type](./kibana-plugin-core-public.savedobjectsfindoptionsreference.type.md) | <code>string</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [SavedObjectsFindOptionsReference](./kibana-plugin-core-public.savedobjectsfindoptionsreference.md) &gt; [type](./kibana-plugin-core-public.savedobjectsfindoptionsreference.type.md)

## SavedObjectsFindOptionsReference.type property

<b>Signature:</b>

```typescript
type: string;
```
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ Generates sorted saved object stream to be used for export. See the [options](./
<b>Signature:</b>

```typescript
export declare function exportSavedObjectsToStream({ types, objects, search, savedObjectsClient, exportSizeLimit, includeReferencesDeep, excludeExportDetails, namespace, }: SavedObjectsExportOptions): Promise<import("stream").Readable>;
export declare function exportSavedObjectsToStream({ types, hasReference, objects, search, savedObjectsClient, exportSizeLimit, includeReferencesDeep, excludeExportDetails, namespace, }: SavedObjectsExportOptions): Promise<import("stream").Readable>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| { types, objects, search, savedObjectsClient, exportSizeLimit, includeReferencesDeep, excludeExportDetails, namespace, } | <code>SavedObjectsExportOptions</code> | |
| { types, hasReference, objects, search, savedObjectsClient, exportSizeLimit, includeReferencesDeep, excludeExportDetails, namespace, } | <code>SavedObjectsExportOptions</code> | |

<b>Returns:</b>

Expand Down
5 changes: 4 additions & 1 deletion docs/development/core/server/kibana-plugin-core-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->

| Function | Description |
| --- | --- |
| [exportSavedObjectsToStream({ types, objects, search, savedObjectsClient, exportSizeLimit, includeReferencesDeep, excludeExportDetails, namespace, })](./kibana-plugin-core-server.exportsavedobjectstostream.md) | Generates sorted saved object stream to be used for export. See the [options](./kibana-plugin-core-server.savedobjectsexportoptions.md) for more detailed information. |
| [exportSavedObjectsToStream({ types, hasReference, objects, search, savedObjectsClient, exportSizeLimit, includeReferencesDeep, excludeExportDetails, namespace, })](./kibana-plugin-core-server.exportsavedobjectstostream.md) | Generates sorted saved object stream to be used for export. See the [options](./kibana-plugin-core-server.savedobjectsexportoptions.md) for more detailed information. |
| [importSavedObjectsFromStream({ readStream, objectLimit, overwrite, createNewCopies, savedObjectsClient, typeRegistry, namespace, })](./kibana-plugin-core-server.importsavedobjectsfromstream.md) | Import saved objects from given stream. See the [options](./kibana-plugin-core-server.savedobjectsimportoptions.md) for more detailed information. |
| [resolveSavedObjectsImportErrors({ readStream, objectLimit, retries, savedObjectsClient, typeRegistry, namespace, createNewCopies, })](./kibana-plugin-core-server.resolvesavedobjectsimporterrors.md) | Resolve and return saved object import errors. See the [options](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) for more detailed informations. |

Expand Down Expand Up @@ -163,6 +163,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [SavedObjectsExportOptions](./kibana-plugin-core-server.savedobjectsexportoptions.md) | Options controlling the export operation. |
| [SavedObjectsExportResultDetails](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) | Structure of the export result details entry |
| [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) | |
| [SavedObjectsFindOptionsReference](./kibana-plugin-core-server.savedobjectsfindoptionsreference.md) | |
| [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) | Return type of the Saved Objects <code>find()</code> method.<!-- -->\*Note\*: this type is different between the Public and Server Saved Objects clients. |
| [SavedObjectsFindResult](./kibana-plugin-core-server.savedobjectsfindresult.md) | |
| [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.md) | Represents a failure to import due to a conflict, which can be resolved in different ways with an overwrite. |
Expand All @@ -180,6 +181,8 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) | |
| [SavedObjectsMigrationVersion](./kibana-plugin-core-server.savedobjectsmigrationversion.md) | Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. |
| [SavedObjectsRawDoc](./kibana-plugin-core-server.savedobjectsrawdoc.md) | A raw document as represented directly in the saved object index. |
| [SavedObjectsRemoveReferencesToOptions](./kibana-plugin-core-server.savedobjectsremovereferencestooptions.md) | |
| [SavedObjectsRemoveReferencesToResponse](./kibana-plugin-core-server.savedobjectsremovereferencestoresponse.md) | |
| [SavedObjectsRepositoryFactory](./kibana-plugin-core-server.savedobjectsrepositoryfactory.md) | Factory provided when invoking a [client factory provider](./kibana-plugin-core-server.savedobjectsclientfactoryprovider.md) See [SavedObjectsServiceSetup.setClientFactoryProvider](./kibana-plugin-core-server.savedobjectsservicesetup.setclientfactoryprovider.md) |
| [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) | Options to control the "resolve import" operation. |
| [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) | Saved Objects is Kibana's data persistence mechanism allowing plugins to use Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods for registering Saved Object types, creating and registering Saved Object client wrappers and factories. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,6 @@ The constructor for this class is marked as internal. Third-party code should no
| [deleteFromNamespaces(type, id, namespaces, options)](./kibana-plugin-core-server.savedobjectsclient.deletefromnamespaces.md) | | Removes namespaces from a SavedObject |
| [find(options)](./kibana-plugin-core-server.savedobjectsclient.find.md) | | Find all SavedObjects matching the search query |
| [get(type, id, options)](./kibana-plugin-core-server.savedobjectsclient.get.md) | | Retrieves a single object |
| [removeReferencesTo(type, id, options)](./kibana-plugin-core-server.savedobjectsclient.removereferencesto.md) | | Updates all objects containing a reference to the given {<!-- -->type, id<!-- -->} tuple to remove the said reference. |
| [update(type, id, attributes, options)](./kibana-plugin-core-server.savedobjectsclient.update.md) | | Updates an SavedObject |

Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) &gt; [removeReferencesTo](./kibana-plugin-core-server.savedobjectsclient.removereferencesto.md)

## SavedObjectsClient.removeReferencesTo() method

Updates all objects containing a reference to the given {<!-- -->type, id<!-- -->} tuple to remove the said reference.

<b>Signature:</b>

```typescript
removeReferencesTo(type: string, id: string, options?: SavedObjectsRemoveReferencesToOptions): Promise<SavedObjectsRemoveReferencesToResponse>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| type | <code>string</code> | |
| id | <code>string</code> | |
| options | <code>SavedObjectsRemoveReferencesToOptions</code> | |

<b>Returns:</b>

`Promise<SavedObjectsRemoveReferencesToResponse>`

Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<b>Signature:</b>

```typescript
static createConflictError(type: string, id: string): DecoratedError;
static createConflictError(type: string, id: string, reason?: string): DecoratedError;
```

## Parameters
Expand All @@ -16,6 +16,7 @@ static createConflictError(type: string, id: string): DecoratedError;
| --- | --- | --- |
| type | <code>string</code> | |
| id | <code>string</code> | |
| reason | <code>string</code> | |

<b>Returns:</b>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export declare class SavedObjectsErrorHelpers
| Method | Modifiers | Description |
| --- | --- | --- |
| [createBadRequestError(reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.createbadrequesterror.md) | <code>static</code> | |
| [createConflictError(type, id)](./kibana-plugin-core-server.savedobjectserrorhelpers.createconflicterror.md) | <code>static</code> | |
| [createConflictError(type, id, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.createconflicterror.md) | <code>static</code> | |
| [createGenericNotFoundError(type, id)](./kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfounderror.md) | <code>static</code> | |
| [createInvalidVersionError(versionInput)](./kibana-plugin-core-server.savedobjectserrorhelpers.createinvalidversionerror.md) | <code>static</code> | |
| [createTooManyRequestsError(type, id)](./kibana-plugin-core-server.savedobjectserrorhelpers.createtoomanyrequestserror.md) | <code>static</code> | |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsExportOptions](./kibana-plugin-core-server.savedobjectsexportoptions.md) &gt; [hasReference](./kibana-plugin-core-server.savedobjectsexportoptions.hasreference.md)

## SavedObjectsExportOptions.hasReference property

optional array of references to search object for when exporting by types

<b>Signature:</b>

```typescript
hasReference?: SavedObjectsFindOptionsReference[];
```
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ export interface SavedObjectsExportOptions
| --- | --- | --- |
| [excludeExportDetails](./kibana-plugin-core-server.savedobjectsexportoptions.excludeexportdetails.md) | <code>boolean</code> | flag to not append [export details](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) to the end of the export stream. |
| [exportSizeLimit](./kibana-plugin-core-server.savedobjectsexportoptions.exportsizelimit.md) | <code>number</code> | the maximum number of objects to export. |
| [hasReference](./kibana-plugin-core-server.savedobjectsexportoptions.hasreference.md) | <code>SavedObjectsFindOptionsReference[]</code> | optional array of references to search object for when exporting by types |
| [includeReferencesDeep](./kibana-plugin-core-server.savedobjectsexportoptions.includereferencesdeep.md) | <code>boolean</code> | flag to also include all related saved objects in the export stream. |
| [namespace](./kibana-plugin-core-server.savedobjectsexportoptions.namespace.md) | <code>string</code> | optional namespace to override the namespace used by the savedObjectsClient. |
| [objects](./kibana-plugin-core-server.savedobjectsexportoptions.objects.md) | <code>Array&lt;{</code><br/><code> id: string;</code><br/><code> type: string;</code><br/><code> }&gt;</code> | optional array of objects to export. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## SavedObjectsFindOptions.defaultSearchOperator property

The search operator to use with the provided filter. Defaults to `OR`

<b>Signature:</b>

```typescript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,10 @@

## SavedObjectsFindOptions.hasReference property

Search for documents having a reference to the specified objects. Use `hasReferenceOperator` to specify the operator to use when searching for multiple references.

<b>Signature:</b>

```typescript
hasReference?: {
type: string;
id: string;
};
hasReference?: SavedObjectsFindOptionsReference | SavedObjectsFindOptionsReference[];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) &gt; [hasReferenceOperator](./kibana-plugin-core-server.savedobjectsfindoptions.hasreferenceoperator.md)

## SavedObjectsFindOptions.hasReferenceOperator property

The operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`

<b>Signature:</b>

```typescript
hasReferenceOperator?: 'AND' | 'OR';
```
Loading