diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 00716de8d8..f4bd674a5a 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -511,294 +511,6 @@ ] } }, - "/_autoscaling/policy/{name}": { - "get": { - "tags": [ - "autoscaling" - ], - "summary": "Get an autoscaling policy", - "description": "NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", - "externalDocs": { - "url": "https://www.elastic.co/docs/deploy-manage/autoscaling", - "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-get-autoscaling-capacity.html" - }, - "operationId": "autoscaling-get-autoscaling-policy", - "parameters": [ - { - "in": "path", - "name": "name", - "description": "the name of the autoscaling policy", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Name" - }, - "style": "simple" - }, - { - "in": "query", - "name": "master_timeout", - "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Duration" - }, - "style": "form" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autoscaling._types.AutoscalingPolicy" - }, - "examples": { - "GetAutoscalingPolicyResponseExample1": { - "summary": "A successful response for retrieving an autoscaling policy.", - "description": "This may be a response to `GET /_autoscaling/policy/my_autoscaling_policy`.", - "value": "{\n \"roles\": ,\n \"deciders\": \n}" - } - } - } - } - } - }, - "x-state": "Generally available; Added in 7.11.0", - "x-metaTags": [ - { - "content": "Elasticsearch", - "name": "product_name" - } - ] - }, - "put": { - "tags": [ - "autoscaling" - ], - "summary": "Create or update an autoscaling policy", - "description": "NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", - "externalDocs": { - "url": "https://www.elastic.co/docs/deploy-manage/autoscaling", - "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-put-autoscaling-policy.html" - }, - "operationId": "autoscaling-put-autoscaling-policy", - "parameters": [ - { - "in": "path", - "name": "name", - "description": "the name of the autoscaling policy", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Name" - }, - "style": "simple" - }, - { - "in": "query", - "name": "master_timeout", - "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Duration" - }, - "style": "form" - }, - { - "in": "query", - "name": "timeout", - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Duration" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autoscaling._types.AutoscalingPolicy" - }, - "examples": { - "PutAutoscalingPolicyRequestExample1": { - "summary": "Creates or updates an autoscaling policy.", - "value": "{\n \"roles\": [],\n \"deciders\": {\n \"fixed\": {\n }\n }\n}" - }, - "PutAutoscalingPolicyRequestExample2": { - "summary": "Creates an autoscaling policy.", - "description": "The API method and path for this request: `PUT /_autoscaling/policy/my_autoscaling_policy`. It creates `my_autoscaling_policy` using the fixed autoscaling decider, applying to the set of nodes having (only) the `data_hot` role.", - "value": "{\n \"roles\" : [ \"data_hot\" ],\n \"deciders\": {\n \"fixed\": {\n }\n }\n}" - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types.AcknowledgedResponseBase" - }, - "examples": { - "PutAutoscalingPolicyResponseExample1": { - "summary": "A successful response when creating an autoscaling policy.", - "value": "{\n \"acknowledged\": true\n}" - } - } - } - } - } - }, - "x-state": "Generally available; Added in 7.11.0", - "x-metaTags": [ - { - "content": "Elasticsearch", - "name": "product_name" - } - ] - }, - "delete": { - "tags": [ - "autoscaling" - ], - "summary": "Delete an autoscaling policy", - "description": "NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", - "externalDocs": { - "url": "https://www.elastic.co/docs/deploy-manage/autoscaling", - "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-delete-autoscaling-policy.html" - }, - "operationId": "autoscaling-delete-autoscaling-policy", - "parameters": [ - { - "in": "path", - "name": "name", - "description": "the name of the autoscaling policy", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Name" - }, - "style": "simple" - }, - { - "in": "query", - "name": "master_timeout", - "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Duration" - }, - "style": "form" - }, - { - "in": "query", - "name": "timeout", - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Duration" - }, - "style": "form" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types.AcknowledgedResponseBase" - }, - "examples": { - "DeleteAutoscalingPolicyResponseExample1": { - "summary": "A successful response of deleting one or more autoscaling policy.", - "description": "This may be a response to either `DELETE /_autoscaling/policy/my_autoscaling_policy` or `DELETE /_autoscaling/policy/*`.\n", - "value": "{\n \"acknowledged\": true\n}" - } - } - } - } - } - }, - "x-state": "Generally available; Added in 7.11.0", - "x-metaTags": [ - { - "content": "Elasticsearch", - "name": "product_name" - } - ] - } - }, - "/_autoscaling/capacity": { - "get": { - "tags": [ - "autoscaling" - ], - "summary": "Get the autoscaling capacity", - "description": "NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nThis API gets the current autoscaling capacity based on the configured autoscaling policy.\nIt will return information to size the cluster appropriately to the current workload.\n\nThe `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy.\n\nThe operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information.\n\nThe response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required.\nThis information is provided for diagnosis only.\nDo not use this information to make autoscaling decisions.", - "externalDocs": { - "url": "https://www.elastic.co/docs/deploy-manage/autoscaling", - "x-previousVersionUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-get-autoscaling-capacity.html" - }, - "operationId": "autoscaling-get-autoscaling-capacity", - "parameters": [ - { - "in": "query", - "name": "master_timeout", - "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.Duration" - }, - "style": "form" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "policies": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingDeciders" - } - } - }, - "required": [ - "policies" - ] - }, - "examples": { - "GetAutoscalingCapacityResponseExample1": { - "summary": "A successful response for retrieving the current autoscaling capacity.", - "description": "This may be a response to `GET /_autoscaling/capacity`.", - "value": "{\n policies: {}\n}" - } - } - } - } - } - }, - "x-state": "Generally available; Added in 7.11.0", - "x-metaTags": [ - { - "content": "Elasticsearch", - "name": "product_name" - } - ] - } - }, "/_bulk": { "put": { "tags": [ @@ -45328,231 +45040,6 @@ ] } }, - "/_nodes/{node_id}/shutdown": { - "get": { - "tags": [ - "shutdown" - ], - "summary": "Get the shutdown status", - "description": "Get information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled.\nThe API returns status information for each part of the shut down process.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.\n\n## Required authorization\n\n* Cluster privileges: `manage`\n", - "operationId": "shutdown-get-node-1", - "parameters": [ - { - "$ref": "#/components/parameters/shutdown.get_node-node_id" - }, - { - "$ref": "#/components/parameters/shutdown.get_node-master_timeout" - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/shutdown.get_node-200" - } - }, - "x-state": "Generally available; Added in 7.13.0", - "x-metaTags": [ - { - "content": "Elasticsearch", - "name": "product_name" - } - ] - }, - "put": { - "tags": [ - "shutdown" - ], - "summary": "Prepare a node to be shut down", - "description": "NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf you specify a node that is offline, it will be prepared for shut down when it rejoins the cluster.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.\n\nThe API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster.\nThis ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster.\n\nYou must specify the type of shutdown: `restart`, `remove`, or `replace`.\nIf a node is already being prepared for shutdown, you can use this API to change the shutdown type.\n\nIMPORTANT: This API does NOT terminate the Elasticsearch process.\nMonitor the node shutdown status to determine when it is safe to stop Elasticsearch.\n\n## Required authorization\n\n* Cluster privileges: `manage`\n", - "operationId": "shutdown-put-node", - "parameters": [ - { - "in": "path", - "name": "node_id", - "description": "The node identifier.\nThis parameter is not validated against the cluster's active nodes.\nThis enables you to register a node for shut down while it is offline.\nNo error is thrown if you specify an invalid node ID.", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.NodeId" - }, - "style": "simple" - }, - { - "in": "query", - "name": "master_timeout", - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, - { - "in": "query", - "name": "timeout", - "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "type": { - "description": "Valid values are restart, remove, or replace.\nUse restart when you need to temporarily shut down a node to perform an upgrade, make configuration changes, or perform other maintenance.\nBecause the node is expected to rejoin the cluster, data is not migrated off of the node.\nUse remove when you need to permanently remove a node from the cluster.\nThe node is not marked ready for shutdown until data is migrated off of the node Use replace to do a 1:1 replacement of a node with another node.\nCertain allocation decisions will be ignored (such as disk watermarks) in the interest of true replacement of the source node with the target node.\nDuring a replace-type shutdown, rollover and index creation may result in unassigned shards, and shrink may fail until the replacement is complete.", - "allOf": [ - { - "$ref": "#/components/schemas/shutdown._types.Type" - } - ] - }, - "reason": { - "description": "A human-readable reason that the node is being shut down.\nThis field provides information for other cluster operators; it does not affect the shut down process.", - "type": "string" - }, - "allocation_delay": { - "description": "Only valid if type is restart.\nControls how long Elasticsearch will wait for the node to restart and join the cluster before reassigning its shards to other nodes.\nThis works the same as delaying allocation with the index.unassigned.node_left.delayed_timeout setting.\nIf you specify both a restart allocation delay and an index-level allocation delay, the longer of the two is used.", - "type": "string" - }, - "target_node_name": { - "description": "Only valid if type is replace.\nSpecifies the name of the node that is replacing the node being shut down.\nShards from the shut down node are only allowed to be allocated to the target node, and no other data will be allocated to the target node.\nDuring relocation of data certain allocation rules are ignored, such as disk watermarks or user attribute filtering rules.", - "type": "string" - } - }, - "required": [ - "type", - "reason" - ] - }, - "examples": { - "ShutdownPutNodeRequestExample1": { - "description": "Register a node for shutdown with `PUT /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown`. The `restart` type prepares the node to be restarted.\n", - "value": "{\n \"type\": \"restart\",\n \"reason\": \"Demonstrating how the node shutdown API works\",\n \"allocation_delay\": \"20m\"\n}" - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types.AcknowledgedResponseBase" - } - } - } - } - }, - "x-state": "Generally available; Added in 7.13.0", - "x-metaTags": [ - { - "content": "Elasticsearch", - "name": "product_name" - } - ] - }, - "delete": { - "tags": [ - "shutdown" - ], - "summary": "Cancel node shutdown preparations", - "description": "Remove a node from the shutdown list so it can resume normal operations.\nYou must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster.\nShutdown requests are never removed automatically by Elasticsearch.\n\nNOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.\nDirect use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.\n\n## Required authorization\n\n* Cluster privileges: `manage`\n", - "operationId": "shutdown-delete-node", - "parameters": [ - { - "in": "path", - "name": "node_id", - "description": "The node id of node to be removed from the shutdown state", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.NodeId" - }, - "style": "simple" - }, - { - "in": "query", - "name": "master_timeout", - "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, - { - "in": "query", - "name": "timeout", - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_types.AcknowledgedResponseBase" - }, - "examples": { - "ShutdownDeleteNodeResponseExample1": { - "description": "A successful response from `DELETE /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown`.", - "value": "{\n \"acknowledged\": true\n}" - } - } - } - } - } - }, - "x-state": "Generally available; Added in 7.13.0", - "x-metaTags": [ - { - "content": "Elasticsearch", - "name": "product_name" - } - ] - } - }, - "/_nodes/shutdown": { - "get": { - "tags": [ - "shutdown" - ], - "summary": "Get the shutdown status", - "description": "Get information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled.\nThe API returns status information for each part of the shut down process.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.\n\n## Required authorization\n\n* Cluster privileges: `manage`\n", - "operationId": "shutdown-get-node", - "parameters": [ - { - "$ref": "#/components/parameters/shutdown.get_node-master_timeout" - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/shutdown.get_node-200" - } - }, - "x-state": "Generally available; Added in 7.13.0", - "x-metaTags": [ - { - "content": "Elasticsearch", - "name": "product_name" - } - ] - } - }, "/_ingest/_simulate": { "get": { "tags": [ @@ -71289,145 +70776,6 @@ } } }, - "autoscaling.get_autoscaling_capacity.AutoscalingDeciders": { - "type": "object", - "properties": { - "required_capacity": { - "allOf": [ - { - "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingCapacity" - } - ] - }, - "current_capacity": { - "allOf": [ - { - "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingCapacity" - } - ] - }, - "current_nodes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingNode" - } - }, - "deciders": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingDecider" - } - } - }, - "required": [ - "required_capacity", - "current_capacity", - "current_nodes", - "deciders" - ] - }, - "autoscaling.get_autoscaling_capacity.AutoscalingCapacity": { - "type": "object", - "properties": { - "node": { - "allOf": [ - { - "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingResources" - } - ] - }, - "total": { - "allOf": [ - { - "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingResources" - } - ] - } - }, - "required": [ - "node", - "total" - ] - }, - "autoscaling.get_autoscaling_capacity.AutoscalingResources": { - "type": "object", - "properties": { - "storage": { - "type": "number" - }, - "memory": { - "type": "number" - } - }, - "required": [ - "storage", - "memory" - ] - }, - "autoscaling.get_autoscaling_capacity.AutoscalingNode": { - "type": "object", - "properties": { - "name": { - "allOf": [ - { - "$ref": "#/components/schemas/_types.NodeName" - } - ] - } - }, - "required": [ - "name" - ] - }, - "_types.NodeName": { - "type": "string" - }, - "autoscaling.get_autoscaling_capacity.AutoscalingDecider": { - "type": "object", - "properties": { - "required_capacity": { - "allOf": [ - { - "$ref": "#/components/schemas/autoscaling.get_autoscaling_capacity.AutoscalingCapacity" - } - ] - }, - "reason_summary": { - "type": "string" - }, - "reason_details": { - "type": "object" - } - }, - "required": [ - "required_capacity" - ] - }, - "autoscaling._types.AutoscalingPolicy": { - "type": "object", - "properties": { - "roles": { - "type": "array", - "items": { - "type": "string" - } - }, - "deciders": { - "externalDocs": { - "url": "https://www.elastic.co/docs/deploy-manage/autoscaling/autoscaling-deciders" - }, - "description": "Decider settings.", - "type": "object", - "additionalProperties": { - "type": "object" - } - } - }, - "required": [ - "roles", - "deciders" - ] - }, "_types.Refresh": { "type": "string", "enum": [ @@ -89061,6 +88409,9 @@ "shard" ] }, + "_types.NodeName": { + "type": "string" + }, "cluster.stats.StatsResponseBase": { "allOf": [ { @@ -122593,142 +121944,6 @@ "relation" ] }, - "shutdown.get_node.NodeShutdownStatus": { - "type": "object", - "properties": { - "node_id": { - "allOf": [ - { - "$ref": "#/components/schemas/_types.NodeId" - } - ] - }, - "type": { - "allOf": [ - { - "$ref": "#/components/schemas/shutdown.get_node.ShutdownType" - } - ] - }, - "reason": { - "type": "string" - }, - "shutdown_startedmillis": { - "allOf": [ - { - "$ref": "#/components/schemas/_types.EpochTimeUnitMillis" - } - ] - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/shutdown.get_node.ShutdownStatus" - } - ] - }, - "shard_migration": { - "allOf": [ - { - "$ref": "#/components/schemas/shutdown.get_node.ShardMigrationStatus" - } - ] - }, - "persistent_tasks": { - "allOf": [ - { - "$ref": "#/components/schemas/shutdown.get_node.PersistentTaskStatus" - } - ] - }, - "plugins": { - "allOf": [ - { - "$ref": "#/components/schemas/shutdown.get_node.PluginsStatus" - } - ] - } - }, - "required": [ - "node_id", - "type", - "reason", - "shutdown_startedmillis", - "status", - "shard_migration", - "persistent_tasks", - "plugins" - ] - }, - "shutdown.get_node.ShutdownType": { - "type": "string", - "enum": [ - "remove", - "restart" - ] - }, - "shutdown.get_node.ShutdownStatus": { - "type": "string", - "enum": [ - "not_started", - "in_progress", - "stalled", - "complete" - ] - }, - "shutdown.get_node.ShardMigrationStatus": { - "type": "object", - "properties": { - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/shutdown.get_node.ShutdownStatus" - } - ] - } - }, - "required": [ - "status" - ] - }, - "shutdown.get_node.PersistentTaskStatus": { - "type": "object", - "properties": { - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/shutdown.get_node.ShutdownStatus" - } - ] - } - }, - "required": [ - "status" - ] - }, - "shutdown.get_node.PluginsStatus": { - "type": "object", - "properties": { - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/shutdown.get_node.ShutdownStatus" - } - ] - } - }, - "required": [ - "status" - ] - }, - "shutdown._types.Type": { - "type": "string", - "enum": [ - "restart", - "remove", - "replace" - ] - }, "simulate.ingest.MergeType": { "type": "string", "enum": [ @@ -134600,33 +133815,6 @@ } } }, - "shutdown.get_node-200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nodes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/shutdown.get_node.NodeShutdownStatus" - } - } - }, - "required": [ - "nodes" - ] - }, - "examples": { - "ShutdownGetNodeResponseExample1": { - "description": "Get the status of shutdown preparations with `GET /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown`. The response shows information about the shutdown preparations, including the status of shard migration, task migration, and plugin cleanup\n", - "value": "{\n \"nodes\": [\n {\n \"node_id\": \"USpTGYaBSIKbgSUJR2Z9lg\",\n \"type\": \"RESTART\",\n \"reason\": \"Demonstrating how the node shutdown API works\",\n \"shutdown_startedmillis\": 1624406108685,\n \"allocation_delay\": \"10m\",\n \"status\": \"COMPLETE\",\n \"shard_migration\": {\n \"status\": \"COMPLETE\",\n \"shard_migrations_remaining\": 0,\n \"explanation\": \"no shard relocation is necessary for a node restart\"\n },\n \"persistent_tasks\": {\n \"status\": \"COMPLETE\"\n },\n \"plugins\": {\n \"status\": \"COMPLETE\"\n }\n }\n ]\n}" - } - } - } - } - }, "simulate.ingest-200": { "description": "", "content": { @@ -144677,27 +143865,6 @@ }, "style": "form" }, - "shutdown.get_node-node_id": { - "in": "path", - "name": "node_id", - "description": "Which node for which to retrieve the shutdown status", - "required": true, - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.NodeIds" - }, - "style": "simple" - }, - "shutdown.get_node-master_timeout": { - "in": "query", - "name": "master_timeout", - "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", - "deprecated": false, - "schema": { - "$ref": "#/components/schemas/_types.TimeUnit" - }, - "style": "form" - }, "simulate.ingest-index": { "in": "path", "name": "index", diff --git a/output/schema/schema.json b/output/schema/schema.json index cea10be2f9..6d88e5727b 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -330,7 +330,8 @@ "availability": { "stack": { "since": "7.11.0", - "stability": "stable" + "stability": "stable", + "visibility": "private" } }, "description": "Delete an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", @@ -365,7 +366,8 @@ "availability": { "stack": { "since": "7.11.0", - "stability": "stable" + "stability": "stable", + "visibility": "private" } }, "description": "Get the autoscaling capacity.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nThis API gets the current autoscaling capacity based on the configured autoscaling policy.\nIt will return information to size the cluster appropriately to the current workload.\n\nThe `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy.\n\nThe operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information.\n\nThe response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required.\nThis information is provided for diagnosis only.\nDo not use this information to make autoscaling decisions.", @@ -400,7 +402,8 @@ "availability": { "stack": { "since": "7.11.0", - "stability": "stable" + "stability": "stable", + "visibility": "private" } }, "description": "Get an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", @@ -435,7 +438,8 @@ "availability": { "stack": { "since": "7.11.0", - "stability": "stable" + "stability": "stable", + "visibility": "private" } }, "description": "Create or update an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", @@ -21165,7 +21169,8 @@ "availability": { "stack": { "since": "7.13.0", - "stability": "stable" + "stability": "stable", + "visibility": "private" } }, "description": "Cancel node shutdown preparations.\nRemove a node from the shutdown list so it can resume normal operations.\nYou must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster.\nShutdown requests are never removed automatically by Elasticsearch.\n\nNOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.\nDirect use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.", @@ -21206,7 +21211,8 @@ "availability": { "stack": { "since": "7.13.0", - "stability": "stable" + "stability": "stable", + "visibility": "private" } }, "description": "Get the shutdown status.\n\nGet information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled.\nThe API returns status information for each part of the shut down process.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.", @@ -21253,7 +21259,8 @@ "availability": { "stack": { "since": "7.13.0", - "stability": "stable" + "stability": "stable", + "visibility": "private" } }, "description": "Prepare a node to be shut down.\n\nNOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf you specify a node that is offline, it will be prepared for shut down when it rejoins the cluster.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.\n\nThe API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster.\nThis ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster.\n\nYou must specify the type of shutdown: `restart`, `remove`, or `replace`.\nIf a node is already being prepared for shutdown, you can use this API to change the shutdown type.\n\nIMPORTANT: This API does NOT terminate the Elasticsearch process.\nMonitor the node shutdown status to determine when it is safe to stop Elasticsearch.", diff --git a/specification/autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts b/specification/autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts index 2fd2c3ca72..b508035341 100644 --- a/specification/autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts +++ b/specification/autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts @@ -26,7 +26,7 @@ import { Duration } from '@_types/Time' * * NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. * @rest_spec_name autoscaling.delete_autoscaling_policy - * @availability stack since=7.11.0 stability=stable + * @availability stack since=7.11.0 stability=stable visibility=private * @doc_id autoscaling-delete-autoscaling-policy * @ext_doc_id autoscaling */ diff --git a/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts b/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts index 4dbf3f8cc9..7f548d4b57 100644 --- a/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts +++ b/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts @@ -36,7 +36,7 @@ import { Duration } from '@_types/Time' * This information is provided for diagnosis only. * Do not use this information to make autoscaling decisions. * @rest_spec_name autoscaling.get_autoscaling_capacity - * @availability stack since=7.11.0 stability=stable + * @availability stack since=7.11.0 stability=stable visibility=private * @doc_id autoscaling-get-autoscaling-capacity * @ext_doc_id autoscaling */ diff --git a/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts b/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts index d0881cc13c..bf209ca7af 100644 --- a/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts +++ b/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts @@ -26,7 +26,7 @@ import { Duration } from '@_types/Time' * * NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. * @rest_spec_name autoscaling.get_autoscaling_policy - * @availability stack since=7.11.0 stability=stable + * @availability stack since=7.11.0 stability=stable visibility=private * @doc_id autoscaling-get-autoscaling-capacity * @ext_doc_id autoscaling */ diff --git a/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts b/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts index 7672d23156..8ff8c9a9c5 100644 --- a/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts +++ b/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts @@ -27,7 +27,7 @@ import { AutoscalingPolicy } from '@autoscaling/_types/AutoscalingPolicy' * * NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. * @rest_spec_name autoscaling.put_autoscaling_policy - * @availability stack since=7.11.0 stability=stable + * @availability stack since=7.11.0 stability=stable visibility=private * @doc_id autoscaling-put-autoscaling-policy * @ext_doc_id autoscaling */ diff --git a/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts b/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts index 5dbe6477d3..bcd8c633c6 100644 --- a/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts +++ b/specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts @@ -32,7 +32,7 @@ import { TimeUnit } from '@_types/Time' * * If the operator privileges feature is enabled, you must be an operator to use this API. * @rest_spec_name shutdown.delete_node - * @availability stack since=7.13.0 stability=stable + * @availability stack since=7.13.0 stability=stable visibility=private * @cluster_privileges manage * @doc_id nodes-api-shutdown-delete */ diff --git a/specification/shutdown/get_node/ShutdownGetNodeRequest.ts b/specification/shutdown/get_node/ShutdownGetNodeRequest.ts index b4d8fda4b3..46ba2dc1a9 100644 --- a/specification/shutdown/get_node/ShutdownGetNodeRequest.ts +++ b/specification/shutdown/get_node/ShutdownGetNodeRequest.ts @@ -31,7 +31,7 @@ import { TimeUnit } from '@_types/Time' * * If the operator privileges feature is enabled, you must be an operator to use this API. * @rest_spec_name shutdown.get_node - * @availability stack since=7.13.0 stability=stable + * @availability stack since=7.13.0 stability=stable visibility=private * @cluster_privileges manage * @doc_id nodes-api-shutdown-status */ diff --git a/specification/shutdown/put_node/ShutdownPutNodeRequest.ts b/specification/shutdown/put_node/ShutdownPutNodeRequest.ts index d8641e37b0..12cee1aba8 100644 --- a/specification/shutdown/put_node/ShutdownPutNodeRequest.ts +++ b/specification/shutdown/put_node/ShutdownPutNodeRequest.ts @@ -40,7 +40,7 @@ import { Type } from '../_types/types' * IMPORTANT: This API does NOT terminate the Elasticsearch process. * Monitor the node shutdown status to determine when it is safe to stop Elasticsearch. * @rest_spec_name shutdown.put_node - * @availability stack since=7.13.0 stability=stable + * @availability stack since=7.13.0 stability=stable visibility=private * @cluster_privileges manage * @doc_id nodes-api-shutdown */