Skip to content

Commit e9b7a1e

Browse files
lcawlgithub-actions[bot]
authored andcommitted
[DOCS] Edit usage and info API summaries (#3339)
(cherry picked from commit 742729d)
1 parent 06390eb commit e9b7a1e

File tree

5 files changed

+43
-28
lines changed

5 files changed

+43
-28
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 6 additions & 4 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: 12 additions & 14 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,20 @@ import { RequestBase } from '@_types/Base'
2121
import { Duration } from '@_types/Time'
2222

2323
/**
24-
* Upgrades all transforms.
25-
* This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It
26-
* also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not
27-
* affect the source and destination indices. The upgrade also does not affect the roles that transforms use when
28-
* Elasticsearch security features are enabled; the role used to read source data and write to the destination index
29-
* remains unchanged.
24+
* Upgrade all transforms.
25+
* Transforms are compatible across minor versions and between supported major versions.
26+
* However, over time, the format of transform configuration information may change.
27+
* This API identifies transforms that have a legacy configuration format and upgrades them to the latest version.
28+
* It also cleans up the internal data structures that store the transform state and checkpoints.
29+
* The upgrade does not affect the source and destination indices.
30+
* The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.
31+
*
32+
* If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.
33+
* Resolve the issue then re-run the process again.
34+
* A summary is returned when the upgrade is finished.
35+
*
36+
* To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.
37+
* You may want to perform a recent cluster backup prior to the upgrade.
3038
* @rest_spec_name transform.upgrade_transforms
3139
* @availability stack since=7.16.0 stability=stable
3240
* @availability serverless stability=stable visibility=private

specification/xpack/info/XPackInfoRequest.ts

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

2222
/**
23-
* Provides general information about the installed X-Pack features.
23+
* Get information.
24+
* The information provided by the API includes:
25+
*
26+
* * Build information including the build number and timestamp.
27+
* * License information about the currently installed license.
28+
* * Feature information for the features that are currently enabled and available under the current license.
2429
* @rest_spec_name xpack.info
2530
* @availability stack stability=stable
2631
* @availability serverless stability=stable visibility=private
27-
* @cluster_privileges monitor,manage
32+
* @cluster_privileges monitor
2833
*/
2934
export interface Request extends RequestBase {
3035
query_parameters: {

specification/xpack/usage/XPackUsageRequest.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,13 @@ import { RequestBase } from '@_types/Base'
2121
import { Duration } from '@_types/Time'
2222

2323
/**
24-
* This API provides information about which features are currently enabled and available under the current license and some usage statistics.
24+
* Get usage information.
25+
* Get information about the features that are currently enabled and available under the current license.
26+
* The API also provides some usage statistics.
2527
* @rest_spec_name xpack.usage
2628
* @availability stack stability=stable
2729
* @availability serverless stability=stable visibility=private
28-
* @cluster_privileges monitor,manage
30+
* @cluster_privileges monitor
2931
*/
3032
export interface Request extends RequestBase {
3133
query_parameters: {

0 commit comments

Comments
 (0)