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] Updates API requests and examples (#60695)

Browse source 
* [DOCS] Updates API requests and examples

* Review comments
This commit is contained in:
Kaarina Tungseth 2020-03-20 16:33:20 -05:00 • committed by GitHub
parent cf9b64eada
commit fda3196611
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
37 changed files with 309 additions and 620 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -17,9 +17,9 @@ To resolve errors, you can:
[[saved-objects-api-resolve-import-errors-request]]
==== Request
`POST /api/saved_objects/_resolve_import_errors`
`POST <kibana host>:<port>/api/saved_objects/_resolve_import_errors`
`POST /s/<space_id>/api/saved_objects/_resolve_import_errors`
`POST <kibana host>:<port>/s/<space_id>/api/saved_objects/_resolve_import_errors`
[[saved-objects-api-resolve-import-errors-path-params]]
==== Path parameters
@ -61,21 +61,22 @@ The request body must include the multipart/form-data type.
Retry a dashboard import:
[source,js]
[source,sh]
--------------------------------------------------
$ 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"}]'
--------------------------------------------------
// KIBANA
The `file.ndjson` file contains the following:
[source,js]
[source,sh]
--------------------------------------------------
{"type":"dashboard","id":"my-dashboard","attributes":{"title":"Look at my dashboard"}}
--------------------------------------------------
The API returns the following:
[source,js]
[source,sh]
--------------------------------------------------
{
"success": true,
@ -85,14 +86,15 @@ The API returns the following:
Resolve errors for a dashboard and overwrite the existing saved object:
[source,js]
[source,sh]
--------------------------------------------------
$ 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}]'
--------------------------------------------------
// KIBANA
The `file.ndjson` file contains the following:
[source,js]
[source,sh]
--------------------------------------------------
{"type":"index-pattern","id":"my-pattern","attributes":{"title":"my-pattern-*"}}
{"type":"dashboard","id":"my-dashboard","attributes":{"title":"Look at my dashboard"}}
@ -100,7 +102,7 @@ The `file.ndjson` file contains the following:
The API returns the following:
[source,js]
[source,sh]
--------------------------------------------------
{
"success": true,
@ -110,21 +112,22 @@ The API returns the following:
Resolve errors for a visualization by replacing the index pattern with another:
[source,js]
[source,sh]
--------------------------------------------------
$ 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"}]}]'
--------------------------------------------------
// KIBANA
The `file.ndjson` file contains the following:
[source,js]
[source,sh]
--------------------------------------------------
{"type":"visualization","id":"my-vis","attributes":{"title":"Look at my visualization"},"references":[{"name":"ref_0","type":"index-pattern","id":"missing"}]}
--------------------------------------------------
The API returns the following:
[source,js]
[source,sh]
--------------------------------------------------
{
"success": true,