From f2aad7b17ad44f0c51fe38defc46433d753cd0cf Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 10 Apr 2025 13:36:20 -0700 Subject: [PATCH] [DOCS] Use v8 API URLs in table.csv --- output/schema/schema.json | 42 ++++++++++++++++---------------- specification/_doc_ids/table.csv | 42 ++++++++++++++++---------------- 2 files changed, 42 insertions(+), 42 deletions(-) diff --git a/output/schema/schema.json b/output/schema/schema.json index f935ea29c1..3c44ec95ca 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -2400,7 +2400,7 @@ }, "description": "Clear cluster voting config exclusions.\nRemove master-eligible nodes from the voting configuration exclusion list.", "docId": "voting-config-exclusions", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-cluster-post-voting-config-exclusions", "extDocId": "add-nodes", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/add-elasticsearch-nodes.html", "name": "cluster.delete_voting_config_exclusions", @@ -2684,7 +2684,7 @@ }, "description": "Update voting configuration exclusions.\nUpdate the cluster voting config exclusions by node IDs or node names.\nBy default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks.\nIf you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually.\nThe API adds an entry for each specified node to the cluster’s voting configuration exclusions list.\nIt then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes.\n\nClusters should have no voting configuration exclusions in normal operation.\nOnce the excluded nodes have stopped, clear the voting configuration exclusions with `DELETE /_cluster/voting_config_exclusions`.\nThis API waits for the nodes to be fully removed from the cluster before it returns.\nIf your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use `DELETE /_cluster/voting_config_exclusions?wait_for_removal=false` to clear the voting configuration exclusions without waiting for the nodes to leave the cluster.\n\nA response to `POST /_cluster/voting_config_exclusions` with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling `DELETE /_cluster/voting_config_exclusions`.\nIf the call to `POST /_cluster/voting_config_exclusions` fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration.\nIn that case, you may safely retry the call.\n\nNOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period.\nThey are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes.", "docId": "voting-config-exclusions", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-cluster-post-voting-config-exclusions", "extDocId": "add-nodes", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/add-elasticsearch-nodes.html", "name": "cluster.post_voting_config_exclusions", @@ -11056,7 +11056,7 @@ }, "description": "Update the license.\n\nYou can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API.", "docId": "update-license", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-license-post", "name": "license.post", "privileges": { "cluster": [ @@ -14444,7 +14444,7 @@ "description": "Update a data frame analytics job.", "docId": "update-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-data-frame-analytics", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ml-update-data-frame-analytics", "name": "ml.update_data_frame_analytics", "privileges": { "cluster": [ @@ -14676,7 +14676,7 @@ "description": "Update a trained model deployment.", "docId": "update-trained-model-deployment", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-trained-model-deployment", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ml-update-trained-model-deployment", "name": "ml.update_trained_model_deployment", "privileges": { "cluster": [ @@ -22650,7 +22650,7 @@ }, "description": "Update a transform.\nUpdates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.", "docId": "update-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-update-transform", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-transform-update-transform", "name": "transform.update_transform", "privileges": { "cluster": [ @@ -22699,7 +22699,7 @@ }, "description": "Upgrade all transforms.\n\nTransforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.\nYou may want to perform a recent cluster backup prior to the upgrade.", "docId": "upgrade-transforms", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-upgrade-transforms", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-transform-upgrade-transforms", "name": "transform.upgrade_transforms", "privileges": { "cluster": [ @@ -22865,7 +22865,7 @@ }, "description": "Acknowledge a watch.\nAcknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).", "docId": "watcher-api-ack-watch", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-ack-watch", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-ack-watch", "name": "watcher.ack_watch", "privileges": { "cluster": [ @@ -22909,7 +22909,7 @@ }, "description": "Activate a watch.\nA watch can be either active or inactive.", "docId": "watcher-api-activate-watch", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-activate-watch", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-activate-watch", "extDocId": "watcher-works", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/how-watcher-works.html", "name": "watcher.activate_watch", @@ -22948,7 +22948,7 @@ }, "description": "Deactivate a watch.\nA watch can be either active or inactive.", "docId": "watcher-api-deactivate-watch", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-deactivate-watch", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-deactivate-watch", "extDocId": "watcher-works", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/how-watcher-works.html", "name": "watcher.deactivate_watch", @@ -22987,7 +22987,7 @@ }, "description": "Delete a watch.\nWhen the watch is removed, the document representing the watch in the `.watches` index is gone and it will never be run again.\n\nDeleting a watch does not delete any watch execution records related to this watch from the watch history.\n\nIMPORTANT: Deleting a watch must be done by using only this API.\nDo not delete the watch directly from the `.watches` index using the Elasticsearch delete document API\nWhen Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the `.watches` index.", "docId": "watcher-api-delete-watch", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-delete-watch", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-delete-watch", "name": "watcher.delete_watch", "privileges": { "cluster": [ @@ -23023,7 +23023,7 @@ }, "description": "Run a watch.\nThis API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.\n\nFor testing and debugging purposes, you also have fine-grained control on how the watch runs.\nYou can run the watch without running all of its actions or alternatively by simulating them.\nYou can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs.\n\nYou can use the run watch API to run watches that are not yet registered by specifying the watch definition inline.\nThis serves as great tool for testing and debugging your watches prior to adding them to Watcher.\n\nWhen Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches.\nIf your user is allowed to read index `a`, but not index `b`, then the exact same set of rules will apply during execution of a watch.\n\nWhen using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch.", "docId": "watcher-api-execute-watch", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-execute-watch", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-execute-watch", "name": "watcher.execute_watch", "privileges": { "cluster": [ @@ -23071,7 +23071,7 @@ }, "description": "Get Watcher index settings.\nGet settings for the Watcher internal index (`.watches`).\nOnly a subset of settings are shown, for example `index.auto_expand_replicas` and `index.number_of_replicas`.", "docId": "watcher-api-get-settings", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-settings", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-get-settings", "name": "watcher.get_settings", "request": { "name": "Request", @@ -23106,7 +23106,7 @@ }, "description": "Get a watch.", "docId": "watcher-api-get-watch", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-watch", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-get-watch", "name": "watcher.get_watch", "privileges": { "cluster": [ @@ -23142,7 +23142,7 @@ }, "description": "Create or update a watch.\nWhen a watch is registered, a new document that represents the watch is added to the `.watches` index and its trigger is immediately registered with the relevant trigger engine.\nTypically for the `schedule` trigger, the scheduler is the trigger engine.\n\nIMPORTANT: You must use Kibana or this API to create a watch.\nDo not add a watch directly to the `.watches` index by using the Elasticsearch index API.\nIf Elasticsearch security features are enabled, do not give users write privileges on the `.watches` index.\n\nWhen you add a watch you can also define its initial active state by setting the *active* parameter.\n\nWhen Elasticsearch security features are enabled, your watch can index or search only on indices for which the user that stored the watch has privileges.\nIf the user is able to read index `a`, but not index `b`, the same will apply when the watch runs.", "docId": "watcher-api-put-watch", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-put-watch", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-put-watch", "name": "watcher.put_watch", "privileges": { "cluster": [ @@ -23183,7 +23183,7 @@ }, "description": "Query watches.\nGet all registered watches in a paginated manner and optionally filter watches by a query.\n\nNote that only the `_id` and `metadata.*` fields are queryable or sortable.", "docId": "watcher-api-query-watches", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-query-watches", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-query-watches", "name": "watcher.query_watches", "privileges": { "cluster": [ @@ -23223,7 +23223,7 @@ }, "description": "Start the watch service.\nStart the Watcher service if it is not already running.", "docId": "watcher-api-start", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-start", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-start", "name": "watcher.start", "privileges": { "cluster": [ @@ -23260,7 +23260,7 @@ }, "description": "Get Watcher statistics.\nThis API always returns basic metrics.\nYou retrieve more metrics by using the metric parameter.", "docId": "watcher-api-stats", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-stats", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-stats", "name": "watcher.stats", "privileges": { "cluster": [ @@ -23302,7 +23302,7 @@ }, "description": "Stop the watch service.\nStop the Watcher service if it is running.", "docId": "watcher-api-stop", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-stop", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-stop", "name": "watcher.stop", "privileges": { "cluster": [ @@ -23339,7 +23339,7 @@ }, "description": "Update Watcher index settings.\nUpdate settings for the Watcher internal index (`.watches`).\nOnly a subset of settings can be modified.\nThis includes `index.auto_expand_replicas`, `index.number_of_replicas`, `index.routing.allocation.exclude.*`,\n`index.routing.allocation.include.*` and `index.routing.allocation.require.*`.\nModification of `index.routing.allocation.include._tier_preference` is an exception and is not allowed as the\nWatcher shards must always be in the `data_content` tier.", "docId": "watcher-api-update-settings", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-update-settings", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-update-settings", "name": "watcher.update_settings", "privileges": { "cluster": [ @@ -23422,7 +23422,7 @@ }, "description": "Get usage information.\nGet information about the features that are currently enabled and available under the current license.\nThe API also provides some usage statistics.", "docId": "usage-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-xpack", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-xpack", "name": "xpack.usage", "privileges": { "cluster": [ diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 3355ae9ce4..6f070d622f 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -860,35 +860,35 @@ time-value,https://github.com/elastic/elasticsearch/blob/{branch}/libs/core/src/ time-zone-id,https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html trim-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/trim-processor.html unfreeze-index-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/unfreeze-index-api.html -update-dfanalytics,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-data-frame-analytics -update-desired-nodes,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cluster -update-license,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post -update-trained-model-deployment,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-trained-model-deployment -update-transform,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-update-transform -upgrade-transforms,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-upgrade-transforms +update-dfanalytics,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ml-update-data-frame-analytics +update-desired-nodes,https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-cluster +update-license,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-license-post +update-trained-model-deployment,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ml-update-trained-model-deployment +update-transform,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-transform-update-transform +upgrade-transforms,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-transform-upgrade-transforms uppercase-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/uppercase-processor.html urldecode-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/urldecode-processor.html -usage-api,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-xpack +usage-api,https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-xpack user-agent-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/user-agent-processor.html user-profile,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/user-profile.html verify-repository,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-register-repository.html#snapshots-repository-verification -voting-config-exclusions,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions +voting-config-exclusions,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-cluster-post-voting-config-exclusions voyageai-embeddings,https://docs.voyageai.com/docs/embeddings voyageai-rerank,https://docs.voyageai.com/docs/reranker watcher-works,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/how-watcher-works.html -watcher-api-ack-watch,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-ack-watch -watcher-api-activate-watch,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-activate-watch -watcher-api-deactivate-watch,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-deactivate-watch -watcher-api-delete-watch,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-delete-watch -watcher-api-execute-watch,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-execute-watch -watcher-api-get-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-settings -watcher-api-get-watch,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-watch -watcher-api-put-watch,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-put-watch -watcher-api-query-watches,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-query-watches -watcher-api-start,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-start -watcher-api-stats,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-stats -watcher-api-stop,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-stop -watcher-api-update-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-update-settings +watcher-api-ack-watch,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-ack-watch +watcher-api-activate-watch,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-activate-watch +watcher-api-deactivate-watch,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-deactivate-watch +watcher-api-delete-watch,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-delete-watch +watcher-api-execute-watch,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-execute-watch +watcher-api-get-settings,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-get-settings +watcher-api-get-watch,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-get-watch +watcher-api-put-watch,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-put-watch +watcher-api-query-watches,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-query-watches +watcher-api-start,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-start +watcher-api-stats,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-stats +watcher-api-stop,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-stop +watcher-api-update-settings,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-update-settings watsonx-api-keys,https://cloud.ibm.com/iam/apikeys watsonx-api-models,https://www.ibm.com/products/watsonx-ai/foundation-models watsonx-api-version,https://cloud.ibm.com/apidocs/watsonx-ai#active-version-dates