diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 22d0a0dd3f..c1084b7bcb 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -11481,7 +11481,8 @@ "tags": [ "indices.get_alias" ], - "summary": "Retrieves information for one or more aliases", + "summary": "Get aliases", + "description": "Retrieves information for one or more data stream or index aliases.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -11516,7 +11517,8 @@ "tags": [ "indices.put_alias" ], - "summary": "Adds a data stream or index to an alias", + "summary": "Create or update an alias", + "description": "Adds a data stream or index to an alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -11548,7 +11550,8 @@ "tags": [ "indices.put_alias" ], - "summary": "Adds a data stream or index to an alias", + "summary": "Create or update an alias", + "description": "Adds a data stream or index to an alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -11609,7 +11612,8 @@ "tags": [ "indices.exists_alias" ], - "summary": "Checks if an alias exists", + "summary": "Check aliases", + "description": "Checks if one or more data stream or index aliases exist.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -11646,7 +11650,8 @@ "tags": [ "indices.put_alias" ], - "summary": "Adds a data stream or index to an alias", + "summary": "Create or update an alias", + "description": "Adds a data stream or index to an alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -11678,7 +11683,8 @@ "tags": [ "indices.put_alias" ], - "summary": "Adds a data stream or index to an alias", + "summary": "Create or update an alias", + "description": "Adds a data stream or index to an alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -12534,7 +12540,8 @@ "tags": [ "indices.get_alias" ], - "summary": "Retrieves information for one or more aliases", + "summary": "Get aliases", + "description": "Retrieves information for one or more data stream or index aliases.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -12566,7 +12573,8 @@ "tags": [ "indices.exists_alias" ], - "summary": "Checks if an alias exists", + "summary": "Check aliases", + "description": "Checks if one or more data stream or index aliases exist.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -12600,7 +12608,8 @@ "tags": [ "indices.explain_data_lifecycle" ], - "summary": "Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc", + "summary": "Get the status for a data stream lifecycle", + "description": "Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html" }, @@ -13001,7 +13010,8 @@ "tags": [ "indices.get_alias" ], - "summary": "Retrieves information for one or more aliases", + "summary": "Get aliases", + "description": "Retrieves information for one or more data stream or index aliases.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -13032,7 +13042,8 @@ "tags": [ "indices.get_alias" ], - "summary": "Retrieves information for one or more aliases", + "summary": "Get aliases", + "description": "Retrieves information for one or more data stream or index aliases.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -13362,8 +13373,8 @@ "tags": [ "indices.get_settings" ], - "summary": "Returns setting information for one or more indices", - "description": "For data streams,\nreturns setting information for the stream’s backing indices.", + "summary": "Get index settings", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, @@ -13401,8 +13412,8 @@ "tags": [ "indices.put_settings" ], - "summary": "Changes a dynamic index setting in real time", - "description": "For data streams, index setting\nchanges are applied to all backing indices by default.", + "summary": "Update index settings", + "description": "Changes dynamic index settings in real time. For data streams, index setting\nchanges are applied to all backing indices by default.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html" }, @@ -13445,8 +13456,8 @@ "tags": [ "indices.get_settings" ], - "summary": "Returns setting information for one or more indices", - "description": "For data streams,\nreturns setting information for the stream’s backing indices.", + "summary": "Get index settings", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, @@ -13487,8 +13498,8 @@ "tags": [ "indices.put_settings" ], - "summary": "Changes a dynamic index setting in real time", - "description": "For data streams, index setting\nchanges are applied to all backing indices by default.", + "summary": "Update index settings", + "description": "Changes dynamic index settings in real time. For data streams, index setting\nchanges are applied to all backing indices by default.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html" }, @@ -13534,8 +13545,8 @@ "tags": [ "indices.get_settings" ], - "summary": "Returns setting information for one or more indices", - "description": "For data streams,\nreturns setting information for the stream’s backing indices.", + "summary": "Get index settings", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, @@ -13581,8 +13592,8 @@ "tags": [ "indices.get_settings" ], - "summary": "Returns setting information for one or more indices", - "description": "For data streams,\nreturns setting information for the stream’s backing indices.", + "summary": "Get index settings", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, @@ -13944,8 +13955,8 @@ "tags": [ "indices.refresh" ], - "summary": "A refresh makes recent operations performed on one or more indices available for search", - "description": "For data streams, the API runs the refresh operation on the stream’s backing indices.", + "summary": "Refresh an index", + "description": "A refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, @@ -13971,8 +13982,8 @@ "tags": [ "indices.refresh" ], - "summary": "A refresh makes recent operations performed on one or more indices available for search", - "description": "For data streams, the API runs the refresh operation on the stream’s backing indices.", + "summary": "Refresh an index", + "description": "A refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, @@ -14000,8 +14011,8 @@ "tags": [ "indices.refresh" ], - "summary": "A refresh makes recent operations performed on one or more indices available for search", - "description": "For data streams, the API runs the refresh operation on the stream’s backing indices.", + "summary": "Refresh an index", + "description": "A refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, @@ -14030,8 +14041,8 @@ "tags": [ "indices.refresh" ], - "summary": "A refresh makes recent operations performed on one or more indices available for search", - "description": "For data streams, the API runs the refresh operation on the stream’s backing indices.", + "summary": "Refresh an index", + "description": "A refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, @@ -14280,7 +14291,8 @@ "tags": [ "indices.rollover" ], - "summary": "Creates a new index for a data stream or index alias", + "summary": "Roll over to a new index", + "description": "Creates a new index for a data stream or index alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html" }, @@ -14318,7 +14330,8 @@ "tags": [ "indices.rollover" ], - "summary": "Creates a new index for a data stream or index alias", + "summary": "Roll over to a new index", + "description": "Creates a new index for a data stream or index alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html" }, @@ -15095,7 +15108,8 @@ "tags": [ "indices.update_aliases" ], - "summary": "Adds a data stream or index to an alias", + "summary": "Create or update an alias", + "description": "Adds a data stream or index to an alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -16166,8 +16180,8 @@ "tags": [ "license.get" ], - "summary": "This API returns information about the type of license, when it was issued, and when it expires, for example", - "description": "For more information about the different types of licenses, see https://www.elastic.co/subscriptions.", + "summary": "Get license information", + "description": "Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.\nFor more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html" }, @@ -25491,8 +25505,8 @@ "tags": [ "reindex" ], - "summary": "Allows to copy documents from one index to another, optionally filtering the source\n", - "description": "documents by a query, changing the destination index settings, or fetching the\ndocuments from a remote cluster.", + "summary": "Reindex documents", + "description": "Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html" }, diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 14f42a0381..6ae0d12d12 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -6877,7 +6877,8 @@ "tags": [ "indices.get_alias" ], - "summary": "Retrieves information for one or more aliases", + "summary": "Get aliases", + "description": "Retrieves information for one or more data stream or index aliases.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -6912,7 +6913,8 @@ "tags": [ "indices.put_alias" ], - "summary": "Adds a data stream or index to an alias", + "summary": "Create or update an alias", + "description": "Adds a data stream or index to an alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -6944,7 +6946,8 @@ "tags": [ "indices.put_alias" ], - "summary": "Adds a data stream or index to an alias", + "summary": "Create or update an alias", + "description": "Adds a data stream or index to an alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -7005,7 +7008,8 @@ "tags": [ "indices.exists_alias" ], - "summary": "Checks if an alias exists", + "summary": "Check aliases", + "description": "Checks if one or more data stream or index aliases exist.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -7042,7 +7046,8 @@ "tags": [ "indices.put_alias" ], - "summary": "Adds a data stream or index to an alias", + "summary": "Create or update an alias", + "description": "Adds a data stream or index to an alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -7074,7 +7079,8 @@ "tags": [ "indices.put_alias" ], - "summary": "Adds a data stream or index to an alias", + "summary": "Create or update an alias", + "description": "Adds a data stream or index to an alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -7560,7 +7566,8 @@ "tags": [ "indices.get_alias" ], - "summary": "Retrieves information for one or more aliases", + "summary": "Get aliases", + "description": "Retrieves information for one or more data stream or index aliases.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -7592,7 +7599,8 @@ "tags": [ "indices.exists_alias" ], - "summary": "Checks if an alias exists", + "summary": "Check aliases", + "description": "Checks if one or more data stream or index aliases exist.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -7626,7 +7634,8 @@ "tags": [ "indices.explain_data_lifecycle" ], - "summary": "Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc", + "summary": "Get the status for a data stream lifecycle", + "description": "Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html" }, @@ -7695,7 +7704,8 @@ "tags": [ "indices.get_alias" ], - "summary": "Retrieves information for one or more aliases", + "summary": "Get aliases", + "description": "Retrieves information for one or more data stream or index aliases.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -7726,7 +7736,8 @@ "tags": [ "indices.get_alias" ], - "summary": "Retrieves information for one or more aliases", + "summary": "Get aliases", + "description": "Retrieves information for one or more data stream or index aliases.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -7977,8 +7988,8 @@ "tags": [ "indices.get_settings" ], - "summary": "Returns setting information for one or more indices", - "description": "For data streams,\nreturns setting information for the stream’s backing indices.", + "summary": "Get index settings", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, @@ -8016,8 +8027,8 @@ "tags": [ "indices.put_settings" ], - "summary": "Changes a dynamic index setting in real time", - "description": "For data streams, index setting\nchanges are applied to all backing indices by default.", + "summary": "Update index settings", + "description": "Changes dynamic index settings in real time. For data streams, index setting\nchanges are applied to all backing indices by default.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html" }, @@ -8060,8 +8071,8 @@ "tags": [ "indices.get_settings" ], - "summary": "Returns setting information for one or more indices", - "description": "For data streams,\nreturns setting information for the stream’s backing indices.", + "summary": "Get index settings", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, @@ -8102,8 +8113,8 @@ "tags": [ "indices.put_settings" ], - "summary": "Changes a dynamic index setting in real time", - "description": "For data streams, index setting\nchanges are applied to all backing indices by default.", + "summary": "Update index settings", + "description": "Changes dynamic index settings in real time. For data streams, index setting\nchanges are applied to all backing indices by default.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html" }, @@ -8149,8 +8160,8 @@ "tags": [ "indices.get_settings" ], - "summary": "Returns setting information for one or more indices", - "description": "For data streams,\nreturns setting information for the stream’s backing indices.", + "summary": "Get index settings", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, @@ -8196,8 +8207,8 @@ "tags": [ "indices.get_settings" ], - "summary": "Returns setting information for one or more indices", - "description": "For data streams,\nreturns setting information for the stream’s backing indices.", + "summary": "Get index settings", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, @@ -8401,8 +8412,8 @@ "tags": [ "indices.refresh" ], - "summary": "A refresh makes recent operations performed on one or more indices available for search", - "description": "For data streams, the API runs the refresh operation on the stream’s backing indices.", + "summary": "Refresh an index", + "description": "A refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, @@ -8428,8 +8439,8 @@ "tags": [ "indices.refresh" ], - "summary": "A refresh makes recent operations performed on one or more indices available for search", - "description": "For data streams, the API runs the refresh operation on the stream’s backing indices.", + "summary": "Refresh an index", + "description": "A refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, @@ -8457,8 +8468,8 @@ "tags": [ "indices.refresh" ], - "summary": "A refresh makes recent operations performed on one or more indices available for search", - "description": "For data streams, the API runs the refresh operation on the stream’s backing indices.", + "summary": "Refresh an index", + "description": "A refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, @@ -8487,8 +8498,8 @@ "tags": [ "indices.refresh" ], - "summary": "A refresh makes recent operations performed on one or more indices available for search", - "description": "For data streams, the API runs the refresh operation on the stream’s backing indices.", + "summary": "Refresh an index", + "description": "A refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, @@ -8593,7 +8604,8 @@ "tags": [ "indices.rollover" ], - "summary": "Creates a new index for a data stream or index alias", + "summary": "Roll over to a new index", + "description": "Creates a new index for a data stream or index alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html" }, @@ -8631,7 +8643,8 @@ "tags": [ "indices.rollover" ], - "summary": "Creates a new index for a data stream or index alias", + "summary": "Roll over to a new index", + "description": "Creates a new index for a data stream or index alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html" }, @@ -8812,7 +8825,8 @@ "tags": [ "indices.update_aliases" ], - "summary": "Adds a data stream or index to an alias", + "summary": "Create or update an alias", + "description": "Adds a data stream or index to an alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html" }, @@ -9782,8 +9796,8 @@ "tags": [ "license.get" ], - "summary": "This API returns information about the type of license, when it was issued, and when it expires, for example", - "description": "For more information about the different types of licenses, see https://www.elastic.co/subscriptions.", + "summary": "Get license information", + "description": "Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.\nFor more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html" }, @@ -15910,8 +15924,8 @@ "tags": [ "reindex" ], - "summary": "Allows to copy documents from one index to another, optionally filtering the source\n", - "description": "documents by a query, changing the destination index settings, or fetching the\ndocuments from a remote cluster.", + "summary": "Reindex documents", + "description": "Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html" }, diff --git a/output/schema/schema.json b/output/schema/schema.json index 205d473f7d..8d7da9b92b 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -6566,7 +6566,7 @@ "stability": "stable" } }, - "description": "Checks if an alias exists.", + "description": "Check aliases.\nChecks if one or more data stream or index aliases exist.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.exists_alias", "request": { @@ -6671,7 +6671,7 @@ "stability": "stable" } }, - "description": "Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.", + "description": "Get the status for a data stream lifecycle.\nRetrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html", "name": "indices.explain_data_lifecycle", "request": { @@ -6869,7 +6869,7 @@ "stability": "stable" } }, - "description": "Retrieves information for one or more aliases.", + "description": "Get aliases.\nRetrieves information for one or more data stream or index aliases.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.get_alias", "request": { @@ -7125,7 +7125,7 @@ "stability": "stable" } }, - "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", + "description": "Get index settings.\nReturns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html", "name": "indices.get_settings", "privileges": { @@ -7363,7 +7363,7 @@ "stability": "stable" } }, - "description": "Adds a data stream or index to an alias.", + "description": "Create or update an alias.\nAdds a data stream or index to an alias.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.put_alias", "request": { @@ -7520,7 +7520,7 @@ "stability": "stable" } }, - "description": "Changes a dynamic index setting in real time. For data streams, index setting\nchanges are applied to all backing indices by default.", + "description": "Update index settings.\nChanges dynamic index settings in real time. For data streams, index setting\nchanges are applied to all backing indices by default.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html", "name": "indices.put_settings", "privileges": { @@ -7646,7 +7646,7 @@ "stability": "stable" } }, - "description": "A refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", + "description": "Refresh an index.\nA refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html", "name": "indices.refresh", "request": { @@ -7787,7 +7787,7 @@ "stability": "stable" } }, - "description": "Creates a new index for a data stream or index alias.", + "description": "Roll over to a new index.\nCreates a new index for a data stream or index alias.", "docId": "indices-rollover-index", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-rollover-index.html", "name": "indices.rollover", @@ -8161,7 +8161,7 @@ "stability": "stable" } }, - "description": "Adds a data stream or index to an alias.", + "description": "Create or update an alias.\nAdds a data stream or index to an alias.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.update_aliases", "request": { @@ -8841,7 +8841,7 @@ "stability": "stable" } }, - "description": "This API returns information about the type of license, when it was issued, and when it expires, for example.\nFor more information about the different types of licenses, see https://www.elastic.co/subscriptions.", + "description": "Get license information.\nReturns information about your Elastic license, including its type, its status, when it was issued, and when it expires.\nFor more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html", "name": "license.get", "request": { @@ -13633,7 +13633,7 @@ "stability": "stable" } }, - "description": "Allows to copy documents from one index to another, optionally filtering the source\ndocuments by a query, changing the destination index settings, or fetching the\ndocuments from a remote cluster.", + "description": "Reindex documents.\nCopies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", "name": "reindex", "request": { @@ -30179,7 +30179,7 @@ } ] }, - "description": "Allows to copy documents from one index to another, optionally filtering the source\ndocuments by a query, changing the destination index settings, or fetching the\ndocuments from a remote cluster.", + "description": "Reindex documents.\nCopies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.", "inherits": { "type": { "name": "RequestBase", @@ -30297,7 +30297,7 @@ } } ], - "specLocation": "_global/reindex/ReindexRequest.ts#L27-L101" + "specLocation": "_global/reindex/ReindexRequest.ts#L27-L103" }, { "body": { @@ -124216,7 +124216,7 @@ "body": { "kind": "no_body" }, - "description": "Checks if an alias exists.", + "description": "Check aliases.\nChecks if one or more data stream or index aliases exist.", "inherits": { "type": { "name": "RequestBase", @@ -124308,7 +124308,7 @@ } } ], - "specLocation": "indices/exists_alias/IndicesExistsAliasRequest.ts#L23-L67" + "specLocation": "indices/exists_alias/IndicesExistsAliasRequest.ts#L23-L68" }, { "body": { @@ -124600,7 +124600,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.", + "description": "Get the status for a data stream lifecycle.\nRetrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.", "inherits": { "type": { "name": "RequestBase", @@ -124652,7 +124652,7 @@ } } ], - "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts#L24-L38" + "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts#L24-L39" }, { "body": { @@ -125750,7 +125750,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves information for one or more aliases.", + "description": "Get aliases.\nRetrieves information for one or more data stream or index aliases.", "inherits": { "type": { "name": "RequestBase", @@ -125842,7 +125842,7 @@ } } ], - "specLocation": "indices/get_alias/IndicesGetAliasRequest.ts#L23-L70" + "specLocation": "indices/get_alias/IndicesGetAliasRequest.ts#L23-L71" }, { "body": { @@ -126625,7 +126625,7 @@ "body": { "kind": "no_body" }, - "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", + "description": "Get index settings.\nReturns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "inherits": { "type": { "name": "RequestBase", @@ -126756,7 +126756,7 @@ } } ], - "specLocation": "indices/get_settings/IndicesGetSettingsRequest.ts#L24-L91" + "specLocation": "indices/get_settings/IndicesGetSettingsRequest.ts#L24-L92" }, { "body": { @@ -127346,7 +127346,7 @@ } ] }, - "description": "Adds a data stream or index to an alias.", + "description": "Create or update an alias.\nAdds a data stream or index to an alias.", "inherits": { "type": { "name": "RequestBase", @@ -127414,7 +127414,7 @@ } } ], - "specLocation": "indices/put_alias/IndicesPutAliasRequest.ts#L25-L91" + "specLocation": "indices/put_alias/IndicesPutAliasRequest.ts#L25-L92" }, { "body": { @@ -128188,7 +128188,7 @@ } } }, - "description": "Changes a dynamic index setting in real time. For data streams, index setting\nchanges are applied to all backing indices by default.", + "description": "Update index settings.\nChanges dynamic index settings in real time. For data streams, index setting\nchanges are applied to all backing indices by default.", "inherits": { "type": { "name": "RequestBase", @@ -128307,7 +128307,7 @@ } } ], - "specLocation": "indices/put_settings/IndicesPutSettingsRequest.ts#L25-L92" + "specLocation": "indices/put_settings/IndicesPutSettingsRequest.ts#L25-L93" }, { "body": { @@ -129594,7 +129594,7 @@ "body": { "kind": "no_body" }, - "description": "A refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", + "description": "Refresh an index.\nA refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", "inherits": { "type": { "name": "RequestBase", @@ -129661,7 +129661,7 @@ } } ], - "specLocation": "indices/refresh/IndicesRefreshRequest.ts#L23-L60" + "specLocation": "indices/refresh/IndicesRefreshRequest.ts#L23-L61" }, { "body": { @@ -130357,7 +130357,7 @@ } ] }, - "description": "Creates a new index for a data stream or index alias.", + "description": "Roll over to a new index.\nCreates a new index for a data stream or index alias.", "inherits": { "type": { "name": "RequestBase", @@ -130449,7 +130449,7 @@ } } ], - "specLocation": "indices/rollover/IndicesRolloverRequest.ts#L29-L99" + "specLocation": "indices/rollover/IndicesRolloverRequest.ts#L29-L100" }, { "body": { @@ -134372,7 +134372,7 @@ } ] }, - "description": "Adds a data stream or index to an alias.", + "description": "Create or update an alias.\nAdds a data stream or index to an alias.", "inherits": { "type": { "name": "RequestBase", @@ -134413,7 +134413,7 @@ } } ], - "specLocation": "indices/update_aliases/IndicesUpdateAliasesRequest.ts#L24-L51" + "specLocation": "indices/update_aliases/IndicesUpdateAliasesRequest.ts#L24-L52" }, { "body": { @@ -140419,7 +140419,7 @@ "body": { "kind": "no_body" }, - "description": "This API returns information about the type of license, when it was issued, and when it expires, for example.\nFor more information about the different types of licenses, see https://www.elastic.co/subscriptions.", + "description": "Get license information.\nReturns information about your Elastic license, including its type, its status, when it was issued, and when it expires.\nFor more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).", "inherits": { "type": { "name": "RequestBase", @@ -140464,7 +140464,7 @@ } } ], - "specLocation": "license/get/GetLicenseRequest.ts#L22-L44" + "specLocation": "license/get/GetLicenseRequest.ts#L22-L45" }, { "body": { diff --git a/specification/_global/reindex/ReindexRequest.ts b/specification/_global/reindex/ReindexRequest.ts index ba86c39f2c..1e90c2845c 100644 --- a/specification/_global/reindex/ReindexRequest.ts +++ b/specification/_global/reindex/ReindexRequest.ts @@ -25,6 +25,8 @@ import { Duration } from '@_types/Time' import { Destination, Source } from './types' /** + * Reindex documents. + * Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. * @rest_spec_name reindex * @availability stack since=2.3.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/indices/exists_alias/IndicesExistsAliasRequest.ts b/specification/indices/exists_alias/IndicesExistsAliasRequest.ts index 6310f0a69d..4af9d5897c 100644 --- a/specification/indices/exists_alias/IndicesExistsAliasRequest.ts +++ b/specification/indices/exists_alias/IndicesExistsAliasRequest.ts @@ -21,7 +21,8 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, Indices, Names } from '@_types/common' /** - * Checks if an alias exists. + * Check aliases. + * Checks if one or more data stream or index aliases exist. * @rest_spec_name indices.exists_alias * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts b/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts index 3e39cf8924..afb8dd1f8b 100644 --- a/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts +++ b/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts @@ -22,7 +22,8 @@ import { Indices } from '@_types/common' import { Duration } from '@_types/Time' /** - * Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc. + * Get the status for a data stream lifecycle. + * Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. * @rest_spec_name indices.explain_data_lifecycle * @availability stack since=8.11.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/indices/get_alias/IndicesGetAliasRequest.ts b/specification/indices/get_alias/IndicesGetAliasRequest.ts index 8a43d2fc66..d8aed94949 100644 --- a/specification/indices/get_alias/IndicesGetAliasRequest.ts +++ b/specification/indices/get_alias/IndicesGetAliasRequest.ts @@ -21,7 +21,8 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, Indices, Names } from '@_types/common' /** - * Retrieves information for one or more aliases. + * Get aliases. + * Retrieves information for one or more data stream or index aliases. * @rest_spec_name indices.get_alias * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/indices/get_settings/IndicesGetSettingsRequest.ts b/specification/indices/get_settings/IndicesGetSettingsRequest.ts index dd4344e791..711694cb5a 100644 --- a/specification/indices/get_settings/IndicesGetSettingsRequest.ts +++ b/specification/indices/get_settings/IndicesGetSettingsRequest.ts @@ -22,6 +22,7 @@ import { ExpandWildcards, Indices, Names } from '@_types/common' import { Duration } from '@_types/Time' /** + * Get index settings. * Returns setting information for one or more indices. For data streams, * returns setting information for the stream’s backing indices. * @rest_spec_name indices.get_settings diff --git a/specification/indices/put_alias/IndicesPutAliasRequest.ts b/specification/indices/put_alias/IndicesPutAliasRequest.ts index 04b7729651..014a5d5ec0 100644 --- a/specification/indices/put_alias/IndicesPutAliasRequest.ts +++ b/specification/indices/put_alias/IndicesPutAliasRequest.ts @@ -23,6 +23,7 @@ import { QueryContainer } from '@_types/query_dsl/abstractions' import { Duration } from '@_types/Time' /** + * Create or update an alias. * Adds a data stream or index to an alias. * @rest_spec_name indices.put_alias * @availability stack stability=stable diff --git a/specification/indices/put_settings/IndicesPutSettingsRequest.ts b/specification/indices/put_settings/IndicesPutSettingsRequest.ts index d11ac1b9e2..9fda3c46d2 100644 --- a/specification/indices/put_settings/IndicesPutSettingsRequest.ts +++ b/specification/indices/put_settings/IndicesPutSettingsRequest.ts @@ -23,7 +23,8 @@ import { ExpandWildcards, Indices } from '@_types/common' import { Duration } from '@_types/Time' /** - * Changes a dynamic index setting in real time. For data streams, index setting + * Update index settings. + * Changes dynamic index settings in real time. For data streams, index setting * changes are applied to all backing indices by default. * @rest_spec_name indices.put_settings * @availability stack stability=stable diff --git a/specification/indices/refresh/IndicesRefreshRequest.ts b/specification/indices/refresh/IndicesRefreshRequest.ts index e8394e054d..0b1586293b 100644 --- a/specification/indices/refresh/IndicesRefreshRequest.ts +++ b/specification/indices/refresh/IndicesRefreshRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, Indices } from '@_types/common' /** + * Refresh an index. * A refresh makes recent operations performed on one or more indices available for search. * For data streams, the API runs the refresh operation on the stream’s backing indices. * @rest_spec_name indices.refresh diff --git a/specification/indices/rollover/IndicesRolloverRequest.ts b/specification/indices/rollover/IndicesRolloverRequest.ts index 6f74c1d7a9..afd79b6cb8 100644 --- a/specification/indices/rollover/IndicesRolloverRequest.ts +++ b/specification/indices/rollover/IndicesRolloverRequest.ts @@ -27,6 +27,7 @@ import { Duration } from '@_types/Time' import { RolloverConditions } from './types' /** + * Roll over to a new index. * Creates a new index for a data stream or index alias. * @doc_id indices-rollover-index * @rest_spec_name indices.rollover diff --git a/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts b/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts index db3c7737fc..491578ef7c 100644 --- a/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts +++ b/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' import { Action } from './types' /** + * Create or update an alias. * Adds a data stream or index to an alias. * @rest_spec_name indices.update_aliases * @availability stack since=1.3.0 stability=stable diff --git a/specification/license/get/GetLicenseRequest.ts b/specification/license/get/GetLicenseRequest.ts index b4d301f2c5..4010183869 100644 --- a/specification/license/get/GetLicenseRequest.ts +++ b/specification/license/get/GetLicenseRequest.ts @@ -20,8 +20,9 @@ import { RequestBase } from '@_types/Base' /** - * This API returns information about the type of license, when it was issued, and when it expires, for example. - * For more information about the different types of licenses, see https://www.elastic.co/subscriptions. + * Get license information. + * Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. + * For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). * @rest_spec_name license.get * @availability stack stability=stable * @availability serverless stability=stable visibility=public