Skip to content

Commit 5cea09e

Browse files
authored
Add search snapshot API examples (#3459) (#3480)
(cherry picked from commit fd32ef0)
1 parent d986f8c commit 5cea09e

File tree

9 files changed

+134
-28
lines changed

9 files changed

+134
-28
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 22 additions & 8 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: 29 additions & 17 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_doc_ids/table.csv

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -589,7 +589,11 @@ search-template,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}
589589
search-terms-enum,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-terms-enum.html
590590
search-validate,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-validate.html
591591
search-vector-tile-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-vector-tile-api.html
592+
searchable-snapshots,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots.html
593+
searchable-snapshots-api-cache-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-api-cache-stats.html
594+
searchable-snapshots-api-clear-cache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-api-clear-cache.html
592595
searchable-snapshots-api-mount-snapshot,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-api-mount-snapshot.html
596+
searchable-snapshots-api-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-api-stats.html
593597
searchable-snapshots-apis,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-apis.html
594598
search-templates,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-template.html
595599
secure-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/secure-settings.html

specification/searchable_snapshots/cache_stats/Request.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,14 @@ import { Duration } from '@_types/Time'
2727
* @rest_spec_name searchable_snapshots.cache_stats
2828
* @availability stack since=7.13.0 stability=experimental
2929
* @cluster_privileges manage
30+
* @doc_id searchable-snapshots-api-cache-stats
31+
* @ext_doc_id searchable-snapshots
3032
*/
3133
export interface Request extends RequestBase {
3234
path_parts: {
35+
/**
36+
* The names of the nodes in the cluster to target.
37+
*/
3338
node_id?: NodeIds
3439
}
3540
query_parameters: {
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# summary:
2+
description: A successful response from `GET /_searchable_snapshots/cache/stats`.
3+
# type: response
4+
# response_code: 200
5+
value: |-
6+
{
7+
"nodes" : {
8+
"eerrtBMtQEisohZzxBLUSw" : {
9+
"shared_cache" : {
10+
"reads" : 6051,
11+
"bytes_read_in_bytes" : 5448829,
12+
"writes" : 37,
13+
"bytes_written_in_bytes" : 1208320,
14+
"evictions" : 5,
15+
"num_regions" : 65536,
16+
"size_in_bytes" : 1099511627776,
17+
"region_size_in_bytes" : 16777216
18+
}
19+
}
20+
}
21+
}

specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,15 @@ import { ExpandWildcards, Indices } from '@_types/common'
2727
* @availability stack since=7.10.0 stability=experimental
2828
* @cluster_privileges manage
2929
* @index_privileges manage
30+
* @doc_id searchable-snapshots-api-clear-cache
31+
* @ext_doc_id searchable-snapshots
3032
*/
3133
export interface Request extends RequestBase {
3234
path_parts: {
35+
/**
36+
* A comma-separated list of data streams, indices, and aliases to clear from the cache.
37+
* It supports wildcards (`*`).
38+
*/
3339
index?: Indices
3440
}
3541
query_parameters: {

0 commit comments

Comments
 (0)