diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 5cde7d74b5..d8f61bca5a 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -27032,7 +27032,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": [ { @@ -27052,7 +27053,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": [ { @@ -27075,7 +27077,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": [ { @@ -27107,7 +27110,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": [ { @@ -27142,7 +27146,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": [ { @@ -27259,7 +27264,7 @@ "tags": [ "searchable_snapshots" ], - "summary": "Retrieve shard-level statistics about searchable snapshots", + "summary": "Get searchable snapshot statistics", "operationId": "searchable-snapshots-stats", "parameters": [ { @@ -27279,7 +27284,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 98a42765be..3b46acd516 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -15114,9 +15114,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" @@ -15151,9 +15156,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" @@ -15188,9 +15201,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" @@ -15222,9 +15243,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" @@ -187513,7 +187542,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", @@ -187551,7 +187580,7 @@ } } ], - "specLocation": "searchable_snapshots/cache_stats/Request.ts#L24-L35" + "specLocation": "searchable_snapshots/cache_stats/Request.ts#L24-L38" }, { "kind": "response", @@ -187694,7 +187723,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", @@ -187779,7 +187808,7 @@ } } ], - "specLocation": "searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts#L23-L38" + "specLocation": "searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts#L23-L42" }, { "kind": "response", @@ -187902,7 +187931,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", @@ -187980,7 +188009,7 @@ } } ], - "specLocation": "searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts#L26-L49" + "specLocation": "searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts#L26-L55" }, { "kind": "response", @@ -188014,7 +188043,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieve shard-level statistics about searchable snapshots.", + "description": "Get searchable snapshot statistics.", "inherits": { "type": { "name": "RequestBase", @@ -188053,7 +188082,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: {