diff --git a/docs/api/dashboard-api.asciidoc b/docs/api/dashboard-api.asciidoc index 60df46b899f14..60360e406e372 100644 --- a/docs/api/dashboard-api.asciidoc +++ b/docs/api/dashboard-api.asciidoc @@ -1,7 +1,7 @@ [[dashboard-api]] == Import and export dashboard APIs -deprecated::[7.15.0,Both of these APIs have been deprecated in favor of the {api-kibana}/group/endpoint-saved-objects[saved objects API].] +deprecated::[7.15.0,Both of these APIs have been deprecated and will be removed in 9.0.0] Import and export dashboards with the corresponding saved objects, such as visualizations, saved searches, and data views. @@ -16,4 +16,4 @@ The following import and export dashboard APIs are available: * <> to export dashboards and corresponding saved objects include::dashboard/import-dashboard.asciidoc[] -include::dashboard/export-dashboard.asciidoc[] \ No newline at end of file +include::dashboard/export-dashboard.asciidoc[] diff --git a/docs/api/data-views.asciidoc b/docs/api/data-views.asciidoc index 62d1546bdfd45..f15d7d40f49b3 100644 --- a/docs/api/data-views.asciidoc +++ b/docs/api/data-views.asciidoc @@ -8,5 +8,3 @@ For the latest details, refer to {api-kibana}/group/endpoint-data-views[data vie WARNING: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future {kib} versions. -WARNING: Use the data views APIs for managing data views instead of lower-level <>. - diff --git a/docs/api/osquery-manager.asciidoc b/docs/api/osquery-manager.asciidoc index f1c6f5cc664ee..2607bdad1f54f 100644 --- a/docs/api/osquery-manager.asciidoc +++ b/docs/api/osquery-manager.asciidoc @@ -3,7 +3,7 @@ experimental[] Run live queries, manage packs and saved queries -WARNING: Use the osquery manager APIs for managing packs and saved queries instead of lower-level <>. +Use the osquery manager APIs for managing packs and saved queries. The following osquery manager APIs are available: diff --git a/docs/api/saved-objects.asciidoc b/docs/api/saved-objects.asciidoc index b8e7f00f54872..3e0e206b468e7 100644 --- a/docs/api/saved-objects.asciidoc +++ b/docs/api/saved-objects.asciidoc @@ -1,9 +1,4 @@ [[saved-objects-api]] == Saved objects APIs -Manage {kib} saved objects, including dashboards, visualizations, and more. - -For the latest details, refer to the {api-kibana}/group/endpoint-saved-objects[saved object API]. - -WARNING: Do not write documents directly to the `.kibana` index. When you write directly -to the `.kibana` index, the data becomes corrupted and permanently breaks future {kib} versions. +For the latest details, refer to the {api-kibana}/group/endpoint-saved-objects[saved objects API]. diff --git a/docs/api/short-urls.asciidoc b/docs/api/short-urls.asciidoc index ded639c897f3f..0b47efa83e02f 100644 --- a/docs/api/short-urls.asciidoc +++ b/docs/api/short-urls.asciidoc @@ -1,7 +1,14 @@ [[short-urls-api]] == Short URLs APIs -Manage {kib} short URLs. +experimental[] Manage {kib} short URLs. + +The following short urls APIs are available: + +* <> +* <> +* <> +* <> include::short-urls/create-short-url.asciidoc[] include::short-urls/get-short-url.asciidoc[] diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml index 8d81681f3789e..363fc33d89a3e 100644 --- a/oas_docs/output/kibana.serverless.yaml +++ b/oas_docs/output/kibana.serverless.yaml @@ -19031,10 +19031,25 @@ tags: - name: Fleet uninstall tokens - description: Machine learning name: ml - - description: >- - Manage Kibana saved objects, including dashboards, visualizations, and - more. + - description: > + Export sets of saved objects that you want to import into {kib}, resolve + import errors, and rotate an encryption key for encrypted saved objects + with the saved objects APIs. + + + To manage a specific type of saved object, use the corresponding APIs. + + For example, use: + + + [Data views](../group/endpoint-data-views) + + + Warning: Do not write documents directly to the `.kibana` index. When you + write directly to the `.kibana` index, the data becomes corrupted and + permanently breaks future Kibana versions. name: saved objects + x-displayName: Saved objects - description: 'SLO APIs enable you to define, manage and track service-level objectives' name: slo - name: system diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml index dfe69b9be3400..d5ad2469780bc 100644 --- a/oas_docs/output/kibana.yaml +++ b/oas_docs/output/kibana.yaml @@ -27592,10 +27592,30 @@ tags: - name: Fleet uninstall tokens - description: Machine learning name: ml - - description: >- - Manage Kibana saved objects, including dashboards, visualizations, and - more. + - description: > + Export sets of saved objects that you want to import into {kib}, resolve + import errors, and rotate an encryption key for encrypted saved objects + with the saved objects APIs. + + + To manage a specific type of saved object, use the corresponding APIs. + + For example, use: + + + * [Data views](../group/endpoint-data-views) + + * [Spaces](https://www.elastic.co/guide/en/kibana/current/spaces-api.html) + + * [Short + URLs](https://www.elastic.co/guide/en/kibana/current/short-urls-api.html) + + + Warning: Do not write documents directly to the `.kibana` index. When you + write directly to the `.kibana` index, the data becomes corrupted and + permanently breaks future Kibana versions. name: saved objects + x-displayName: Saved objects - description: 'SLO APIs enable you to define, manage and track service-level objectives' name: slo - name: system diff --git a/oas_docs/overlays/kibana.overlays.serverless.yaml b/oas_docs/overlays/kibana.overlays.serverless.yaml index dc21647813180..5d1064eecb37e 100644 --- a/oas_docs/overlays/kibana.overlays.serverless.yaml +++ b/oas_docs/overlays/kibana.overlays.serverless.yaml @@ -50,10 +50,6 @@ actions: description: Change displayName update: x-displayName: "Machine learning" - - target: '$.tags[?(@.name=="saved objects")]' - description: Change displayName - update: - x-displayName: "Saved objects" - target: '$.tags[?(@.name=="slo")]' description: Change displayName update: diff --git a/oas_docs/overlays/kibana.overlays.yaml b/oas_docs/overlays/kibana.overlays.yaml index 926550ca085b7..cd3b40eeda819 100644 --- a/oas_docs/overlays/kibana.overlays.yaml +++ b/oas_docs/overlays/kibana.overlays.yaml @@ -65,10 +65,6 @@ actions: description: Change displayName update: x-displayName: "Machine learning" - - target: '$.tags[?(@.name=="saved objects")]' - description: Change displayName - update: - x-displayName: "Saved objects" - target: '$.tags[?(@.name=="slo")]' description: Change displayName update: diff --git a/packages/core/saved-objects/docs/openapi/bundled.json b/packages/core/saved-objects/docs/openapi/bundled.json index 06010e44e1a19..36439a6b46749 100644 --- a/packages/core/saved-objects/docs/openapi/bundled.json +++ b/packages/core/saved-objects/docs/openapi/bundled.json @@ -20,7 +20,8 @@ "tags": [ { "name": "saved objects", - "description": "Manage Kibana saved objects, including dashboards, visualizations, and more." + "x-displayName": "Saved objects", + "description": "Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.\n\nTo manage a specific type of saved object, use the corresponding APIs.\nFor example, use:\n\n* [Data views](../group/endpoint-data-views)\n* [Spaces](https://www.elastic.co/guide/en/kibana/current/spaces-api.html)\n* [Short URLs](https://www.elastic.co/guide/en/kibana/current/short-urls-api.html)\n\nWarning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions.\n" } ], "paths": { diff --git a/packages/core/saved-objects/docs/openapi/bundled.yaml b/packages/core/saved-objects/docs/openapi/bundled.yaml index d616131ac494e..130c1c8d0a252 100644 --- a/packages/core/saved-objects/docs/openapi/bundled.yaml +++ b/packages/core/saved-objects/docs/openapi/bundled.yaml @@ -12,7 +12,18 @@ servers: - url: / tags: - name: saved objects - description: Manage Kibana saved objects, including dashboards, visualizations, and more. + x-displayName: Saved objects + description: | + Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs. + + To manage a specific type of saved object, use the corresponding APIs. + For example, use: + + * [Data views](../group/endpoint-data-views) + * [Spaces](https://www.elastic.co/guide/en/kibana/current/spaces-api.html) + * [Short URLs](https://www.elastic.co/guide/en/kibana/current/short-urls-api.html) + + Warning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions. paths: /api/encrypted_saved_objects/_rotate_key: post: diff --git a/packages/core/saved-objects/docs/openapi/bundled_serverless.json b/packages/core/saved-objects/docs/openapi/bundled_serverless.json index 6bc767088bbec..61a2671c878cf 100644 --- a/packages/core/saved-objects/docs/openapi/bundled_serverless.json +++ b/packages/core/saved-objects/docs/openapi/bundled_serverless.json @@ -25,7 +25,8 @@ "tags": [ { "name": "saved objects", - "description": "Manage Kibana saved objects, including dashboards, visualizations, and more." + "x-displayName": "Saved objects", + "description": "Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.\n\nTo manage a specific type of saved object, use the corresponding APIs.\nFor example, use:\n\n[Data views](../group/endpoint-data-views)\n\nWarning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions.\n" } ], "paths": { diff --git a/packages/core/saved-objects/docs/openapi/bundled_serverless.yaml b/packages/core/saved-objects/docs/openapi/bundled_serverless.yaml index a8dc8b30fffe2..00331902faa17 100644 --- a/packages/core/saved-objects/docs/openapi/bundled_serverless.yaml +++ b/packages/core/saved-objects/docs/openapi/bundled_serverless.yaml @@ -15,7 +15,16 @@ servers: default: localhost:5601 tags: - name: saved objects - description: Manage Kibana saved objects, including dashboards, visualizations, and more. + x-displayName: Saved objects + description: | + Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs. + + To manage a specific type of saved object, use the corresponding APIs. + For example, use: + + [Data views](../group/endpoint-data-views) + + Warning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions. paths: /api/saved_objects/_export: post: diff --git a/packages/core/saved-objects/docs/openapi/entrypoint.yaml b/packages/core/saved-objects/docs/openapi/entrypoint.yaml index ee20a72801647..5cd9039988186 100644 --- a/packages/core/saved-objects/docs/openapi/entrypoint.yaml +++ b/packages/core/saved-objects/docs/openapi/entrypoint.yaml @@ -10,7 +10,18 @@ info: url: https://www.elastic.co/licensing/elastic-license tags: - name: saved objects - description: Manage Kibana saved objects, including dashboards, visualizations, and more. + x-displayName: Saved objects + description: | + Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs. + + To manage a specific type of saved object, use the corresponding APIs. + For example, use: + + * [Data views](../group/endpoint-data-views) + * [Spaces](https://www.elastic.co/guide/en/kibana/current/spaces-api.html) + * [Short URLs](https://www.elastic.co/guide/en/kibana/current/short-urls-api.html) + + Warning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions. servers: - url: / paths: diff --git a/packages/core/saved-objects/docs/openapi/entrypoint_serverless.yaml b/packages/core/saved-objects/docs/openapi/entrypoint_serverless.yaml index ab3dcacf9a39d..69c742a8d7acd 100644 --- a/packages/core/saved-objects/docs/openapi/entrypoint_serverless.yaml +++ b/packages/core/saved-objects/docs/openapi/entrypoint_serverless.yaml @@ -10,7 +10,16 @@ info: url: https://www.elastic.co/licensing/elastic-license tags: - name: saved objects - description: Manage Kibana saved objects, including dashboards, visualizations, and more. + x-displayName: Saved objects + description: | + Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs. + + To manage a specific type of saved object, use the corresponding APIs. + For example, use: + + [Data views](../group/endpoint-data-views) + + Warning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions. servers: - url: 'https://{kibana_url}' variables: