Skip to content

Commit

Permalink
[DOCS] Edit searchable snapshot summaries
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Dec 16, 2024
1 parent cdae60f commit d54204c
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 0 deletions.
3 changes: 3 additions & 0 deletions specification/searchable_snapshots/cache_stats/Request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @clsuter_privileges manage
*/
export interface Request extends RequestBase {
path_parts: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down

0 comments on commit d54204c

Please sign in to comment.