Skip to content

Commit

Permalink
Deploying to gh-pages from @ 8cb29a4 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
dblock committed Nov 23, 2024
1 parent dcf1c55 commit 2a2eb49
Showing 1 changed file with 42 additions and 5 deletions.
47 changes: 42 additions & 5 deletions opensearch-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27560,7 +27560,7 @@ components:
type: object
properties:
ignore_unavailable:
description: If `true`, the request ignores data streams and indexes in `indices` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed.
description: If `true`, the request ignores data streams and indexes in `indexes` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed.
type: boolean
include_global_state:
description: If `true`, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indexes, such as Watches and task records (configurable with `feature_states`).
Expand Down Expand Up @@ -27601,30 +27601,67 @@ components:
schema:
type: object
properties:
feature_states:
type: array
items:
type: string
ignore_index_settings:
description: A comma-delimited list of index settings that you don't want to restore from a snapshot.
type: array
items:
type: string
ignore_unavailable:
type: boolean
description: How to handle data streams or indexes that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed. If `true`, the request ignores data streams and indexes in indexes that are missing or closed. Defaults to `false`.
include_aliases:
type: boolean
description: How to handle index aliases from the original snapshot. If `true`, index aliases from the original snapshot are restored. If `false`, aliases along with associated indexes are not restored. Defaults to `true`.
include_global_state:
type: boolean
description: Whether to restore the current cluster state. If `false`, the cluster state is not restored. If true, the current cluster state is restored. Defaults to `false`.
index_settings:
description: A comma-delimited list of settings to add or change in all restored indexes. Use this parameter to override index settings during snapshot restoration. For data streams, these index settings are applied to the restored backing indexes.
$ref: '#/components/schemas/indices._common___IndexSettings'
indices:
description: A comma-delimited list of data streams and indexes to restore from the snapshot. Multi-index syntax is supported. By default, a restore operation includes all data streams and indexes in the snapshot. If this argument is provided, the restore operation only includes the data streams and indexes that you specify.
$ref: '#/components/schemas/_common___Indices'
partial:
type: boolean
description: |-
How the restore operation will behave if indexes in the snapshot do not have all primary shards available.
If `false`, the entire restore operation fails if any indexes in the snapshot do not have all primary shards available.
If `true`, allows the restoration of a partial snapshot of indexes with unavailable shards. Only shards that were successfully included in the snapshot are restored. All missing shards are recreated as empty. By default, the entire restore operation fails if one or more indexes included in the snapshot do not have all primary shards available. To change this behavior, set `partial` to `true`.
Defaults to `false`.
rename_pattern:
type: string
description: |-
The pattern to apply to the restored data streams and indexes. Data streams and indexes matching the rename pattern will be renamed according to the `rename_replacement` setting.
The rename pattern is applied as defined by the regular expression that supports referencing the original text.
The request fails if two or more data streams or indexes are renamed into the same name.
If you rename a restored data stream, its backing indexes are also renamed. For example, if you rename the logs data stream to `recovered-logs`, the backing index `.ds-logs-1` is renamed to `.ds-recovered-logs-1`.
If you rename a restored stream, ensure an index template matches the new stream name. If there are no matching index template names, the stream cannot roll over and new backing indexes are not created.
rename_replacement:
type: string
description: The rename replacement string.
rename_alias_pattern:
x-version-added: '2.18'
type: string
description: |-
The pattern to apply to the restored aliases. Aliases matching the rename pattern will be renamed according to the `rename_alias_replacement` setting.
The rename pattern is applied as defined by the regular expression that supports referencing the original text.
If two or more aliases are renamed into the same name, these aliases will be merged into one.
rename_alias_replacement:
x-version-added: '2.18'
type: string
description: The rename replacement string for aliases.
source_remote_store_repository:
x-version-added: '2.10'
type: string
description: The name of the remote store repository of the source index being restored. If not provided, the Snapshot Restore API will use the repository that was registered when the snapshot was created.
storage_type:
x-version-added: '2.7'
type: string
description: |-
Where will be the authoritative store of the restored indexes' data.
A value of `local` indicates that all snapshot metadata and index data will be downloaded to local storage.
A value of `remote_snapshot` indicates that snapshot metadata will be downloaded to the cluster, but the remote repository will remain the authoritative store of the index data. Data will be downloaded and cached as necessary to service queries. At least one node in the cluster must be configured with the search role in order to restore a snapshot using the type `remote_snapshot`.
Defaults to `local`.
description: Details of what to restore
sql.close:
content:
Expand Down

0 comments on commit 2a2eb49

Please sign in to comment.