-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into short-urls-2
- Loading branch information
Showing
644 changed files
with
5,601 additions
and
3,332 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
[[machine-learning-api]] | ||
== {ml-cap} APIs | ||
|
||
//Manage {kib} saved objects, including dashboards, visualizations, and more. | ||
|
||
The following {ml} API is available: | ||
|
||
* <<machine-learning-api-sync, Sync API>> | ||
//to retrieve a single {kib} saved object by ID | ||
|
||
include::machine-learning/sync.asciidoc[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
[[machine-learning-api-sync]] | ||
=== Sync {ml} saved objects API | ||
++++ | ||
<titleabbrev>Sync {ml} saved objects</titleabbrev> | ||
++++ | ||
|
||
Synchronizes {kib} saved objects for {ml} jobs. | ||
|
||
[[machine-learning-api-sync-request]] | ||
==== Request | ||
|
||
`GET <kibana host>:<port>/api/ml/saved_objects/sync` | ||
|
||
`GET <kibana host>:<port>/s/<space_id>/api/ml/saved_objects/sync` | ||
|
||
|
||
[[machine-learning-api-sync-path-params]] | ||
==== 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. | ||
|
||
[[machine-learning-api-sync-query-params]] | ||
==== Query parameters | ||
|
||
`simulate`:: | ||
(Optional, boolean) When `true`, simulates the synchronization by only returning | ||
the list actions that _would_ be performed. | ||
|
||
[[machine-learning-api-sync-response-body]] | ||
==== Response body | ||
|
||
`datafeedsAdded`:: | ||
(array) If a saved object for an {anomaly-job} is missing a {dfeed} identifier, | ||
it is added. This list contains the {dfeed} identifiers and indicates whether | ||
the synchronization was successful. | ||
|
||
`datafeedsRemoved`:: | ||
(array) If saved objects exist for {dfeeds} that no longer exist, they are | ||
deleted. This list contains the {dfeed} identifiers and indicates whether the | ||
synchronization was successful. | ||
|
||
`savedObjectsCreated`:: | ||
(array) If saved objects are missing for {ml} jobs, they are created. This | ||
list contains the job identifiers and indicates whether the synchronization was | ||
successful. | ||
|
||
`savedObjectsDeleted`:: | ||
(array) If saved objects exist for jobs that no longer exist, they are deleted. | ||
This list contains the job identifiers and indicates whether the synchronization | ||
was successful. | ||
|
||
[[machine-learning-api-sync-codes]] | ||
==== Response code | ||
|
||
`200`:: | ||
Indicates a successful call. | ||
|
||
[[machine-learning-api-sync-example]] | ||
==== Example | ||
|
||
Retrieve the list of {ml} saved objects that require synchronization: | ||
|
||
[source,sh] | ||
-------------------------------------------------- | ||
$ curl -X GET api/ml/saved_objects/sync?simulate=true | ||
-------------------------------------------------- | ||
// KIBANA | ||
|
||
If there are two jobs and a {dfeed} that need to be synchronized, for example, | ||
the API returns the following: | ||
|
||
[source,sh] | ||
-------------------------------------------------- | ||
{{"savedObjectsCreated":{"myjob1":{"success":true},"myjob2":{"success":true}},"savedObjectsDeleted":{},"datafeedsAdded":{},"datafeedsRemoved":{"myfeed3":{"success":true}}} | ||
-------------------------------------------------- | ||
|
||
To perform the synchronization, re-run the API and omit the `simulate` parameter. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.