elasticsearch9 9.2.0__py3-none-any.whl → 9.2.1__py3-none-any.whl

elasticsearch9/_sync/client/nodes.py

@@ -23,16 +23,16 @@ from ._base import NamespacedClient
 from .utils import (
     SKIP_IN_PATH,
     Stability,
+    _availability_warning,
     _quote,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
 class NodesClient(NamespacedClient):
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def clear_repositories_metering_archive(
         self,
         *,
@@ -46,8 +46,8 @@ class NodesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Clear the archived repositories metering.
-          Clear the archived repositories metering information in the cluster.</p>
+          <p>Clear the archived repositories metering.</p>
+          <p>Clear the archived repositories metering information in the cluster.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-clear-repositories-metering-archive>`_
@@ -86,7 +86,7 @@ class NodesClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def get_repositories_metering_info(
         self,
         *,
@@ -99,8 +99,8 @@ class NodesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get cluster repositories metering.
-          Get repositories metering information for a cluster.
+          <p>Get cluster repositories metering.</p>
+          <p>Get repositories metering information for a cluster.
           This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time.
           Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.</p>
 
@@ -157,8 +157,8 @@ class NodesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get the hot threads for nodes.
-          Get a breakdown of the hot threads on each selected node in the cluster.
+          <p>Get the hot threads for nodes.</p>
+          <p>Get a breakdown of the hot threads on each selected node in the cluster.
           The output is plain text with a breakdown of the top hot threads for each node.</p>
 
 
@@ -169,7 +169,7 @@ class NodesClient(NamespacedClient):
             select, or to get a task from an empty queue) are filtered out.
         :param interval: The interval to do the second sampling of threads.
         :param snapshots: Number of samples of thread stacktrace.
-        :param sort: The sort order for 'cpu' type (default: total)
+        :param sort: The sort order for 'cpu' type
         :param threads: Specifies the number of hot threads to provide information for.
         :param timeout: Period to wait for a response. If no response is received before
             the timeout expires, the request fails and returns an error.
@@ -376,8 +376,8 @@ class NodesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get node statistics.
-          Get statistics for nodes in a cluster.
+          <p>Get node statistics.</p>
+          <p>Get statistics for nodes in a cluster.
           By default, all stats are returned. You can limit the returned information by using metrics.</p>
 
 
@@ -385,7 +385,7 @@ class NodesClient(NamespacedClient):
 
         :param node_id: Comma-separated list of node IDs or names used to limit returned
             information.
-        :param metric: Limit the information returned to the specified metrics
+        :param metric: Limits the information returned to the specific metrics.
         :param index_metric: Limit the information returned for indices metric to the
             specific index metrics. It can be used only if indices (or all) metric is
             specified.
@@ -499,8 +499,8 @@ class NodesClient(NamespacedClient):
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-usage>`_
 
         :param node_id: A comma-separated list of node IDs or names to limit the returned
-            information; use `_local` to return information from the node you're connecting
-            to, leave empty to get information from all nodes
+            information. Use `_local` to return information from the node you're connecting
+            to, leave empty to get information from all nodes.
         :param metric: Limits the information returned to the specific metrics. A comma-separated
             list of the following options: `_all`, `rest_actions`.
         :param timeout: Period to wait for a response. If no response is received before

elasticsearch9/_sync/client/project.py

@@ -22,15 +22,15 @@ from elastic_transport import ObjectApiResponse
 from ._base import NamespacedClient
 from .utils import (
     Stability,
+    _availability_warning,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
 class ProjectClient(NamespacedClient):
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def tags(
         self,
         *,
@@ -42,7 +42,8 @@ class ProjectClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Return tags defined for the project</p>
+          <p>Get tags.</p>
+          <p>Get the tags that are defined for the project.</p>
 
         """
         __path_parts: t.Dict[str, str] = {}

elasticsearch9/_sync/client/query_rules.py

@@ -39,8 +39,8 @@ class QueryRulesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Delete a query rule.
-          Delete a query rule within a query ruleset.
+          <p>Delete a query rule.</p>
+          <p>Delete a query rule within a query ruleset.
           This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API.</p>
 
 
@@ -92,8 +92,8 @@ class QueryRulesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Delete a query ruleset.
-          Remove a query ruleset and its associated data.
+          <p>Delete a query ruleset.</p>
+          <p>Remove a query ruleset and its associated data.
           This is a destructive action that is not recoverable.</p>
 
 
@@ -138,8 +138,8 @@ class QueryRulesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get a query rule.
-          Get details about a query rule within a query ruleset.</p>
+          <p>Get a query rule.</p>
+          <p>Get details about a query rule within a query ruleset.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-rule>`_
@@ -190,8 +190,8 @@ class QueryRulesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get a query ruleset.
-          Get details about a query ruleset.</p>
+          <p>Get a query ruleset.</p>
+          <p>Get details about a query ruleset.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-ruleset>`_
@@ -237,8 +237,8 @@ class QueryRulesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get all query rulesets.
-          Get summarized information about the query rulesets.</p>
+          <p>Get all query rulesets.</p>
+          <p>Get summarized information about the query rulesets.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-list-rulesets>`_
@@ -294,8 +294,8 @@ class QueryRulesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Create or update a query rule.
-          Create or update a query rule within a query ruleset.</p>
+          <p>Create or update a query rule.</p>
+          <p>Create or update a query rule within a query ruleset.</p>
           <p>IMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule.
           It is advised to use one or the other in query rulesets, to avoid errors.
           Additionally, pinned queries have a maximum limit of 100 pinned hits.
@@ -380,8 +380,8 @@ class QueryRulesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Create or update a query ruleset.
-          There is a limit of 100 rules per ruleset.
+          <p>Create or update a query ruleset.</p>
+          <p>There is a limit of 100 rules per ruleset.
           This limit can be increased by using the <code>xpack.applications.rules.max_rules_per_ruleset</code> cluster setting.</p>
           <p>IMPORTANT: Due to limitations within pinned queries, you can only select documents using <code>ids</code> or <code>docs</code>, but cannot use both in single rule.
           It is advised to use one or the other in query rulesets, to avoid errors.
@@ -442,8 +442,8 @@ class QueryRulesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Test a query ruleset.
-          Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.</p>
+          <p>Test a query ruleset.</p>
+          <p>Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-test>`_

elasticsearch9/_sync/client/rollup.py

@@ -23,16 +23,16 @@ from ._base import NamespacedClient
 from .utils import (
     SKIP_IN_PATH,
     Stability,
+    _availability_warning,
     _quote,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
 class RollupClient(NamespacedClient):
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def delete_job(
         self,
         *,
@@ -95,7 +95,7 @@ class RollupClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def get_jobs(
         self,
         *,
@@ -108,8 +108,8 @@ class RollupClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get rollup job information.
-          Get the configuration, stats, and status of rollup jobs.</p>
+          <p>Get rollup job information.</p>
+          <p>Get the configuration, stats, and status of rollup jobs.</p>
           <p>NOTE: This API returns only active (both <code>STARTED</code> and <code>STOPPED</code>) jobs.
           If a job was created, ran for a while, then was deleted, the API does not return any details about it.
           For details about a historical rollup job, the rollup capabilities API may be more useful.</p>
@@ -147,7 +147,7 @@ class RollupClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def get_rollup_caps(
         self,
         *,
@@ -160,8 +160,8 @@ class RollupClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get the rollup job capabilities.
-          Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern.</p>
+          <p>Get the rollup job capabilities.</p>
+          <p>Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern.</p>
           <p>This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index.
           Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.
           This API enables you to inspect an index and determine:</p>
@@ -203,7 +203,7 @@ class RollupClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def get_rollup_index_caps(
         self,
         *,
@@ -216,8 +216,8 @@ class RollupClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get the rollup index capabilities.
-          Get the rollup capabilities of all jobs inside of a rollup index.
+          <p>Get the rollup index capabilities.</p>
+          <p>Get the rollup capabilities of all jobs inside of a rollup index.
           A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:</p>
           <ul>
           <li>What jobs are stored in an index (or indices specified via a pattern)?</li>
@@ -266,7 +266,7 @@ class RollupClient(NamespacedClient):
         ),
         ignore_deprecated_options={"headers"},
     )
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def put_job(
         self,
         *,
@@ -392,7 +392,7 @@ class RollupClient(NamespacedClient):
     @_rewrite_parameters(
         body_fields=("aggregations", "aggs", "query", "size"),
     )
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def rollup_search(
         self,
         *,
@@ -412,8 +412,8 @@ class RollupClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Search rolled-up data.
-          The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.
+          <p>Search rolled-up data.</p>
+          <p>The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.
           It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.</p>
           <p>The request body supports a subset of features from the regular search API.
           The following functionality is not available:</p>
@@ -482,7 +482,7 @@ class RollupClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def start_job(
         self,
         *,
@@ -495,8 +495,8 @@ class RollupClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Start rollup jobs.
-          If you try to start a job that does not exist, an exception occurs.
+          <p>Start rollup jobs.</p>
+          <p>If you try to start a job that does not exist, an exception occurs.
           If you try to start a job that is already started, nothing happens.</p>
 
 
@@ -528,7 +528,7 @@ class RollupClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def stop_job(
         self,
         *,
@@ -543,8 +543,8 @@ class RollupClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Stop rollup jobs.
-          If you try to stop a job that does not exist, an exception occurs.
+          <p>Stop rollup jobs.</p>
+          <p>If you try to stop a job that does not exist, an exception occurs.
           If you try to stop a job that is already stopped, nothing happens.</p>
           <p>Since only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped.
           This is accomplished with the <code>wait_for_completion</code> query parameter, and optionally a timeout. For example:</p>

elasticsearch9/_sync/client/search_application.py

@@ -23,16 +23,16 @@ from ._base import NamespacedClient
 from .utils import (
     SKIP_IN_PATH,
     Stability,
+    _availability_warning,
     _quote,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
 class SearchApplicationClient(NamespacedClient):
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.BETA)
+    @_availability_warning(Stability.BETA)
     def delete(
         self,
         *,
@@ -77,7 +77,7 @@ class SearchApplicationClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def delete_behavioral_analytics(
         self,
         *,
@@ -90,8 +90,8 @@ class SearchApplicationClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Delete a behavioral analytics collection.
-          The associated data stream is also deleted.</p>
+          <p>Delete a behavioral analytics collection.</p>
+          <p>The associated data stream is also deleted.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete-behavioral-analytics>`_
@@ -122,7 +122,7 @@ class SearchApplicationClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.BETA)
+    @_availability_warning(Stability.BETA)
     def get(
         self,
         *,
@@ -166,7 +166,7 @@ class SearchApplicationClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def get_behavioral_analytics(
         self,
         *,
@@ -215,7 +215,7 @@ class SearchApplicationClient(NamespacedClient):
     @_rewrite_parameters(
         parameter_aliases={"from": "from_"},
     )
-    @_stability_warning(Stability.BETA)
+    @_availability_warning(Stability.BETA)
     def list(
         self,
         *,
@@ -230,8 +230,8 @@ class SearchApplicationClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get search applications.
-          Get information about search applications.</p>
+          <p>Get search applications.</p>
+          <p>Get information about search applications.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics>`_
@@ -270,7 +270,7 @@ class SearchApplicationClient(NamespacedClient):
     @_rewrite_parameters(
         body_name="payload",
     )
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def post_behavioral_analytics_event(
         self,
         *,
@@ -338,7 +338,7 @@ class SearchApplicationClient(NamespacedClient):
     @_rewrite_parameters(
         body_name="search_application",
     )
-    @_stability_warning(Stability.BETA)
+    @_availability_warning(Stability.BETA)
     def put(
         self,
         *,
@@ -398,7 +398,7 @@ class SearchApplicationClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def put_behavioral_analytics(
         self,
         *,
@@ -445,7 +445,7 @@ class SearchApplicationClient(NamespacedClient):
         body_fields=("params",),
         ignore_deprecated_options={"params"},
     )
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def render_query(
         self,
         *,
@@ -460,8 +460,8 @@ class SearchApplicationClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Render a search application query.
-          Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified.
+          <p>Render a search application query.</p>
+          <p>Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified.
           If a parameter used in the search template is not specified in <code>params</code>, the parameter's default value will be used.
           The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.</p>
           <p>You must have <code>read</code> privileges on the backing alias of the search application.</p>
@@ -510,7 +510,7 @@ class SearchApplicationClient(NamespacedClient):
         body_fields=("params",),
         ignore_deprecated_options={"params"},
     )
-    @_stability_warning(Stability.BETA)
+    @_availability_warning(Stability.BETA)
     def search(
         self,
         *,
@@ -526,8 +526,8 @@ class SearchApplicationClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Run a search application search.
-          Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.
+          <p>Run a search application search.</p>
+          <p>Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.
           Unspecified template parameters are assigned their default values if applicable.</p>
 
 

elasticsearch9/_sync/client/searchable_snapshots.py

@@ -23,16 +23,16 @@ from ._base import NamespacedClient
 from .utils import (
     SKIP_IN_PATH,
     Stability,
+    _availability_warning,
     _quote,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
 class SearchableSnapshotsClient(NamespacedClient):
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def cache_stats(
         self,
         *,
@@ -46,8 +46,8 @@ class SearchableSnapshotsClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get cache statistics.
-          Get statistics about the shared cache for partially mounted indices.</p>
+          <p>Get cache statistics.</p>
+          <p>Get statistics about the shared cache for partially mounted indices.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-cache-stats>`_
@@ -84,7 +84,7 @@ class SearchableSnapshotsClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def clear_cache(
         self,
         *,
@@ -107,8 +107,8 @@ class SearchableSnapshotsClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Clear the cache.
-          Clear indices and data streams from the shared cache for partially mounted indices.</p>
+          <p>Clear the cache.</p>
+          <p>Clear indices and data streams from the shared cache for partially mounted indices.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-clear-cache>`_
@@ -119,7 +119,7 @@ class SearchableSnapshotsClient(NamespacedClient):
             into no concrete indices. (This includes `_all` string or when no indices
             have been specified)
         :param expand_wildcards: Whether to expand wildcard expression to concrete indices
-            that are open, closed or both.
+            that are open, closed or both
         :param ignore_unavailable: Whether specified concrete indices should be ignored
             when unavailable (missing or closed)
         """
@@ -184,8 +184,8 @@ class SearchableSnapshotsClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Mount a snapshot.
-          Mount a snapshot as a searchable snapshot index.
+          <p>Mount a snapshot.</p>
+          <p>Mount a snapshot as a searchable snapshot index.
           Do not use this API for snapshots managed by index lifecycle management (ILM).
           Manually mounting ILM-managed snapshots can interfere with ILM processes.</p>
 

elasticsearch9/_sync/client/security.py

@@ -288,8 +288,8 @@ class SecurityClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Bulk update API keys.
-          Update the attributes for multiple API keys.</p>
+          <p>Bulk update API keys.</p>
+          <p>Update the attributes for multiple API keys.</p>
           <p>IMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required.</p>
           <p>This API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates.</p>
           <p>It is not possible to update expired or invalidated API keys.</p>
@@ -892,8 +892,8 @@ class SecurityClient(NamespacedClient):
             Token names must be unique in the context of the associated service account.
             They must also be globally unique with their fully qualified names, which
             are comprised of the service account principal and token name, such as `<namespace>/<service>/<token-name>`.
-        :param refresh: If `true` then refresh the affected shards to make this operation
-            visible to search, if `wait_for` (the default) then wait for a refresh to
+        :param refresh: If `true` (the default) then refresh the affected shards to make
+            this operation visible to search, if `wait_for` then wait for a refresh to
             make this operation visible to search, if `false` then do nothing with refreshes.
         """
         if namespace in SKIP_IN_PATH:
@@ -1208,8 +1208,8 @@ class SecurityClient(NamespacedClient):
         :param namespace: The namespace, which is a top-level grouping of service accounts.
         :param service: The service name.
         :param name: The name of the service account token.
-        :param refresh: If `true` then refresh the affected shards to make this operation
-            visible to search, if `wait_for` (the default) then wait for a refresh to
+        :param refresh: If `true` (the default) then refresh the affected shards to make
+            this operation visible to search, if `wait_for` then wait for a refresh to
             make this operation visible to search, if `false` then do nothing with refreshes.
         """
         if namespace in SKIP_IN_PATH:
@@ -3750,7 +3750,8 @@ class SecurityClient(NamespacedClient):
         :param size: The number of hits to return. It must not be negative. By default,
             you cannot page through more than 10,000 hits using the `from` and `size`
             parameters. To page through more hits, use the `search_after` parameter.
-        :param sort: The sort definition. You can sort on `username`, `roles`, or `enabled`.
+        :param sort: The sort definition. You can sort on `name`, `description`, `metadata`,
+            `applications.application`, `applications.privileges`, and `applications.resources`.
             In addition, sort can also be applied to the `_doc` field to sort by index
             order.
         """

elasticsearch9/_sync/client/shutdown.py

@@ -20,12 +20,20 @@ import typing as t
 from elastic_transport import ObjectApiResponse
 
 from ._base import NamespacedClient
-from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
+from .utils import (
+    SKIP_IN_PATH,
+    Stability,
+    Visibility,
+    _availability_warning,
+    _quote,
+    _rewrite_parameters,
+)
 
 
 class ShutdownClient(NamespacedClient):
 
     @_rewrite_parameters()
+    @_availability_warning(Stability.STABLE, Visibility.PRIVATE)
     def delete_node(
         self,
         *,
@@ -40,8 +48,8 @@ class ShutdownClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Cancel node shutdown preparations.
-          Remove a node from the shutdown list so it can resume normal operations.
+          <p>Cancel node shutdown preparations.</p>
+          <p>Remove a node from the shutdown list so it can resume normal operations.
           You must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster.
           Shutdown requests are never removed automatically by Elasticsearch.</p>
           <p>NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.
@@ -86,6 +94,7 @@ class ShutdownClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
+    @_availability_warning(Stability.STABLE, Visibility.PRIVATE)
     def get_node(
         self,
         *,
@@ -108,7 +117,8 @@ class ShutdownClient(NamespacedClient):
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-get-node>`_
 
-        :param node_id: Which node for which to retrieve the shutdown status
+        :param node_id: Comma-separated list of nodes for which to retrieve the shutdown
+            status
         :param master_timeout: 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.
@@ -144,6 +154,7 @@ class ShutdownClient(NamespacedClient):
     @_rewrite_parameters(
         body_fields=("reason", "type", "allocation_delay", "target_node_name"),
     )
+    @_availability_warning(Stability.STABLE, Visibility.PRIVATE)
     def put_node(
         self,
         *,