Skip to content
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

[DOCS] Edit searchable snapshot summaries #3312

Merged
merged 2 commits into from
Dec 17, 2024
Merged

[DOCS] Edit searchable snapshot summaries #3312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d54204c
[DOCS] Edit searchable snapshot summaries
lcawl Dec 16, 2024
93c769d
Generate output
lcawl Dec 16, 2024
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
19 changes: 12 additions & 7 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.

53 changes: 41 additions & 12 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.

3 changes: 3 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 @@ -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: {
Expand Down
4 changes: 4 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 @@ -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
6 changes: 6 additions & 0 deletions specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts
View file
Open in desktop
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
3 changes: 3 additions & 0 deletions specification/searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts
View file
Open in desktop
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
Loading