From 3d7ec3cb5af851fc6c0eb32b8819c595ab3864af Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Mon, 16 Dec 2024 17:44:50 -0800 Subject: [PATCH] [DOCS] Edit searchable snapshot summaries (#3312) (cherry picked from commit b1b8b2fe8188b29a06f9e491e158f971f17356f4) --- output/openapi/elasticsearch-openapi.json | 19 ++++--- output/schema/schema.json | 53 ++++++++++++++----- .../cache_stats/Request.ts | 3 ++ .../SearchableSnapshotsClearCacheRequest.ts | 4 ++ .../mount/SearchableSnapshotsMountRequest.ts | 6 +++ .../stats/SearchableSnapshotsStatsRequest.ts | 3 ++ 6 files changed, 69 insertions(+), 19 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 86d89e524d..e06c003d51 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -27048,7 +27048,8 @@ "tags": [ "searchable_snapshots" ], - "summary": "Retrieve node-level cache statistics about searchable snapshots", + "summary": "Get cache statistics", + "description": "Get statistics about the shared cache for partially mounted indices.", "operationId": "searchable-snapshots-cache-stats", "parameters": [ { @@ -27068,7 +27069,8 @@ "tags": [ "searchable_snapshots" ], - "summary": "Retrieve node-level cache statistics about searchable snapshots", + "summary": "Get cache statistics", + "description": "Get statistics about the shared cache for partially mounted indices.", "operationId": "searchable-snapshots-cache-stats-1", "parameters": [ { @@ -27091,7 +27093,8 @@ "tags": [ "searchable_snapshots" ], - "summary": "Clear the cache of searchable snapshots", + "summary": "Clear the cache", + "description": "Clear indices and data streams from the shared cache for partially mounted indices.", "operationId": "searchable-snapshots-clear-cache", "parameters": [ { @@ -27123,7 +27126,8 @@ "tags": [ "searchable_snapshots" ], - "summary": "Clear the cache of searchable snapshots", + "summary": "Clear the cache", + "description": "Clear indices and data streams from the shared cache for partially mounted indices.", "operationId": "searchable-snapshots-clear-cache-1", "parameters": [ { @@ -27158,7 +27162,8 @@ "tags": [ "searchable_snapshots" ], - "summary": "Mount a snapshot as a searchable index", + "summary": "Mount a snapshot", + "description": "Mount a snapshot as a searchable snapshot index.\nDo not use this API for snapshots managed by index lifecycle management (ILM).\nManually mounting ILM-managed snapshots can interfere with ILM processes.", "operationId": "searchable-snapshots-mount", "parameters": [ { @@ -27275,7 +27280,7 @@ "tags": [ "searchable_snapshots" ], - "summary": "Retrieve shard-level statistics about searchable snapshots", + "summary": "Get searchable snapshot statistics", "operationId": "searchable-snapshots-stats", "parameters": [ { @@ -27295,7 +27300,7 @@ "tags": [ "searchable_snapshots" ], - "summary": "Retrieve shard-level statistics about searchable snapshots", + "summary": "Get searchable snapshot statistics", "operationId": "searchable-snapshots-stats-1", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 361f055ed1..49f802a879 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -15101,9 +15101,14 @@ "stability": "experimental" } }, - "description": "Retrieve node-level cache statistics about searchable snapshots.", + "description": "Get cache statistics.\nGet statistics about the shared cache for partially mounted indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", "name": "searchable_snapshots.cache_stats", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "searchable_snapshots.cache_stats" @@ -15138,9 +15143,17 @@ "stability": "experimental" } }, - "description": "Clear the cache of searchable snapshots.", + "description": "Clear the cache.\nClear indices and data streams from the shared cache for partially mounted indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", "name": "searchable_snapshots.clear_cache", + "privileges": { + "cluster": [ + "manage" + ], + "index": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "searchable_snapshots.clear_cache" @@ -15175,9 +15188,17 @@ "stability": "stable" } }, - "description": "Mount a snapshot as a searchable index.", + "description": "Mount a snapshot.\nMount a snapshot as a searchable snapshot index.\nDo not use this API for snapshots managed by index lifecycle management (ILM).\nManually mounting ILM-managed snapshots can interfere with ILM processes.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-api-mount-snapshot.html", "name": "searchable_snapshots.mount", + "privileges": { + "cluster": [ + "manage" + ], + "index": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "searchable_snapshots.mount" @@ -15209,9 +15230,17 @@ "stability": "stable" } }, - "description": "Retrieve shard-level statistics about searchable snapshots.", + "description": "Get searchable snapshot statistics.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", "name": "searchable_snapshots.stats", + "privileges": { + "cluster": [ + "manage" + ], + "index": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "searchable_snapshots.stats" @@ -187442,7 +187471,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieve node-level cache statistics about searchable snapshots.", + "description": "Get cache statistics.\nGet statistics about the shared cache for partially mounted indices.", "inherits": { "type": { "name": "RequestBase", @@ -187480,7 +187509,7 @@ } } ], - "specLocation": "searchable_snapshots/cache_stats/Request.ts#L24-L35" + "specLocation": "searchable_snapshots/cache_stats/Request.ts#L24-L38" }, { "kind": "response", @@ -187623,7 +187652,7 @@ "body": { "kind": "no_body" }, - "description": "Clear the cache of searchable snapshots.", + "description": "Clear the cache.\nClear indices and data streams from the shared cache for partially mounted indices.", "inherits": { "type": { "name": "RequestBase", @@ -187708,7 +187737,7 @@ } } ], - "specLocation": "searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts#L23-L38" + "specLocation": "searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts#L23-L42" }, { "kind": "response", @@ -187831,7 +187860,7 @@ } ] }, - "description": "Mount a snapshot as a searchable index.", + "description": "Mount a snapshot.\nMount a snapshot as a searchable snapshot index.\nDo not use this API for snapshots managed by index lifecycle management (ILM).\nManually mounting ILM-managed snapshots can interfere with ILM processes.", "inherits": { "type": { "name": "RequestBase", @@ -187909,7 +187938,7 @@ } } ], - "specLocation": "searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts#L26-L49" + "specLocation": "searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts#L26-L55" }, { "kind": "response", @@ -187943,7 +187972,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieve shard-level statistics about searchable snapshots.", + "description": "Get searchable snapshot statistics.", "inherits": { "type": { "name": "RequestBase", @@ -187982,7 +188011,7 @@ } } ], - "specLocation": "searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts#L24-L35" + "specLocation": "searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts#L24-L38" }, { "kind": "response", diff --git a/specification/searchable_snapshots/cache_stats/Request.ts b/specification/searchable_snapshots/cache_stats/Request.ts index 9d482258d9..7ef9bc1781 100644 --- a/specification/searchable_snapshots/cache_stats/Request.ts +++ b/specification/searchable_snapshots/cache_stats/Request.ts @@ -22,8 +22,11 @@ import { NodeIds } from '@_types/common' import { Duration } from '@_types/Time' /** + * Get cache statistics. + * Get statistics about the shared cache for partially mounted indices. * @rest_spec_name searchable_snapshots.cache_stats * @availability stack since=7.13.0 stability=experimental + * @cluster_privileges manage */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts b/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts index 13300556a9..5c50a67828 100644 --- a/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts +++ b/specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts @@ -21,8 +21,12 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, Indices } from '@_types/common' /** + * Clear the cache. + * Clear indices and data streams from the shared cache for partially mounted indices. * @rest_spec_name searchable_snapshots.clear_cache * @availability stack since=7.10.0 stability=experimental + * @cluster_privileges manage + * @index_privileges manage */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts b/specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts index 9455ee41d9..fcc880e756 100644 --- a/specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts +++ b/specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts @@ -24,8 +24,14 @@ import { IndexName, Name } from '@_types/common' import { Duration } from '@_types/Time' /** + * Mount a snapshot. + * Mount a snapshot as a searchable snapshot index. + * Do not use this API for snapshots managed by index lifecycle management (ILM). + * Manually mounting ILM-managed snapshots can interfere with ILM processes. * @rest_spec_name searchable_snapshots.mount * @availability stack since=7.10.0 stability=stable + * @cluster_privileges manage + * @index_privileges manage */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts b/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts index bdc4fdffa5..872a7c71c7 100644 --- a/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts +++ b/specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts @@ -22,8 +22,11 @@ import { Indices } from '@_types/common' import { StatsLevel } from '../_types/stats' /** + * Get searchable snapshot statistics. * @rest_spec_name searchable_snapshots.stats * @availability stack since=7.10.0 stability=stable + * @cluster_privileges manage + * @index_privileges manage */ export interface Request extends RequestBase { path_parts: {