[DOCS] Edit searchable snapshot summaries (#3312)

(cherry picked from commit b1b8b2f)
elastic · Dec 17, 2024 · 106d23e · 106d23e
1 parent 67254e8
commit 106d23e
Show file tree

Hide file tree

Showing 6 changed files with 69 additions and 19 deletions.
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git 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
@@ -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
@@ -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
@@ -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: {