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.

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

[Backport 8.x] [OpenAPI] Edits dangling index APIs #3066

Merged
merged 3 commits into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 0 additions & 2 deletions docs/overlays/elasticsearch-shared-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,6 @@ actions:
x-displayName: Index
description: >
Index APIs enable you to manage individual indices, index settings, aliases, mappings, and index templates.
- name: dangling_indices
x-displayName: Index - Import dangling index
- name: ilm
x-displayName: Index lifecycle management
externalDocs:
Expand Down
23 changes: 13 additions & 10 deletions output/openapi/elasticsearch-openapi.json

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

29 changes: 16 additions & 13 deletions output/schema/schema.json

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

Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,25 @@ import { Uuid } from '@_types/common'
import { Duration } from '@_types/Time'

/**
* Delete a dangling index.
*
* If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.
* For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.
* @rest_spec_name dangling_indices.delete_dangling_index
* @availability stack since=7.9.0 stability=stable
* @doc_tag indices
*/
export interface Request extends RequestBase {
path_parts: {
/**
* The UUID of the index to delete. Use the get dangling indices API to find the UUID.
*/
index_uuid: Uuid
}
query_parameters: {
/**
* This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index.
*/
accept_data_loss: boolean
master_timeout?: Duration
timeout?: Duration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,26 @@ import { Uuid } from '@_types/common'
import { Duration } from '@_types/Time'

/**
* Import a dangling index.
*
* If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.
* For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.
* @rest_spec_name dangling_indices.import_dangling_index
* @availability stack since=7.9.0 stability=stable
* @doc_tag indices
*/
export interface Request extends RequestBase {
path_parts: {
/**
* The UUID of the index to import. Use the get dangling indices API to locate the UUID.
*/
index_uuid: Uuid
}
query_parameters: {
/**
* This parameter must be set to true to import a dangling index.
* Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster.
*/
accept_data_loss: boolean
master_timeout?: Duration
timeout?: Duration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,14 @@
import { RequestBase } from '@_types/Base'

/**
* Get the dangling indices.
*
* If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.
* For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.
*
* Use this API to list dangling indices, which you can then import or delete.
* @rest_spec_name dangling_indices.list_dangling_indices
* @availability stack since=7.9.0 stability=stable
* @doc_tag indices
*/
export interface Request extends RequestBase {}
Loading