Skip to content

Commit

Permalink
[DOCS] Edit feature operation summaries (#3267) (#3279)
Browse files Browse the repository at this point in the history
(cherry picked from commit d56831b)

Co-authored-by: Lisa Cawley <[email protected]>
  • Loading branch information
github-actions[bot] and lcawl authored Dec 12, 2024
1 parent a45355f commit a4fe079
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 8 deletions.
9 changes: 7 additions & 2 deletions output/openapi/elasticsearch-openapi.json

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

14 changes: 8 additions & 6 deletions output/schema/schema.json

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

1 change: 1 addition & 0 deletions specification/_doc_ids/table.csv
Original file line number Diff line number Diff line change
Expand Up @@ -603,6 +603,7 @@ slm-api-get-status,https://www.elastic.co/guide/en/elasticsearch/reference/{bran
slm-api-put-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-put-policy.html
slm-api-start,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-start.html
slm-api-stop,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-stop.html
snapshot-create,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-take-snapshot.html
sort-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-processor.html
sort-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html
sort-tiebreaker,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html#eql-search-specify-a-sort-tiebreaker
Expand Down
11 changes: 11 additions & 0 deletions specification/features/get_features/GetFeaturesRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,18 @@
import { RequestBase } from '@_types/Base'

/**
* Get the features.
* Get a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot.
* You can use this API to determine which feature states to include when taking a snapshot.
* By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not.
*
* A feature state includes one or more system indices necessary for a given feature to function.
* In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together.
*
* The features listed by this API are a combination of built-in features and features defined by plugins.
* 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.
* @rest_spec_name features.get_features
* @availability stack since=7.12.0 stability=stable
* @ext_doc_id snapshot-create
*/
export interface Request extends RequestBase {}
17 changes: 17 additions & 0 deletions specification/features/reset_features/ResetFeaturesRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,23 @@
import { RequestBase } from '@_types/Base'

/**
* Reset the features.
* Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.
*
* WARNING: Intended for development and testing use only. Do not reset features on a production cluster.
*
* Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features.
* This deletes all state information stored in system indices.
*
* The response code is HTTP 200 if the state is successfully reset for all features.
* It is HTTP 500 if the reset operation failed for any feature.
*
* Note that select features might provide a way to reset particular system indices.
* Using this API resets all features, both those that are built-in and implemented as plugins.
*
* To list the features that will be affected, use the get features API.
*
* 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.
* @rest_spec_name features.reset_features
* @availability stack since=7.12.0 stability=experimental
* @availability serverless stability=experimental visibility=private
Expand Down

0 comments on commit a4fe079

Please sign in to comment.