From f722add19ace7e8badebb64d28f8a05889694eac Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 9 Dec 2024 11:56:08 -0800 Subject: [PATCH 1/2] [DOCS] Edit CCR operation summaries --- specification/_doc_ids/table.csv | 2 ++ .../DeleteAutoFollowPatternRequest.ts | 3 +++ .../ccr/follow/CreateFollowIndexRequest.ts | 3 +++ specification/ccr/follow_info/FollowInfoRequest.ts | 4 ++++ .../ccr/follow_stats/FollowIndexStatsRequest.ts | 4 ++++ .../forget_follower/ForgetFollowerIndexRequest.ts | 13 +++++++++++++ .../GetAutoFollowPatternRequest.ts | 3 +++ .../PauseAutoFollowPatternRequest.ts | 9 +++++++++ .../ccr/pause_follow/PauseFollowIndexRequest.ts | 5 +++++ .../PutAutoFollowPatternRequest.ts | 8 ++++++++ .../ResumeAutoFollowPatternRequest.ts | 5 +++++ .../ccr/resume_follow/ResumeFollowIndexRequest.ts | 6 ++++++ specification/ccr/stats/CcrStatsRequest.ts | 2 ++ specification/ccr/unfollow/UnfollowIndexRequest.ts | 7 +++++++ 14 files changed, 74 insertions(+) diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 11cf6f19cd..e5215305e1 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -45,6 +45,8 @@ cat-thread-pool,https://www.elastic.co/guide/en/elasticsearch/reference/{branch} cat-trained-model,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-trained-model.html cat-transforms,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-transforms.html cat,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat.html +ccr,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-ccr.html +ccr-auto-follow,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-auto-follow.html ccr-delete-auto-follow-pattern,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-delete-auto-follow-pattern.html ccr-get-auto-follow-pattern,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-auto-follow-pattern.html ccr-get-follow-info,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-follow-info.html diff --git a/specification/ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts b/specification/ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts index bd62e134b4..1453c767bc 100644 --- a/specification/ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts +++ b/specification/ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts @@ -21,9 +21,12 @@ import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' /** + * Delete auto-follow patterns. + * Delete a collection of cross-cluster replication auto-follow patterns. * @rest_spec_name ccr.delete_auto_follow_pattern * @availability stack since=6.5.0 stability=stable * @doc_id ccr-delete-auto-follow-pattern + * @ext_doc_id ccr-auto-follow */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/ccr/follow/CreateFollowIndexRequest.ts b/specification/ccr/follow/CreateFollowIndexRequest.ts index 7d77c5d2ab..263774f597 100644 --- a/specification/ccr/follow/CreateFollowIndexRequest.ts +++ b/specification/ccr/follow/CreateFollowIndexRequest.ts @@ -24,6 +24,9 @@ import { integer, long } from '@_types/Numeric' import { Duration } from '@_types/Time' /** + * Create a follower. + * Create a cross-cluster replication follower index that follows a specific leader index. + * When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index. * @rest_spec_name ccr.follow * @availability stack since=6.5.0 stability=stable * @doc_id ccr-put-follow diff --git a/specification/ccr/follow_info/FollowInfoRequest.ts b/specification/ccr/follow_info/FollowInfoRequest.ts index 3a2aaf07d2..3ebca0f259 100644 --- a/specification/ccr/follow_info/FollowInfoRequest.ts +++ b/specification/ccr/follow_info/FollowInfoRequest.ts @@ -21,9 +21,13 @@ import { RequestBase } from '@_types/Base' import { Indices } from '@_types/common' /** + * Get follower information. + * Get information about all cross-cluster replication follower indices. + * For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. * @rest_spec_name ccr.follow_info * @availability stack since=6.7.0 stability=stable * @doc_id ccr-get-follow-info + * @ext_doc_id ccr */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/ccr/follow_stats/FollowIndexStatsRequest.ts b/specification/ccr/follow_stats/FollowIndexStatsRequest.ts index 2d9c4975ef..7009b5f220 100644 --- a/specification/ccr/follow_stats/FollowIndexStatsRequest.ts +++ b/specification/ccr/follow_stats/FollowIndexStatsRequest.ts @@ -21,9 +21,13 @@ import { RequestBase } from '@_types/Base' import { Indices } from '@_types/common' /** + * Get follower stats. + * Get cross-cluster replication follower stats. + * The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices. * @rest_spec_name ccr.follow_stats * @availability stack since=6.5.0 stability=stable * @doc_id ccr-get-follow-stats + * @ext_doc_id ccr */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts b/specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts index 13599c4f7f..2293381615 100644 --- a/specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts +++ b/specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts @@ -21,9 +21,22 @@ import { RequestBase } from '@_types/Base' import { IndexName, Uuid } from '@_types/common' /** + * Forget a follower. + * Remove the cross-cluster replication follower retention leases from the leader. + * + * A following index takes out retention leases on its leader index. + * These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + * When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + * However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + * While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + * This API exists to enable manually removing the leases when the unfollow API is unable to do so. + * + * NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + * The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. * @rest_spec_name ccr.forget_follower * @availability stack since=6.7.0 stability=stable * @doc_id ccr-post-forget-follower + * @ext_doc_id ccr */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts b/specification/ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts index 45a36a4794..433e27f425 100644 --- a/specification/ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts +++ b/specification/ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts @@ -21,9 +21,12 @@ import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' /** + * Get auto-follow patterns. + * Get cross-cluster replication auto-follow patterns. * @rest_spec_name ccr.get_auto_follow_pattern * @availability stack since=6.5.0 stability=stable * @doc_id ccr-get-auto-follow-pattern + * @ext_doc_id ccr-auto-follow */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts b/specification/ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts index d4e64a7a72..e670093d4a 100644 --- a/specification/ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts +++ b/specification/ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts @@ -21,9 +21,18 @@ import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' /** + * Pause an auto-follow pattern. + * Pause a cross-cluster replication auto-follow pattern. + * When the API returns, the auto-follow pattern is inactive. + * New indices that are created on the remote cluster and match the auto-follow patterns are ignored. + * + * You can resume auto-following with the resume auto-follow pattern API. + * When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. + * Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. * @rest_spec_name ccr.pause_auto_follow_pattern * @availability stack since=7.5.0 stability=stable * @doc_id ccr-pause-auto-follow-pattern + * @ext_doc_id ccr-auto-follow */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/ccr/pause_follow/PauseFollowIndexRequest.ts b/specification/ccr/pause_follow/PauseFollowIndexRequest.ts index 541c3cddfc..6a8e642959 100644 --- a/specification/ccr/pause_follow/PauseFollowIndexRequest.ts +++ b/specification/ccr/pause_follow/PauseFollowIndexRequest.ts @@ -21,6 +21,11 @@ import { RequestBase } from '@_types/Base' import { IndexName } from '@_types/common' /** + * Pause a follower. + * Pause a cross-cluster replication follower index. + * The follower index will not fetch any additional operations from the leader index. + * You can resume following with the resume follower API. + * You can pause and resume a follower index to change the configuration of the following task. * @rest_spec_name ccr.pause_follow * @availability stack since=6.5.0 stability=stable * @doc_id ccr-post-pause-follow diff --git a/specification/ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts b/specification/ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts index 25d25f7a74..d61bbf73be 100644 --- a/specification/ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts +++ b/specification/ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts @@ -25,9 +25,17 @@ import { integer } from '@_types/Numeric' import { Duration } from '@_types/Time' /** + * Create or update auto-follow patterns. + * Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. + * Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. + * Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. + * + * This API can also be used to update auto-follow patterns. + * NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns. * @rest_spec_name ccr.put_auto_follow_pattern * @availability stack since=6.5.0 stability=stable * @doc_id ccr-put-auto-follow-pattern + * @ext_doc_id ccr-auto-follow */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts b/specification/ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts index 52066cb809..2fb24358f1 100644 --- a/specification/ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts +++ b/specification/ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts @@ -21,9 +21,14 @@ import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' /** + * Resume an auto-follow pattern. + * Resume a cross-cluster replication auto-follow pattern that was paused. + * The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. + * Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. * @rest_spec_name ccr.resume_auto_follow_pattern * @availability stack since=7.5.0 stability=stable * @doc_id ccr-resume-auto-follow-pattern + * @ext_doc_id ccr-auto-follow */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/ccr/resume_follow/ResumeFollowIndexRequest.ts b/specification/ccr/resume_follow/ResumeFollowIndexRequest.ts index 5c11d8959a..adc86c0798 100644 --- a/specification/ccr/resume_follow/ResumeFollowIndexRequest.ts +++ b/specification/ccr/resume_follow/ResumeFollowIndexRequest.ts @@ -23,9 +23,15 @@ import { long } from '@_types/Numeric' import { Duration } from '@_types/Time' /** + * Resume a follower. + * Resume a cross-cluster replication follower index that was paused. + * The follower index could have been paused with the pause follower API. + * Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + * When this API returns, the follower index will resume fetching operations from the leader index. * @rest_spec_name ccr.resume_follow * @availability stack since=6.5.0 stability=stable * @doc_id ccr-post-resume-follow + * @ext_doc_id ccr */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/ccr/stats/CcrStatsRequest.ts b/specification/ccr/stats/CcrStatsRequest.ts index 891fe325c4..280205ff97 100644 --- a/specification/ccr/stats/CcrStatsRequest.ts +++ b/specification/ccr/stats/CcrStatsRequest.ts @@ -20,6 +20,8 @@ import { RequestBase } from '@_types/Base' /** + * Get cross-cluster replication stats. + * This API returns stats about auto-following and the same shard-level stats as the get follower stats API. * @rest_spec_name ccr.stats * @availability stack since=6.5.0 stability=stable * @doc_id ccr-get-stats diff --git a/specification/ccr/unfollow/UnfollowIndexRequest.ts b/specification/ccr/unfollow/UnfollowIndexRequest.ts index 7d083afd22..6913918463 100644 --- a/specification/ccr/unfollow/UnfollowIndexRequest.ts +++ b/specification/ccr/unfollow/UnfollowIndexRequest.ts @@ -21,9 +21,16 @@ import { RequestBase } from '@_types/Base' import { IndexName } from '@_types/common' /** + * Unfollow an index. + * Convert a cross-cluster replication follower index to a regular index. + * The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + * The follower index must be paused and closed before you call the unfollow API. + * + * NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. * @rest_spec_name ccr.unfollow * @availability stack since=6.5.0 stability=stable * @doc_id ccr-post-unfollow + * @ext_doc_id ccr */ export interface Request extends RequestBase { path_parts: { From 2fe6ef1f07575ea4fa8d29ab821db556d43ddef3 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 9 Dec 2024 11:58:53 -0800 Subject: [PATCH 2/2] Generate output --- output/openapi/elasticsearch-openapi.json | 79 +++++++++++++----- output/schema/schema.json | 98 ++++++++++++++--------- 2 files changed, 120 insertions(+), 57 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 90ab9893f6..359759c257 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -2184,8 +2184,11 @@ "tags": [ "ccr" ], - "summary": "Gets configured auto-follow patterns", - "description": "Returns the specified auto-follow pattern collection.", + "summary": "Get auto-follow patterns", + "description": "Get cross-cluster replication auto-follow patterns.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html" + }, "operationId": "ccr-get-auto-follow-pattern-1", "parameters": [ { @@ -2203,8 +2206,11 @@ "tags": [ "ccr" ], - "summary": "Creates a new named collection of auto-follow patterns against a specified remote cluster", - "description": "Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.", + "summary": "Create or update auto-follow patterns", + "description": "Create a collection of cross-cluster replication auto-follow patterns for a remote cluster.\nNewly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.\nIndices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.\n\nThis API can also be used to update auto-follow patterns.\nNOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html" + }, "operationId": "ccr-put-auto-follow-pattern", "parameters": [ { @@ -2307,7 +2313,11 @@ "tags": [ "ccr" ], - "summary": "Deletes auto-follow patterns", + "summary": "Delete auto-follow patterns", + "description": "Delete a collection of cross-cluster replication auto-follow patterns.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html" + }, "operationId": "ccr-delete-auto-follow-pattern", "parameters": [ { @@ -2342,7 +2352,8 @@ "tags": [ "ccr" ], - "summary": "Creates a new follower index configured to follow the referenced leader index", + "summary": "Create a follower", + "description": "Create a cross-cluster replication follower index that follows a specific leader index.\nWhen the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.", "operationId": "ccr-follow", "parameters": [ { @@ -2468,7 +2479,11 @@ "tags": [ "ccr" ], - "summary": "Retrieves information about all follower indices, including parameters and status for each follower index", + "summary": "Get follower information", + "description": "Get information about all cross-cluster replication follower indices.\nFor example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html" + }, "operationId": "ccr-follow-info", "parameters": [ { @@ -2514,7 +2529,11 @@ "tags": [ "ccr" ], - "summary": "Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices", + "summary": "Get follower stats", + "description": "Get cross-cluster replication follower stats.\nThe API returns shard-level stats about the \"following tasks\" associated with each shard for the specified indices.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html" + }, "operationId": "ccr-follow-stats", "parameters": [ { @@ -2560,7 +2579,11 @@ "tags": [ "ccr" ], - "summary": "Removes the follower retention leases from the leader", + "summary": "Forget a follower", + "description": "Remove the cross-cluster replication follower retention leases from the leader.\n\nA following index takes out retention leases on its leader index.\nThese leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication.\nWhen a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed.\nHowever, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable.\nWhile the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index.\nThis API exists to enable manually removing the leases when the unfollow API is unable to do so.\n\nNOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader.\nThe only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html" + }, "operationId": "ccr-forget-follower", "parameters": [ { @@ -2627,8 +2650,11 @@ "tags": [ "ccr" ], - "summary": "Gets configured auto-follow patterns", - "description": "Returns the specified auto-follow pattern collection.", + "summary": "Get auto-follow patterns", + "description": "Get cross-cluster replication auto-follow patterns.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html" + }, "operationId": "ccr-get-auto-follow-pattern", "responses": { "200": { @@ -2643,7 +2669,11 @@ "tags": [ "ccr" ], - "summary": "Pauses an auto-follow pattern", + "summary": "Pause an auto-follow pattern", + "description": "Pause a cross-cluster replication auto-follow pattern.\nWhen the API returns, the auto-follow pattern is inactive.\nNew indices that are created on the remote cluster and match the auto-follow patterns are ignored.\n\nYou can resume auto-following with the resume auto-follow pattern API.\nWhen it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.\nRemote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html" + }, "operationId": "ccr-pause-auto-follow-pattern", "parameters": [ { @@ -2678,8 +2708,8 @@ "tags": [ "ccr" ], - "summary": "Pauses a follower index", - "description": "The follower index will not fetch any additional operations from the leader index.", + "summary": "Pause a follower", + "description": "Pause a cross-cluster replication follower index.\nThe follower index will not fetch any additional operations from the leader index.\nYou can resume following with the resume follower API.\nYou can pause and resume a follower index to change the configuration of the following task.", "operationId": "ccr-pause-follow", "parameters": [ { @@ -2714,7 +2744,11 @@ "tags": [ "ccr" ], - "summary": "Resumes an auto-follow pattern that has been paused", + "summary": "Resume an auto-follow pattern", + "description": "Resume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html" + }, "operationId": "ccr-resume-auto-follow-pattern", "parameters": [ { @@ -2749,7 +2783,11 @@ "tags": [ "ccr" ], - "summary": "Resumes a follower index that has been paused", + "summary": "Resume a follower", + "description": "Resume a cross-cluster replication follower index that was paused.\nThe follower index could have been paused with the pause follower API.\nAlternatively it could be paused due to replication that cannot be retried due to failures during following tasks.\nWhen this API returns, the follower index will resume fetching operations from the leader index.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html" + }, "operationId": "ccr-resume-follow", "parameters": [ { @@ -2825,7 +2863,8 @@ "tags": [ "ccr" ], - "summary": "Gets all stats related to cross-cluster replication", + "summary": "Get cross-cluster replication stats", + "description": "This API returns stats about auto-following and the same shard-level stats as the get follower stats API.", "operationId": "ccr-stats", "responses": { "200": { @@ -2859,7 +2898,11 @@ "tags": [ "ccr" ], - "summary": "Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication", + "summary": "Unfollow an index", + "description": "Convert a cross-cluster replication follower index to a regular index.\nThe API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.\nThe follower index must be paused and closed before you call the unfollow API.\n\nNOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html" + }, "operationId": "ccr-unfollow", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index c9e74c01de..a8242a93b8 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -1718,9 +1718,11 @@ "stability": "stable" } }, - "description": "Deletes auto-follow patterns.", + "description": "Delete auto-follow patterns.\nDelete a collection of cross-cluster replication auto-follow patterns.", "docId": "ccr-delete-auto-follow-pattern", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-delete-auto-follow-pattern.html", + "extDocId": "ccr-auto-follow", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-auto-follow.html", "name": "ccr.delete_auto_follow_pattern", "request": { "name": "Request", @@ -1750,7 +1752,7 @@ "stability": "stable" } }, - "description": "Creates a new follower index configured to follow the referenced leader index.", + "description": "Create a follower.\nCreate a cross-cluster replication follower index that follows a specific leader index.\nWhen the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.", "docId": "ccr-put-follow", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-put-follow.html", "name": "ccr.follow", @@ -1785,9 +1787,11 @@ "stability": "stable" } }, - "description": "Retrieves information about all follower indices, including parameters and status for each follower index", + "description": "Get follower information.\nGet information about all cross-cluster replication follower indices.\nFor example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.", "docId": "ccr-get-follow-info", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-follow-info.html", + "extDocId": "ccr", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-ccr.html", "name": "ccr.follow_info", "request": { "name": "Request", @@ -1817,9 +1821,11 @@ "stability": "stable" } }, - "description": "Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.", + "description": "Get follower stats.\nGet cross-cluster replication follower stats.\nThe API returns shard-level stats about the \"following tasks\" associated with each shard for the specified indices.", "docId": "ccr-get-follow-stats", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-follow-stats.html", + "extDocId": "ccr", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-ccr.html", "name": "ccr.follow_stats", "request": { "name": "Request", @@ -1849,9 +1855,11 @@ "stability": "stable" } }, - "description": "Removes the follower retention leases from the leader.", + "description": "Forget a follower.\nRemove the cross-cluster replication follower retention leases from the leader.\n\nA following index takes out retention leases on its leader index.\nThese leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication.\nWhen a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed.\nHowever, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable.\nWhile the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index.\nThis API exists to enable manually removing the leases when the unfollow API is unable to do so.\n\nNOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader.\nThe only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.", "docId": "ccr-post-forget-follower", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-forget-follower.html", + "extDocId": "ccr", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-ccr.html", "name": "ccr.forget_follower", "request": { "name": "Request", @@ -1884,9 +1892,11 @@ "stability": "stable" } }, - "description": "Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.", + "description": "Get auto-follow patterns.\nGet cross-cluster replication auto-follow patterns.", "docId": "ccr-get-auto-follow-pattern", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-auto-follow-pattern.html", + "extDocId": "ccr-auto-follow", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-auto-follow.html", "name": "ccr.get_auto_follow_pattern", "request": { "name": "Request", @@ -1922,9 +1932,11 @@ "stability": "stable" } }, - "description": "Pauses an auto-follow pattern", + "description": "Pause an auto-follow pattern.\nPause a cross-cluster replication auto-follow pattern.\nWhen the API returns, the auto-follow pattern is inactive.\nNew indices that are created on the remote cluster and match the auto-follow patterns are ignored.\n\nYou can resume auto-following with the resume auto-follow pattern API.\nWhen it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.\nRemote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.", "docId": "ccr-pause-auto-follow-pattern", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-pause-auto-follow-pattern.html", + "extDocId": "ccr-auto-follow", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-auto-follow.html", "name": "ccr.pause_auto_follow_pattern", "request": { "name": "Request", @@ -1954,7 +1966,7 @@ "stability": "stable" } }, - "description": "Pauses a follower index. The follower index will not fetch any additional operations from the leader index.", + "description": "Pause a follower.\nPause a cross-cluster replication follower index.\nThe follower index will not fetch any additional operations from the leader index.\nYou can resume following with the resume follower API.\nYou can pause and resume a follower index to change the configuration of the following task.", "docId": "ccr-post-pause-follow", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-pause-follow.html", "name": "ccr.pause_follow", @@ -1986,9 +1998,11 @@ "stability": "stable" } }, - "description": "Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.", + "description": "Create or update auto-follow patterns.\nCreate a collection of cross-cluster replication auto-follow patterns for a remote cluster.\nNewly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.\nIndices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.\n\nThis API can also be used to update auto-follow patterns.\nNOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.", "docId": "ccr-put-auto-follow-pattern", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-put-auto-follow-pattern.html", + "extDocId": "ccr-auto-follow", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-auto-follow.html", "name": "ccr.put_auto_follow_pattern", "request": { "name": "Request", @@ -2021,9 +2035,11 @@ "stability": "stable" } }, - "description": "Resumes an auto-follow pattern that has been paused", + "description": "Resume an auto-follow pattern.\nResume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.", "docId": "ccr-resume-auto-follow-pattern", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-resume-auto-follow-pattern.html", + "extDocId": "ccr-auto-follow", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-auto-follow.html", "name": "ccr.resume_auto_follow_pattern", "request": { "name": "Request", @@ -2053,9 +2069,11 @@ "stability": "stable" } }, - "description": "Resumes a follower index that has been paused", + "description": "Resume a follower.\nResume a cross-cluster replication follower index that was paused.\nThe follower index could have been paused with the pause follower API.\nAlternatively it could be paused due to replication that cannot be retried due to failures during following tasks.\nWhen this API returns, the follower index will resume fetching operations from the leader index.", "docId": "ccr-post-resume-follow", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-resume-follow.html", + "extDocId": "ccr", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-ccr.html", "name": "ccr.resume_follow", "request": { "name": "Request", @@ -2088,7 +2106,7 @@ "stability": "stable" } }, - "description": "Gets all stats related to cross-cluster replication.", + "description": "Get cross-cluster replication stats.\nThis API returns stats about auto-following and the same shard-level stats as the get follower stats API.", "docId": "ccr-get-stats", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-stats.html", "name": "ccr.stats", @@ -2120,9 +2138,11 @@ "stability": "stable" } }, - "description": "Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.", + "description": "Unfollow an index.\nConvert a cross-cluster replication follower index to a regular index.\nThe API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.\nThe follower index must be paused and closed before you call the unfollow API.\n\nNOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.", "docId": "ccr-post-unfollow", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-unfollow.html", + "extDocId": "ccr", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-ccr.html", "name": "ccr.unfollow", "request": { "name": "Request", @@ -103412,7 +103432,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes auto-follow patterns.", + "description": "Delete auto-follow patterns.\nDelete a collection of cross-cluster replication auto-follow patterns.", "inherits": { "type": { "name": "RequestBase", @@ -103438,7 +103458,7 @@ } ], "query": [], - "specLocation": "ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts#L23-L32" + "specLocation": "ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts#L23-L35" }, { "kind": "response", @@ -103636,7 +103656,7 @@ } ] }, - "description": "Creates a new follower index configured to follow the referenced leader index.", + "description": "Create a follower.\nCreate a cross-cluster replication follower index that follows a specific leader index.\nWhen the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.", "inherits": { "type": { "name": "RequestBase", @@ -103675,7 +103695,7 @@ } } ], - "specLocation": "ccr/follow/CreateFollowIndexRequest.ts#L26-L110" + "specLocation": "ccr/follow/CreateFollowIndexRequest.ts#L26-L113" }, { "kind": "response", @@ -103942,7 +103962,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves information about all follower indices, including parameters and status for each follower index", + "description": "Get follower information.\nGet information about all cross-cluster replication follower indices.\nFor example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.", "inherits": { "type": { "name": "RequestBase", @@ -103968,7 +103988,7 @@ } ], "query": [], - "specLocation": "ccr/follow_info/FollowInfoRequest.ts#L23-L32" + "specLocation": "ccr/follow_info/FollowInfoRequest.ts#L23-L36" }, { "kind": "response", @@ -104005,7 +104025,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.", + "description": "Get follower stats.\nGet cross-cluster replication follower stats.\nThe API returns shard-level stats about the \"following tasks\" associated with each shard for the specified indices.", "inherits": { "type": { "name": "RequestBase", @@ -104031,7 +104051,7 @@ } ], "query": [], - "specLocation": "ccr/follow_stats/FollowIndexStatsRequest.ts#L23-L32" + "specLocation": "ccr/follow_stats/FollowIndexStatsRequest.ts#L23-L36" }, { "kind": "response", @@ -104114,7 +104134,7 @@ } ] }, - "description": "Removes the follower retention leases from the leader.", + "description": "Forget a follower.\nRemove the cross-cluster replication follower retention leases from the leader.\n\nA following index takes out retention leases on its leader index.\nThese leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication.\nWhen a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed.\nHowever, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable.\nWhile the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index.\nThis API exists to enable manually removing the leases when the unfollow API is unable to do so.\n\nNOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader.\nThe only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.", "inherits": { "type": { "name": "RequestBase", @@ -104140,7 +104160,7 @@ } ], "query": [], - "specLocation": "ccr/forget_follower/ForgetFollowerIndexRequest.ts#L23-L38" + "specLocation": "ccr/forget_follower/ForgetFollowerIndexRequest.ts#L23-L51" }, { "kind": "response", @@ -104293,7 +104313,7 @@ "body": { "kind": "no_body" }, - "description": "Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.", + "description": "Get auto-follow patterns.\nGet cross-cluster replication auto-follow patterns.", "inherits": { "type": { "name": "RequestBase", @@ -104319,7 +104339,7 @@ } ], "query": [], - "specLocation": "ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts#L23-L33" + "specLocation": "ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts#L23-L36" }, { "kind": "response", @@ -104356,7 +104376,7 @@ "body": { "kind": "no_body" }, - "description": "Pauses an auto-follow pattern", + "description": "Pause an auto-follow pattern.\nPause a cross-cluster replication auto-follow pattern.\nWhen the API returns, the auto-follow pattern is inactive.\nNew indices that are created on the remote cluster and match the auto-follow patterns are ignored.\n\nYou can resume auto-following with the resume auto-follow pattern API.\nWhen it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.\nRemote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.", "inherits": { "type": { "name": "RequestBase", @@ -104382,7 +104402,7 @@ } ], "query": [], - "specLocation": "ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts#L23-L32" + "specLocation": "ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts#L23-L41" }, { "kind": "response", @@ -104410,7 +104430,7 @@ "body": { "kind": "no_body" }, - "description": "Pauses a follower index. The follower index will not fetch any additional operations from the leader index.", + "description": "Pause a follower.\nPause a cross-cluster replication follower index.\nThe follower index will not fetch any additional operations from the leader index.\nYou can resume following with the resume follower API.\nYou can pause and resume a follower index to change the configuration of the following task.", "inherits": { "type": { "name": "RequestBase", @@ -104436,7 +104456,7 @@ } ], "query": [], - "specLocation": "ccr/pause_follow/PauseFollowIndexRequest.ts#L23-L32" + "specLocation": "ccr/pause_follow/PauseFollowIndexRequest.ts#L23-L37" }, { "kind": "response", @@ -104665,7 +104685,7 @@ } ] }, - "description": "Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.", + "description": "Create or update auto-follow patterns.\nCreate a collection of cross-cluster replication auto-follow patterns for a remote cluster.\nNewly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.\nIndices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.\n\nThis API can also be used to update auto-follow patterns.\nNOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.", "inherits": { "type": { "name": "RequestBase", @@ -104691,7 +104711,7 @@ } ], "query": [], - "specLocation": "ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts#L27-L112" + "specLocation": "ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts#L27-L120" }, { "kind": "response", @@ -104719,7 +104739,7 @@ "body": { "kind": "no_body" }, - "description": "Resumes an auto-follow pattern that has been paused", + "description": "Resume an auto-follow pattern.\nResume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.", "inherits": { "type": { "name": "RequestBase", @@ -104745,7 +104765,7 @@ } ], "query": [], - "specLocation": "ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts#L23-L32" + "specLocation": "ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts#L23-L37" }, { "kind": "response", @@ -104885,7 +104905,7 @@ } ] }, - "description": "Resumes a follower index that has been paused", + "description": "Resume a follower.\nResume a cross-cluster replication follower index that was paused.\nThe follower index could have been paused with the pause follower API.\nAlternatively it could be paused due to replication that cannot be retried due to failures during following tasks.\nWhen this API returns, the follower index will resume fetching operations from the leader index.", "inherits": { "type": { "name": "RequestBase", @@ -104911,7 +104931,7 @@ } ], "query": [], - "specLocation": "ccr/resume_follow/ResumeFollowIndexRequest.ts#L25-L46" + "specLocation": "ccr/resume_follow/ResumeFollowIndexRequest.ts#L25-L52" }, { "kind": "response", @@ -105086,7 +105106,7 @@ "body": { "kind": "no_body" }, - "description": "Gets all stats related to cross-cluster replication.", + "description": "Get cross-cluster replication stats.\nThis API returns stats about auto-following and the same shard-level stats as the get follower stats API.", "inherits": { "type": { "name": "RequestBase", @@ -105099,7 +105119,7 @@ }, "path": [], "query": [], - "specLocation": "ccr/stats/CcrStatsRequest.ts#L22-L27" + "specLocation": "ccr/stats/CcrStatsRequest.ts#L22-L29" }, { "kind": "response", @@ -105144,7 +105164,7 @@ "body": { "kind": "no_body" }, - "description": "Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.", + "description": "Unfollow an index.\nConvert a cross-cluster replication follower index to a regular index.\nThe API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.\nThe follower index must be paused and closed before you call the unfollow API.\n\nNOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.", "inherits": { "type": { "name": "RequestBase", @@ -105170,7 +105190,7 @@ } ], "query": [], - "specLocation": "ccr/unfollow/UnfollowIndexRequest.ts#L23-L32" + "specLocation": "ccr/unfollow/UnfollowIndexRequest.ts#L23-L39" }, { "kind": "response",