Skip to content

[8.x] Add search snapshot API examples (#3459) #3480

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 8, 2025
Merged

[8.x] Add search snapshot API examples (#3459) #3480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 22 additions & 8 deletions output/openapi/elasticsearch-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

46 changes: 29 additions & 17 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions specification/_doc_ids/table.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,7 +589,11 @@ search-template,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}
search-terms-enum,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-terms-enum.html
search-validate,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-validate.html
search-vector-tile-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-vector-tile-api.html
searchable-snapshots,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots.html
searchable-snapshots-api-cache-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-api-cache-stats.html
searchable-snapshots-api-clear-cache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-api-clear-cache.html
searchable-snapshots-api-mount-snapshot,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-api-mount-snapshot.html
searchable-snapshots-api-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-api-stats.html
searchable-snapshots-apis,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-apis.html
search-templates,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-template.html
secure-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/secure-settings.html
Expand Down
5 changes: 5 additions & 0 deletions specification/searchable_snapshots/cache_stats/Request.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,14 @@ import { Duration } from '@_types/Time'
* @rest_spec_name searchable_snapshots.cache_stats
* @availability stack since=7.13.0 stability=experimental
* @cluster_privileges manage
* @doc_id searchable-snapshots-api-cache-stats
* @ext_doc_id searchable-snapshots
*/
export interface Request extends RequestBase {
path_parts: {
/**
* The names of the nodes in the cluster to target.
*/
node_id?: NodeIds
}
query_parameters: {
Expand Down
21 changes: 21 additions & 0 deletions specification/searchable_snapshots/cache_stats/examples/response/ResponseExample1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# summary:
description: A successful response from `GET /_searchable_snapshots/cache/stats`.
# type: response
# response_code: 200
value: |-
{
"nodes" : {
"eerrtBMtQEisohZzxBLUSw" : {
"shared_cache" : {
"reads" : 6051,
"bytes_read_in_bytes" : 5448829,
"writes" : 37,
"bytes_written_in_bytes" : 1208320,
"evictions" : 5,
"num_regions" : 65536,
"size_in_bytes" : 1099511627776,
"region_size_in_bytes" : 16777216
}
}
}
}
6 changes: 6 additions & 0 deletions specification/searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,15 @@ import { ExpandWildcards, Indices } from '@_types/common'
* @availability stack since=7.10.0 stability=experimental
* @cluster_privileges manage
* @index_privileges manage
* @doc_id searchable-snapshots-api-clear-cache
* @ext_doc_id searchable-snapshots
*/
export interface Request extends RequestBase {
path_parts: {
/**
* A comma-separated list of data streams, indices, and aliases to clear from the cache.
* It supports wildcards (`*`).
*/
index?: Indices
}
query_parameters: {
Expand Down
Loading
Loading