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

[DOCS] Updated API experimental notes (#46008) (#46033)

Browse source
This commit is contained in:
Kaarina Tungseth 2019-09-18 13:20:00 -05:00 • committed by GitHub
parent dfe260048b
commit f6ac0d9232
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
34 changed files with 42 additions and 74 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/api/dashboard-import/export.asciidoc
View file

@ -4,9 +4,7 @@
<titleabbrev>Dashboard export</titleabbrev>
++++
Export dashboards and corresponding saved objects.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental[] Export dashboards and corresponding saved objects.
[[dashboard-api-export-request]]
==== Request

4
docs/api/dashboard-import/import.asciidoc
View file

@ -4,9 +4,7 @@
<titleabbrev>Import dashboard</titleabbrev>
++++
Import dashboards and corresponding saved objects.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental[] Import dashboards and corresponding saved objects.
[[dashboard-api-import-request]]
==== Request

4
docs/api/features/get.asciidoc
View file

@ -4,9 +4,7 @@
<titleabbrev>Get features</titleabbrev>
++++
Retrieves all {kib} features.
experimental[This API is *experimental* and may be changed or removed completely in a future release.]
experimental[] Retrieves all {kib} features.
[[features-api-get-request]]
==== Request

4
docs/api/logstash-configuration-management/create.asciidoc
View file

@ -5,9 +5,7 @@
<titleabbrev>Create pipeline</titleabbrev>
++++
Create a centrally-managed Logstash pipeline, or update an existing pipeline.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental[] Create a centrally-managed Logstash pipeline, or update an existing pipeline.
[[logstash-configuration-management-api-create-request]]
==== Request

4
docs/api/logstash-configuration-management/delete.asciidoc
View file

@ -5,9 +5,7 @@
<titleabbrev>Delete pipeline</titleabbrev>
++++
Delete a centrally-managed Logstash pipeline.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental[] Delete a centrally-managed Logstash pipeline.
[[logstash-configuration-management-api-delete-request]]
==== Request

4
docs/api/logstash-configuration-management/list.asciidoc
View file

@ -5,9 +5,7 @@
<titleabbrev>List pipeline</titleabbrev>
++++
List all centrally-managed Logstash pipelines.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental[] List all centrally-managed Logstash pipelines.
[[logstash-configuration-management-api-list-request]]
==== Request

4
docs/api/logstash-configuration-management/retrieve.asciidoc
View file

@ -5,9 +5,7 @@
<titleabbrev>Retrieve pipeline</titleabbrev>
++++
Retrieves a centrally-managed Logstash pipeline.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental[] Retrieves a centrally-managed Logstash pipeline.
[[logstash-configuration-management-api-retrieve-request]]
==== Request

2
docs/api/role-management/delete.asciidoc
View file

@ -6,7 +6,7 @@
Deletes a {kib} role.
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying mechanism of enforcing role based access control is stable, but the APIs for managing the roles are currently experimental."]
experimental["The underlying mechanism of enforcing role-based access control is stable, but the APIs for managing the roles are experimental."]
[[role-management-api-delete-prereqs]]
==== Prerequisite

2
docs/api/role-management/get-all.asciidoc
View file

@ -6,7 +6,7 @@
Retrieves all {kib} roles.
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying mechanism of enforcing role based access control is stable, but the APIs for managing the roles are currently experimental."]
experimental["The underlying mechanism of enforcing role-based access control is stable, but the APIs for managing the roles are experimental."]
[[role-management-api-get-prereqs]]
==== Prerequisite

2
docs/api/role-management/get.asciidoc
View file

@ -6,7 +6,7 @@
Retrieves a specific role.
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying mechanism of enforcing role based access control is stable, but the APIs for managing the roles are currently experimental."]
experimental["The underlying mechanism of enforcing role-based access control is stable, but the APIs for managing the roles are experimental."]
[[role-management-specific-api-get-prereqs]]
==== Prerequisite

2
docs/api/role-management/put.asciidoc
View file

@ -7,7 +7,7 @@
Creates a new {kib} role, or updates the attributes of an existing role. {kib} roles are stored in the
{es} native realm.
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying mechanism of enforcing role based access control is stable, but the APIs for managing the roles are currently experimental."]
experimental["The underlying mechanism of enforcing role-based access control is stable, but the APIs for managing the roles are experimental."]
[[role-management-api-put-request]]
==== Request

4
docs/api/saved-objects/bulk_create.asciidoc
View file

@ -4,9 +4,7 @@
<titleabbrev>Bulk create objects</titleabbrev>
++++
Create multiple {kib} saved objects.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental[] Create multiple {kib} saved objects.
[[saved-objects-api-bulk-create-request]]
==== Request

4
docs/api/saved-objects/bulk_get.asciidoc
View file

@ -4,9 +4,7 @@
<titleabbrev>Bulk get objects</titleabbrev>
++++
Retrieves multiple {kib} saved objects by ID.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental[] Retrieves multiple {kib} saved objects by ID.
[[saved-objects-api-bulk-get-request]]
==== Request

4
docs/api/saved-objects/create.asciidoc
View file

@ -4,9 +4,7 @@
<titleabbrev>Create object</titleabbrev>
++++
Create a {kib} saved object.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental[] Create a {kib} saved object.
[[saved-objects-api-create-request]]
==== Request

4
docs/api/saved-objects/delete.asciidoc
View file

@ -4,12 +4,10 @@
<titleabbrev>Delete object</titleabbrev>
++++
Remove a {kib} saved object.
experimental[] Remove a {kib} saved object.
WARNING: Once you delete a saved object, _it cannot be recovered_.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
[[saved-objects-api-delete-request]]
==== Request

4
docs/api/saved-objects/export.asciidoc
View file

@ -4,9 +4,7 @@
<titleabbrev>Export objects</titleabbrev>
++++
Retrieve a set of saved objects that you want to import into {kib}.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental[] Retrieve a set of saved objects that you want to import into {kib}.
[[saved-objects-api-export-request]]
==== Request

4
docs/api/saved-objects/find.asciidoc
View file

@ -4,9 +4,7 @@
<titleabbrev>Find objects</titleabbrev>
++++
Retrieve a paginated set of {kib} saved objects by various conditions.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental[] Retrieve a paginated set of {kib} saved objects by various conditions.
[[saved-objects-api-find-request]]
==== Request

4
docs/api/saved-objects/get.asciidoc
View file

@ -4,9 +4,7 @@
<titleabbrev>Get object</titleabbrev>
++++
Retrieve a single {kib} saved object by ID.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental[] Retrieve a single {kib} saved object by ID.
[[saved-objects-api-get-request]]
==== Request

4
docs/api/saved-objects/import.asciidoc
View file

@ -4,9 +4,7 @@
<titleabbrev>Import objects</titleabbrev>
++++
Create a set of {kib} saved objects from a file created by the export API.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental[] Create a set of {kib} saved objects from a file created by the export API.
[[saved-objects-api-import-request]]
==== Request

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

@ -4,7 +4,7 @@
<titleabbrev>Resolve import errors</titleabbrev>
++++
Resolve errors from the import API.
experimental[] Resolve errors from the import API.
To resolve errors, you can:
@ -14,8 +14,6 @@ To resolve errors, you can:
* 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

4
docs/api/saved-objects/update.asciidoc
View file

@ -4,9 +4,7 @@
<titleabbrev>Update object</titleabbrev>
++++
Update the attributes for an existing {kib} saved object.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.
experimental[] Update the attributes for an existing {kib} saved object.
[[saved-objects-api-update-request]]
==== Request

4
docs/api/spaces-management/copy_saved_objects.asciidoc
View file

@ -5,9 +5,7 @@
<titleabbrev>Copy saved objects to space</titleabbrev>
++++
Copies saved objects from one space to other spaces.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental["The underlying Spaces concepts are stable, but the APIs for managing Spaces are experimental."]
////
Use the appropriate heading levels for your book.

4
docs/api/spaces-management/delete.asciidoc
View file

@ -6,9 +6,9 @@
Deletes a {kib} space.
WARNING: When you delete a space, all saved objects that belong to the space are automatically deleted, which is permanent and cannot be undone.
experimental["The underlying Spaces concepts are stable, but the APIs for managing Spaces are experimental."]
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."]
WARNING: When you delete a space, all saved objects that belong to the space are automatically deleted, which is permanent and cannot be undone.
[[spaces-api-delete-request]]
==== Request

2
docs/api/spaces-management/get.asciidoc
View file

@ -6,7 +6,7 @@
Retrieves a specified {kib} space.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental["The underlying Spaces concepts are stable, but the APIs for managing Spaces are experimental."]
[[spaces-api-get-request]]
==== Request

2
docs/api/spaces-management/get_all.asciidoc
View file

@ -6,7 +6,7 @@
Retrieves all {kib} spaces.
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."]
experimental["The underlying Spaces concepts are stable, but the APIs for managing Spaces are experimental."]
[[spaces-api-get-all-request]]
==== Request

2
docs/api/spaces-management/post.asciidoc
View file

@ -6,7 +6,7 @@
Creates a {kib} space.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental["The underlying Spaces concepts are stable, but the APIs for managing Spaces are experimental."]
[[spaces-api-post-request]]
==== Request

2
docs/api/spaces-management/put.asciidoc
View file

@ -6,7 +6,7 @@
Updates an existing {kib} space.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental["The underlying Spaces concepts are stable, but the APIs for managing Spaces are experimental."]
[[spaces-api-put-api-request]]
==== Request

2
docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc
View file

@ -7,7 +7,7 @@
Overwrites specific saved objects that were returned as errors from the <<spaces-api-copy-saved-objects, Copy Saved Objects to Space API>>.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental["The underlying Spaces concepts are stable, but the APIs for managing Spaces are experimental."]
////
Use the appropriate heading levels for your book.

2
docs/api/upgrade-assistant/cancel_reindex.asciidoc
View file

@ -6,7 +6,7 @@
Cancel reindexes that are waiting for the Elasticsearch reindex task to complete. For example, `lastCompletedStep` set to `40`.
experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are currently experimental.]
experimental["The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are experimental."]
[[cancel-reindex-request]]
==== Request

2
docs/api/upgrade-assistant/check_reindex_status.asciidoc
View file

@ -6,7 +6,7 @@
Check the status of the reindex operation.
experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are currently experimental.]
experimental["The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are experimental."]
[[check-reindex-status-request]]
==== Request

2
docs/api/upgrade-assistant/reindexing.asciidoc
View file

@ -6,7 +6,7 @@
Start a new reindex or resume a paused reindex.
experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are currently experimental.]
experimental["The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are experimental."]
[[start-resume-reindex-request]]
==== Request

2
docs/api/upgrade-assistant/status.asciidoc
View file

@ -6,7 +6,7 @@
Check the status of your cluster.
experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are currently experimental.]
experimental["The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are experimental."]
[[upgrade-assistant-api-status-request]]
==== Request

4
docs/api/url_shortening/shorten_url.asciidoc
View file

@ -4,9 +4,7 @@
<titleabbrev>Shorten URL</titleabbrev>
++++
Convert a {kib} URL into a token.
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
experimental[] Convert a {kib} URL into a token.
[[url-shortening-api-request]]
==== Request

10
docs/user/api.asciidoc
View file

@ -3,9 +3,14 @@
[partintro]
--
Some {kib} features are provided via a REST API, which is ideal for creating an integration with {kib}, or automating
certain aspects of configuring and deploying {kib}.
Some {kib} features are provided via a REST API, which is ideal for creating an
integration with {kib}, or automating certain aspects of configuring and
deploying {kib}.
Each API is experimental and can include breaking changes in any version of
{kib}, or might have been entirely removed from {kib}.
////
Each API has one of the following labels:
* *Stable* APIs should be safe to use extensively in production. Any breaking
@ -22,6 +27,7 @@ have breaking changes in any version of {kib}, or it might even be removed
entirely.
If a label is missing from an API, it is considered `experimental`.
////
NOTE: You cannot access the APIs via the Console in {kib}.