github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-28 11:05:39 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] New template for APIs (#39298)

Browse source 
* Clean up

* Dashboard export API

* More changes

* role-management and saved-objects

* Clean up

* Final clean up

* Clean up

* Moved labels to appropriate places

* Fixed rogue commits
This commit is contained in:
Kaarina Tungseth 2019-09-06 11:09:57 -05:00 • committed by GitHub
parent 9ff21891ae
commit 925dfab588
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
43 changed files with 1071 additions and 960 deletions
Download patch file Download diff file Expand all files Collapse all files

63
docs/api/saved-objects/resolve_import_errors.asciidoc
View file

@ -1,50 +1,73 @@
[[saved-objects-api-resolve-import-errors]]
=== Resolve Import Errors
=== Resolve import errors API
++++
<titleabbrev>Resolve import errors</titleabbrev>
++++
beta[This functionality is *beta*. It's on track to become a stable, permanent feature of {kib}. Caution should be exercised because it is possible a breaking change to these APIs will occur in a minor version, but we’ll avoid this wherever possible. ]
Resolve errors from the import API.
The resolve import errors API enables you to resolve errors given by the import API by either retrying certain saved objects, overwriting specific saved objects or changing references to different saved objects.
To resolve errors, you can:
Note: You cannot access this endpoint via the Console in Kibana.
* Retry certain saved objects
* Overwrite specific saved objects
* Change references to different saved objects
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
[[saved-objects-api-resolve-import-errors-request]]
==== Request
`POST /api/saved_objects/_resolve_import_errors`
[[saved-objects-api-resolve-import-errors-request-body]]
==== Request body
The request body must be of type multipart/form-data.
The request body must include the multipart/form-data type.
`file`::
The same file given to the import API.
`retries`::
(array) A list of `type`, `id`, `replaceReferences` and `overwrite` objects to retry importing. The property `replaceReferences` is a list of `type`, `from` and `to` used to change the object's references.
(array) A list of `type`, `id`, `replaceReferences`, and `overwrite` objects to retry. The property `replaceReferences` is a list of `type`, `from`, and `to` used to change the object references.
[[saved-objects-api-resolve-import-errors-response-body]]
==== Response body
The response body will have a top level `success` property that indicates
if resolving errors was successful or not as well as a `successCount` indicating how many records are successfully resolved.
In the scenario resolving errors wasn't successful, a top level `errors` array will contain the objects that failed to be resolved.
`success`::
Top-level property that indicates if the errors successfully resolved.
`successCount`::
Indicates the number of successfully resolved records.
`errors`::
(array) Specifies the objects that failed to resolve.
[[saved-objects-api-resolve-import-errors-codes]]
==== Response code
`200`::
Indicates a successful call.
[[saved-objects-api-resolve-import-errors-example]]
==== Examples
The following example retries importing a dashboard.
Retry a dashboard import:
[source,js]
--------------------------------------------------
$ curl -X POST "localhost:5601/api/saved_objects/_resolve_import_errors" -H "kbn-xsrf: true" --form file=@file.ndjson --form retries='[{"type":"dashboard","id":"my-dashboard"}]'
--------------------------------------------------
The `file.ndjson` file would contain the following.
The `file.ndjson` file contains the following:
[source,js]
--------------------------------------------------
{"type":"dashboard","id":"my-dashboard","attributes":{"title":"Look at my dashboard"}}
--------------------------------------------------
A successful call returns a response code of `200` and a response body
containing a JSON structure similar to the following example:
The API returns the following:
[source,js]
--------------------------------------------------
@ -54,14 +77,14 @@ containing a JSON structure similar to the following example:
}
--------------------------------------------------
The following example resolves errors for a dashboard. This will cause the dashboard to overwrite the existing saved object.
Resolve errors for a dashboard and overwrite the existing saved object:
[source,js]
--------------------------------------------------
$ curl -X POST "localhost:5601/api/saved_objects/_resolve_import_errors" -H "kbn-xsrf: true" --form file=@file.ndjson --form retries='[{"type":"dashboard","id":"my-dashboard","overwrite":true}]'
--------------------------------------------------
The `file.ndjson` file would contain the following.
The `file.ndjson` file contains the following:
[source,js]
--------------------------------------------------
@ -69,8 +92,7 @@ The `file.ndjson` file would contain the following.
{"type":"dashboard","id":"my-dashboard","attributes":{"title":"Look at my dashboard"}}
--------------------------------------------------
A successful call returns a response code of `200` and a response body
containing a JSON structure similar to the following example:
The API returns the following:
[source,js]
--------------------------------------------------
@ -80,22 +102,21 @@ containing a JSON structure similar to the following example:
}
--------------------------------------------------
The following example resolves errors for a visualization by replacing the index pattern to another.
Resolve errors for a visualization by replacing the index pattern with another:
[source,js]
--------------------------------------------------
$ curl -X POST "localhost:5601/api/saved_objects/_resolve_import_errors" -H "kbn-xsrf: true" --form file=@file.ndjson --form retries='[{"type":"visualization","id":"my-vis","replaceReferences":[{"type":"index-pattern","from":"missing","to":"existing"}]}]'
--------------------------------------------------
The `file.ndjson` file would contain the following.
The `file.ndjson` file contains the following:
[source,js]
--------------------------------------------------
{"type":"visualization","id":"my-vis","attributes":{"title":"Look at my visualization"},"references":[{"name":"ref_0","type":"index-pattern","id":"missing"}]}
--------------------------------------------------
A successful call returns a response code of `200` and a response body
containing a JSON structure similar to the following example:
The API returns the following:
[source,js]
--------------------------------------------------