Skip to content

Commit 7508300

Browse files
[DOCS] Edit searchable snapshot summaries (#3312) (#3329)
(cherry picked from commit b1b8b2f) Co-authored-by: Lisa Cawley <[email protected]>
1 parent 67254e8 commit 7508300

File tree

6 files changed

+69
-19
lines changed

6 files changed

+69
-19
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 12 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 41 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/searchable_snapshots/cache_stats/Request.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,11 @@ import { NodeIds } from '@_types/common'
2222
import { Duration } from '@_types/Time'
2323

2424
/**
25+
* Get cache statistics.
26+
* Get statistics about the shared cache for partially mounted indices.
2527
* @rest_spec_name searchable_snapshots.cache_stats
2628
* @availability stack since=7.13.0 stability=experimental
29+
* @cluster_privileges manage
2730
*/
2831
export interface Request extends RequestBase {
2932
path_parts: {

specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,12 @@ import { RequestBase } from '@_types/Base'
2121
import { ExpandWildcards, Indices } from '@_types/common'
2222

2323
/**
24+
* Clear the cache.
25+
* Clear indices and data streams from the shared cache for partially mounted indices.
2426
* @rest_spec_name searchable_snapshots.clear_cache
2527
* @availability stack since=7.10.0 stability=experimental
28+
* @cluster_privileges manage
29+
* @index_privileges manage
2630
*/
2731
export interface Request extends RequestBase {
2832
path_parts: {

specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,14 @@ import { IndexName, Name } from '@_types/common'
2424
import { Duration } from '@_types/Time'
2525

2626
/**
27+
* Mount a snapshot.
28+
* Mount a snapshot as a searchable snapshot index.
29+
* Do not use this API for snapshots managed by index lifecycle management (ILM).
30+
* Manually mounting ILM-managed snapshots can interfere with ILM processes.
2731
* @rest_spec_name searchable_snapshots.mount
2832
* @availability stack since=7.10.0 stability=stable
33+
* @cluster_privileges manage
34+
* @index_privileges manage
2935
*/
3036
export interface Request extends RequestBase {
3137
path_parts: {

specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,11 @@ import { Indices } from '@_types/common'
2222
import { StatsLevel } from '../_types/stats'
2323

2424
/**
25+
* Get searchable snapshot statistics.
2526
* @rest_spec_name searchable_snapshots.stats
2627
* @availability stack since=7.10.0 stability=stable
28+
* @cluster_privileges manage
29+
* @index_privileges manage
2730
*/
2831
export interface Request extends RequestBase {
2932
path_parts: {

0 commit comments

Comments
 (0)