From caa16bce67ceee9e56fe3fede19bf069bfd261e9 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 16 Dec 2024 19:51:21 -0800 Subject: [PATCH 1/3] [DOCS] Edit info and usage APIs --- specification/xpack/info/XPackInfoRequest.ts | 9 +++++++-- specification/xpack/usage/XPackUsageRequest.ts | 6 ++++-- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/specification/xpack/info/XPackInfoRequest.ts b/specification/xpack/info/XPackInfoRequest.ts index 1261113b5b..9221e3b97a 100644 --- a/specification/xpack/info/XPackInfoRequest.ts +++ b/specification/xpack/info/XPackInfoRequest.ts @@ -20,11 +20,16 @@ import { RequestBase } from '@_types/Base' /** - * Provides general information about the installed X-Pack features. + * Get information. + * The information provided by the API includes: + * + * * Build information including the build number and timestamp. + * * License information about the currently installed license. + * * Feature information for the features that are currently enabled and available under the current license. * @rest_spec_name xpack.info * @availability stack stability=stable * @availability serverless stability=stable visibility=private - * @cluster_privileges monitor,manage + * @cluster_privileges monitor */ export interface Request extends RequestBase { query_parameters: { diff --git a/specification/xpack/usage/XPackUsageRequest.ts b/specification/xpack/usage/XPackUsageRequest.ts index ec6e58c6ef..e515f43526 100644 --- a/specification/xpack/usage/XPackUsageRequest.ts +++ b/specification/xpack/usage/XPackUsageRequest.ts @@ -21,11 +21,13 @@ import { RequestBase } from '@_types/Base' import { Duration } from '@_types/Time' /** - * This API provides information about which features are currently enabled and available under the current license and some usage statistics. + * Get usage information. + * Get information about the features that are currently enabled and available under the current license. + * The API also provides some usage statistics. * @rest_spec_name xpack.usage * @availability stack stability=stable * @availability serverless stability=stable visibility=private - * @cluster_privileges monitor,manage + * @cluster_privileges monitor */ export interface Request extends RequestBase { query_parameters: { From e2eb9afbe5f6256d6e632dfd96765d42032f77f5 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 16 Dec 2024 19:53:00 -0800 Subject: [PATCH 2/3] Generate output --- output/openapi/elasticsearch-openapi.json | 6 ++++-- output/schema/schema.json | 20 +++++++++----------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 5dd6684516..96ec20e55c 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -36289,7 +36289,8 @@ "tags": [ "xpack" ], - "summary": "Provides general information about the installed X-Pack features", + "summary": "Get information", + "description": "The information provided by the API includes:\n\n* Build information including the build number and timestamp.\n* License information about the currently installed license.\n* Feature information for the features that are currently enabled and available under the current license.", "operationId": "xpack-info", "parameters": [ { @@ -36365,7 +36366,8 @@ "tags": [ "xpack" ], - "summary": "This API provides information about which features are currently enabled and available under the current license and some usage statistics", + "summary": "Get usage information", + "description": "Get information about the features that are currently enabled and available under the current license.\nThe API also provides some usage statistics.", "operationId": "xpack-usage", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 43f3e2115d..7a46a6f84d 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -20738,13 +20738,12 @@ "stability": "stable" } }, - "description": "Provides general information about the installed X-Pack features.", + "description": "Get information.\nThe information provided by the API includes:\n\n* Build information including the build number and timestamp.\n* License information about the currently installed license.\n* Feature information for the features that are currently enabled and available under the current license.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html", "name": "xpack.info", "privileges": { "cluster": [ - "monitor", - "manage" + "monitor" ] }, "request": { @@ -20778,13 +20777,12 @@ "stability": "stable" } }, - "description": "This API provides information about which features are currently enabled and available under the current license and some usage statistics.", + "description": "Get usage information.\nGet information about the features that are currently enabled and available under the current license.\nThe API also provides some usage statistics.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html", "name": "xpack.usage", "privileges": { "cluster": [ - "monitor", - "manage" + "monitor" ] }, "request": { @@ -218335,7 +218333,7 @@ "body": { "kind": "no_body" }, - "description": "Provides general information about the installed X-Pack features.", + "description": "Get information.\nThe information provided by the API includes:\n\n* Build information including the build number and timestamp.\n* License information about the currently installed license.\n* Feature information for the features that are currently enabled and available under the current license.", "inherits": { "type": { "name": "RequestBase", @@ -218389,7 +218387,7 @@ } } ], - "specLocation": "xpack/info/XPackInfoRequest.ts#L22-L42" + "specLocation": "xpack/info/XPackInfoRequest.ts#L22-L47" }, { "kind": "response", @@ -218465,7 +218463,7 @@ "name": "XPackCategory", "namespace": "xpack.info" }, - "specLocation": "xpack/info/XPackInfoRequest.ts#L44-L48" + "specLocation": "xpack/info/XPackInfoRequest.ts#L49-L53" }, { "kind": "interface", @@ -220637,7 +220635,7 @@ "body": { "kind": "no_body" }, - "description": "This API provides information about which features are currently enabled and available under the current license and some usage statistics.", + "description": "Get usage information.\nGet information about the features that are currently enabled and available under the current license.\nThe API also provides some usage statistics.", "inherits": { "type": { "name": "RequestBase", @@ -220664,7 +220662,7 @@ } } ], - "specLocation": "xpack/usage/XPackUsageRequest.ts#L23-L38" + "specLocation": "xpack/usage/XPackUsageRequest.ts#L23-L40" }, { "kind": "response", From 079066fb647363439129af7c9413105a72bb33d6 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 17 Dec 2024 11:57:29 -0800 Subject: [PATCH 3/3] Edit the upgrade transform API --- output/openapi/elasticsearch-openapi.json | 4 ++-- output/schema/schema.json | 6 +++--- .../UpgradeTransformsRequest.ts | 20 +++++++++++++------ 3 files changed, 19 insertions(+), 11 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 96ec20e55c..4333b9fc39 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -34989,8 +34989,8 @@ "tags": [ "transform" ], - "summary": "Upgrades all transforms", - "description": "This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It\nalso cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not\naffect the source and destination indices. The upgrade also does not affect the roles that transforms use when\nElasticsearch security features are enabled; the role used to read source data and write to the destination index\nremains unchanged.", + "summary": "Upgrade all transforms", + "description": "Transforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe 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.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo 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.\nYou may want to perform a recent cluster backup prior to the upgrade.", "operationId": "transform-upgrade-transforms", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 7a46a6f84d..cda97c03d7 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -20154,7 +20154,7 @@ "stability": "stable" } }, - "description": "Upgrades all transforms.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It\nalso cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not\naffect the source and destination indices. The upgrade also does not affect the roles that transforms use when\nElasticsearch security features are enabled; the role used to read source data and write to the destination index\nremains unchanged.", + "description": "Upgrade all transforms.\nTransforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe 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.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo 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.\nYou may want to perform a recent cluster backup prior to the upgrade.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html", "name": "transform.upgrade_transforms", "privileges": { @@ -211748,7 +211748,7 @@ "body": { "kind": "no_body" }, - "description": "Upgrades all transforms.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It\nalso cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not\naffect the source and destination indices. The upgrade also does not affect the roles that transforms use when\nElasticsearch security features are enabled; the role used to read source data and write to the destination index\nremains unchanged.", + "description": "Upgrade all transforms.\nTransforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe 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.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo 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.\nYou may want to perform a recent cluster backup prior to the upgrade.", "inherits": { "type": { "name": "RequestBase", @@ -211788,7 +211788,7 @@ } } ], - "specLocation": "transform/upgrade_transforms/UpgradeTransformsRequest.ts#L23-L49" + "specLocation": "transform/upgrade_transforms/UpgradeTransformsRequest.ts#L23-L57" }, { "kind": "response", diff --git a/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts b/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts index d4908da900..552dbc7f48 100644 --- a/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts +++ b/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts @@ -21,12 +21,20 @@ import { RequestBase } from '@_types/Base' import { Duration } from '@_types/Time' /** - * Upgrades all transforms. - * This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It - * also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not - * affect the source and destination indices. 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. + * Upgrade all transforms. + * Transforms are compatible across minor versions and between supported major versions. + * However, over time, the format of transform configuration information may change. + * This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. + * It also cleans up the internal data structures that store the transform state and checkpoints. + * The upgrade does not affect the source and destination indices. + * 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. + * + * If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. + * Resolve the issue then re-run the process again. + * A summary is returned when the upgrade is finished. + * + * 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. + * You may want to perform a recent cluster backup prior to the upgrade. * @rest_spec_name transform.upgrade_transforms * @availability stack since=7.16.0 stability=stable * @availability serverless stability=stable visibility=private