Skip to content

Commit f75f5ba

Browse files
lcawlgithub-actions[bot]
authored andcommitted
[DOCS] Edit feature operation summaries (#3267)
(cherry picked from commit d56831b)
1 parent d961f5d commit f75f5ba

File tree

5 files changed

+44
-8
lines changed

5 files changed

+44
-8
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 7 additions & 2 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: 8 additions & 6 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: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -598,6 +598,7 @@ slm-api-get-status,https://www.elastic.co/guide/en/elasticsearch/reference/{bran
598598
slm-api-put-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-put-policy.html
599599
slm-api-start,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-start.html
600600
slm-api-stop,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-stop.html
601+
snapshot-create,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-take-snapshot.html
601602
sort-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-processor.html
602603
sort-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html
603604
sort-tiebreaker,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html#eql-search-specify-a-sort-tiebreaker

specification/features/get_features/GetFeaturesRequest.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,18 @@
2020
import { RequestBase } from '@_types/Base'
2121

2222
/**
23+
* Get the features.
24+
* Get a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot.
25+
* You can use this API to determine which feature states to include when taking a snapshot.
26+
* By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not.
27+
*
28+
* A feature state includes one or more system indices necessary for a given feature to function.
29+
* In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together.
30+
*
31+
* The features listed by this API are a combination of built-in features and features defined by plugins.
32+
* In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node.
2333
* @rest_spec_name features.get_features
2434
* @availability stack since=7.12.0 stability=stable
35+
* @ext_doc_id snapshot-create
2536
*/
2637
export interface Request extends RequestBase {}

specification/features/reset_features/ResetFeaturesRequest.ts

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,23 @@
2020
import { RequestBase } from '@_types/Base'
2121

2222
/**
23+
* Reset the features.
24+
* Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.
25+
*
26+
* WARNING: Intended for development and testing use only. Do not reset features on a production cluster.
27+
*
28+
* Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features.
29+
* This deletes all state information stored in system indices.
30+
*
31+
* The response code is HTTP 200 if the state is successfully reset for all features.
32+
* It is HTTP 500 if the reset operation failed for any feature.
33+
*
34+
* Note that select features might provide a way to reset particular system indices.
35+
* Using this API resets all features, both those that are built-in and implemented as plugins.
36+
*
37+
* To list the features that will be affected, use the get features API.
38+
*
39+
* IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.
2340
* @rest_spec_name features.reset_features
2441
* @availability stack since=7.12.0 stability=experimental
2542
* @availability serverless stability=experimental visibility=private

0 commit comments

Comments
 (0)