-
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.
Browse files
Browse the repository at this point in the history
- Loading branch information
Showing
118 changed files
with
4,874 additions
and
825 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| [[saved-objects-api-resolve]] | ||
| === Resolve object API | ||
| ++++ | ||
| <titleabbrev>Resolve object</titleabbrev> | ||
| ++++ | ||
|
|
||
| experimental[] Retrieve a single {kib} saved object by ID, using any legacy URL alias if it exists. | ||
|
|
||
| Under certain circumstances, when Kibana is upgraded, saved object migrations may necessitate regenerating some object IDs to enable new | ||
| features. When an object's ID is regenerated, a legacy URL alias is created for that object, preserving its old ID. In such a scenario, that | ||
| object can be retrieved via the Resolve API using either its new ID or its old ID. | ||
|
|
||
| [[saved-objects-api-resolve-request]] | ||
| ==== Request | ||
|
|
||
| `GET <kibana host>:<port>/api/saved_objects/resolve/<type>/<id>` | ||
|
|
||
| `GET <kibana host>:<port>/s/<space_id>/api/saved_objects/resolve/<type>/<id>` | ||
|
|
||
| [[saved-objects-api-resolve-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. | ||
|
|
||
|
|
||
| `type`:: | ||
| (Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`. | ||
|
|
||
| `id`:: | ||
| (Required, string) The ID of the object to retrieve. | ||
|
|
||
| [[saved-objects-api-resolve-codes]] | ||
| ==== Response code | ||
|
|
||
| `200`:: | ||
| Indicates a successful call. | ||
|
|
||
| [[saved-objects-api-resolve-example]] | ||
| ==== Example | ||
|
|
||
| Retrieve the index pattern object with the `my-pattern` ID: | ||
|
|
||
| [source,sh] | ||
| -------------------------------------------------- | ||
| $ curl -X GET api/saved_objects/resolve/index-pattern/my-pattern | ||
| -------------------------------------------------- | ||
| // KIBANA | ||
|
|
||
| The API returns the following: | ||
|
|
||
| [source,sh] | ||
| -------------------------------------------------- | ||
| { | ||
| "saved_object": { | ||
| "id": "my-pattern", | ||
| "type": "index-pattern", | ||
| "version": 1, | ||
| "attributes": { | ||
| "title": "my-pattern-*" | ||
| } | ||
| }, | ||
| "outcome": "exactMatch" | ||
| } | ||
| -------------------------------------------------- | ||
|
|
||
| The `outcome` field may be any of the following: | ||
|
|
||
| * `"exactMatch"` -- One document exactly matched the given ID. | ||
| * `"aliasMatch"` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different than the given ID. | ||
| * `"conflict"` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID. | ||
|
|
||
| Retrieve a dashboard object in the `testspace` by ID: | ||
|
|
||
| [source,sh] | ||
| -------------------------------------------------- | ||
| $ curl -X GET s/testspace/api/saved_objects/resolve/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d | ||
| -------------------------------------------------- | ||
| // KIBANA | ||
|
|
||
| The API returns the following: | ||
|
|
||
| [source,sh] | ||
| -------------------------------------------------- | ||
| { | ||
| "saved_object": { | ||
| "id": "7adfa750-4c81-11e8-b3d7-01146121b73d", | ||
| "type": "dashboard", | ||
| "updated_at": "2019-07-23T00:11:07.059Z", | ||
| "version": "WzQ0LDFd", | ||
| "attributes": { | ||
| "title": "[Flights] Global Flight Dashboard", | ||
| "hits": 0, | ||
| "description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats", | ||
| "panelsJSON": "[ . . . ]", | ||
| "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}", | ||
| "version": 1, | ||
| "timeRestore": true, | ||
| "timeTo": "now", | ||
| "timeFrom": "now-24h", | ||
| "refreshInterval": { | ||
| "display": "15 minutes", | ||
| "pause": false, | ||
| "section": 2, | ||
| "value": 900000 | ||
| }, | ||
| "kibanaSavedObjectMeta": { | ||
| "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}" | ||
| } | ||
| }, | ||
| "references": [ | ||
| { | ||
| "name": "panel_0", | ||
| "type": "visualization", | ||
| "id": "aeb212e0-4c84-11e8-b3d7-01146121b73d" | ||
| }, | ||
| . . . | ||
| { | ||
| "name": "panel_18", | ||
| "type": "visualization", | ||
| "id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b" | ||
| } | ||
| ], | ||
| "migrationVersion": { | ||
| "dashboard": "7.0.0" | ||
| } | ||
| }, | ||
| "outcome": "conflict" | ||
| } | ||
| -------------------------------------------------- |
13 changes: 13 additions & 0 deletions
13
...pment/core/public/kibana-plugin-core-public.savedobject.coremigrationversion.md
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,13 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [coreMigrationVersion](./kibana-plugin-core-public.savedobject.coremigrationversion.md) | ||
|
|
||
| ## SavedObject.coreMigrationVersion property | ||
|
|
||
| A semver value that is used when upgrading objects between Kibana versions. | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| coreMigrationVersion?: string; | ||
| ``` |
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
13 changes: 13 additions & 0 deletions
13
...lic/kibana-plugin-core-public.savedobjectscreateoptions.coremigrationversion.md
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,13 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) > [coreMigrationVersion](./kibana-plugin-core-public.savedobjectscreateoptions.coremigrationversion.md) | ||
|
|
||
| ## SavedObjectsCreateOptions.coreMigrationVersion property | ||
|
|
||
| A semver value that is used when upgrading objects between Kibana versions. | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| coreMigrationVersion?: string; | ||
| ``` |
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
11 changes: 11 additions & 0 deletions
11
...core/public/kibana-plugin-core-public.simplesavedobject.coremigrationversion.md
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 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [coreMigrationVersion](./kibana-plugin-core-public.simplesavedobject.coremigrationversion.md) | ||
|
|
||
| ## SimpleSavedObject.coreMigrationVersion property | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| coreMigrationVersion: SavedObjectType<T>['coreMigrationVersion']; | ||
| ``` |
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.