Skip to content

Commit

Permalink
Merge branch '8.5' into backport/8.5/pr-141239
Browse files Browse the repository at this point in the history
  • Loading branch information
Spencer authored Sep 22, 2022
2 parents 7680503 + 27d21e5 commit b5ff4e1
Show file tree
Hide file tree
Showing 26 changed files with 1,086 additions and 68 deletions.
3 changes: 0 additions & 3 deletions .buildkite/ftr_configs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,6 @@ enabled:
- x-pack/test/api_integration/config_security_basic.ts
- x-pack/test/api_integration/config_security_trial.ts
- x-pack/test/api_integration/config.ts
- x-pack/test/apm_api_integration/basic/config.ts
- x-pack/test/apm_api_integration/rules/config.ts
- x-pack/test/apm_api_integration/trial/config.ts
- x-pack/test/banners_functional/config.ts
- x-pack/test/cases_api_integration/security_and_spaces/config_basic.ts
- x-pack/test/cases_api_integration/security_and_spaces/config_trial.ts
Expand Down
3 changes: 3 additions & 0 deletions docs/api/saved-objects.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ The following saved objects APIs are available:

* <<saved-objects-api-delete, Delete object API>> to remove {kib} saved objects

* <<saved-objects-api-bulk-delete, Bulk delete objects API>> to remove multiple {kib} saved objects

* <<saved-objects-api-export, Export objects API>> to retrieve sets of saved objects that you want to import into {kib}

* <<saved-objects-api-import, Import objects API>> to create sets of {kib} saved objects from a file created by the export API
Expand All @@ -46,6 +48,7 @@ include::saved-objects/bulk_create.asciidoc[]
include::saved-objects/update.asciidoc[]
include::saved-objects/bulk_update.asciidoc[]
include::saved-objects/delete.asciidoc[]
include::saved-objects/bulk_delete.asciidoc[]
include::saved-objects/export.asciidoc[]
include::saved-objects/import.asciidoc[]
include::saved-objects/resolve_import_errors.asciidoc[]
Expand Down
107 changes: 107 additions & 0 deletions docs/api/saved-objects/bulk_delete.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
[[saved-objects-api-bulk-delete]]
=== Bulk delete object API
++++
<titleabbrev>Bulk delete objects</titleabbrev>
++++

experimental[] Remove multiple {kib} saved objects.

WARNING: Once you delete a saved object, _it cannot be recovered_.

==== Request

`POST <kibana host>:<port>/api/saved_objects/_bulk_delete`

`POST <kibana host>:<port>/s/<space_id>/api/saved_objects/_bulk_delete`

==== Path parameters

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.

==== Request body

`type`::
(Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`.

`id`::
(Required, string) The object ID to remove.

==== Query parameters

`force`::
(Optional, boolean) When true, force delete objects that exist in multiple namespaces. Note that the option applies to the whole request. Use the <<saved-objects-api-delete, delete object>> to specify per-object delete behavior.
+
TIP: Use this if you attempted to delete objects and received an HTTP 400 error with the following message: _"Unable to delete saved object that exists in multiple namespaces, use the `force` option to delete it anyway"_
+
WARNING: When you bulk delete objects that exist in multiple namespaces, the API also deletes <<legacy-url-aliases, legacy url aliases>> that reference the object. These requests are batched to minimise the impact but they can place a heavy load on {kib}. Make sure you limit the number of objects that exist in multiple namespaces in a single bulk delete operation.

==== Response code
`200`::
Indicates a successful call. Note, this HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual
objects will be returned in the response body. Refer to the example below for details.

==== Response body

`statuses`::
(array) Top-level property that contains objects that represent the response for each of the requested objects. The order of the objects in the response is identical to the order of the objects in the request.

Saved objects that cannot be removed will include an error object.

==== Example

Delete three saved objects, where one of them does not exist and one exists in multiple namespaces:

[source,sh]
--------------------------------------------------
$ curl -X POST api/saved_objects/_bulk_delete
[
{
type: 'visualization',
id: 'not an id',
},
{
type: 'dashboard',
id: 'be3733a0-9efe-11e7-acb3-3dab96693fab',
{
type: 'index-pattern',
id: 'd3d7af60-4c81-11e8-b3d7-01146121b73d',
}
]
--------------------------------------------------
// KIBANA

The API returns the following:

[source,sh]
--------------------------------------------------
{
"statuses": [
{
"success": false,
"id": "not an id",
"type": "visualization",
"error": {
"statusCode": 404,
"error": "Not Found",
"message": "Saved object [visualization/not an id] not found",
},
},
{
"success": true,
"id": "be3733a0-9efe-11e7-acb3-3dab96693fab",
"type": "dashboard",
},
{
"success": false,
"id": "d3d7af60-4c81-11e8-b3d7-01146121b73d",
"type": "index-pattern",
"error": {
"statusCode": 400,
"error": "Bad Request",
"message": "Unable to delete saved object id: d3d7af60-4c81-11e8-b3d7-01146121b73d, type: index-pattern that exists in multiple namespaces, use the \"force\" option to delete all saved objects: Bad Request",
},
}
]
}
--------------------------------------------------
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
],
"private": true,
"version": "8.5.0",
"branch": "main",
"branch": "8.5",
"types": "./kibana.d.ts",
"tsdocMetadata": "./build/tsdoc-metadata.json",
"build": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -562,10 +562,6 @@ export const stackManagementSchema: MakeSchemaFrom<UsageStats> = {
type: 'boolean',
_meta: { description: 'Non-default value of setting.' },
},
'enterpriseSearch:enableIndexTransformsTab': {
type: 'boolean',
_meta: { description: 'Non-default value of setting.' },
},
'enterpriseSearch:enableBehavioralAnalyticsSection': {
type: 'boolean',
_meta: { description: 'Non-default value of setting.' },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,5 @@ export interface UsageStats {
'securitySolution:enableGroupedNav': boolean;
'securitySolution:showRelatedIntegrations': boolean;
'visualization:visualize:legacyGaugeChartsLibrary': boolean;
'enterpriseSearch:enableIndexTransformsTab': boolean;
'enterpriseSearch:enableBehavioralAnalyticsSection': boolean;
}
6 changes: 0 additions & 6 deletions src/plugins/telemetry/schema/oss_plugins.json
Original file line number Diff line number Diff line change
Expand Up @@ -8888,12 +8888,6 @@
"description": "Non-default value of setting."
}
},
"enterpriseSearch:enableIndexTransformsTab": {
"type": "boolean",
"_meta": {
"description": "Non-default value of setting."
}
},
"enterpriseSearch:enableBehavioralAnalyticsSection": {
"type": "boolean",
"_meta": {
Expand Down
Loading

0 comments on commit b5ff4e1

Please sign in to comment.