Emit Python warnings for beta and tech preview APIs (#96)

elastic · Nov 8, 2024 · e29da94 · e29da94
1 parent 8b45de8
commit e29da94
Show file tree

Hide file tree

Showing 16 changed files with 247 additions and 13 deletions.
diff --git a/elasticsearch_serverless/_async/client/__init__.py b/elasticsearch_serverless/_async/client/__init__.py
@@ -59,8 +59,10 @@
     _TYPE_HOST,
     CLIENT_META_SERVICE,
     SKIP_IN_PATH,
+    Stability,
     _quote,
     _rewrite_parameters,
+    _stability_warning,
     client_node_config,
     is_requests_http_auth,
     is_requests_node_class,
@@ -3070,6 +3072,7 @@ async def render_search_template(
     @_rewrite_parameters(
         body_fields=("context", "context_setup", "script"),
     )
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def scripts_painless_execute(
         self,
         *,

diff --git a/elasticsearch_serverless/_async/client/connector.py b/elasticsearch_serverless/_async/client/connector.py
@@ -20,12 +20,19 @@
 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,
+    _quote,
+    _rewrite_parameters,
+    _stability_warning,
+)
 
 
 class ConnectorClient(NamespacedClient):
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def check_in(
         self,
         *,
@@ -67,6 +74,7 @@ async def check_in(
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.BETA)
     async def delete(
         self,
         *,
@@ -115,6 +123,7 @@ async def delete(
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.BETA)
     async def get(
         self,
         *,
@@ -157,6 +166,7 @@ async def get(
     @_rewrite_parameters(
         parameter_aliases={"from": "from_"},
     )
+    @_stability_warning(Stability.BETA)
     async def list(
         self,
         *,
@@ -230,6 +240,7 @@ async def list(
             "service_type",
         ),
     )
+    @_stability_warning(Stability.BETA)
     async def post(
         self,
         *,
@@ -311,6 +322,7 @@ async def post(
             "service_type",
         ),
     )
+    @_stability_warning(Stability.BETA)
     async def put(
         self,
         *,
@@ -387,6 +399,7 @@ async def put(
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.BETA)
     async def sync_job_cancel(
         self,
         *,
@@ -434,6 +447,7 @@ async def sync_job_cancel(
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.BETA)
     async def sync_job_delete(
         self,
         *,
@@ -478,6 +492,7 @@ async def sync_job_delete(
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.BETA)
     async def sync_job_get(
         self,
         *,
@@ -522,6 +537,7 @@ async def sync_job_get(
     @_rewrite_parameters(
         parameter_aliases={"from": "from_"},
     )
+    @_stability_warning(Stability.BETA)
     async def sync_job_list(
         self,
         *,
@@ -601,6 +617,7 @@ async def sync_job_list(
     @_rewrite_parameters(
         body_fields=("id", "job_type", "trigger_method"),
     )
+    @_stability_warning(Stability.BETA)
     async def sync_job_post(
         self,
         *,
@@ -660,6 +677,7 @@ async def sync_job_post(
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def update_active_filtering(
         self,
         *,
@@ -703,6 +721,7 @@ async def update_active_filtering(
     @_rewrite_parameters(
         body_fields=("api_key_id", "api_key_secret_id"),
     )
+    @_stability_warning(Stability.BETA)
     async def update_api_key_id(
         self,
         *,
@@ -761,6 +780,7 @@ async def update_api_key_id(
     @_rewrite_parameters(
         body_fields=("configuration", "values"),
     )
+    @_stability_warning(Stability.BETA)
     async def update_configuration(
         self,
         *,
@@ -816,6 +836,7 @@ async def update_configuration(
     @_rewrite_parameters(
         body_fields=("error",),
     )
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def update_error(
         self,
         *,
@@ -871,6 +892,7 @@ async def update_error(
     @_rewrite_parameters(
         body_fields=("advanced_snippet", "filtering", "rules"),
     )
+    @_stability_warning(Stability.BETA)
     async def update_filtering(
         self,
         *,
@@ -932,6 +954,7 @@ async def update_filtering(
     @_rewrite_parameters(
         body_fields=("validation",),
     )
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def update_filtering_validation(
         self,
         *,
@@ -985,6 +1008,7 @@ async def update_filtering_validation(
     @_rewrite_parameters(
         body_fields=("index_name",),
     )
+    @_stability_warning(Stability.BETA)
     async def update_index_name(
         self,
         *,
@@ -1038,6 +1062,7 @@ async def update_index_name(
     @_rewrite_parameters(
         body_fields=("description", "name"),
     )
+    @_stability_warning(Stability.BETA)
     async def update_name(
         self,
         *,
@@ -1092,6 +1117,7 @@ async def update_name(
     @_rewrite_parameters(
         body_fields=("is_native",),
     )
+    @_stability_warning(Stability.BETA)
     async def update_native(
         self,
         *,
@@ -1144,6 +1170,7 @@ async def update_native(
     @_rewrite_parameters(
         body_fields=("pipeline",),
     )
+    @_stability_warning(Stability.BETA)
     async def update_pipeline(
         self,
         *,
@@ -1197,6 +1224,7 @@ async def update_pipeline(
     @_rewrite_parameters(
         body_fields=("scheduling",),
     )
+    @_stability_warning(Stability.BETA)
     async def update_scheduling(
         self,
         *,
@@ -1249,6 +1277,7 @@ async def update_scheduling(
     @_rewrite_parameters(
         body_fields=("service_type",),
     )
+    @_stability_warning(Stability.BETA)
     async def update_service_type(
         self,
         *,
@@ -1301,6 +1330,7 @@ async def update_service_type(
     @_rewrite_parameters(
         body_fields=("status",),
     )
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def update_status(
         self,
         *,

diff --git a/elasticsearch_serverless/_async/client/inference.py b/elasticsearch_serverless/_async/client/inference.py
@@ -20,12 +20,19 @@
 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,
+    _quote,
+    _rewrite_parameters,
+    _stability_warning,
+)
 
 
 class InferenceClient(NamespacedClient):
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def delete(
         self,
         *,
@@ -93,6 +100,7 @@ async def delete(
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def get(
         self,
         *,
@@ -151,6 +159,7 @@ async def get(
     @_rewrite_parameters(
         body_fields=("input", "query", "task_settings"),
     )
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def inference(
         self,
         *,
@@ -237,6 +246,7 @@ async def inference(
     @_rewrite_parameters(
         body_name="inference_config",
     )
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def put(
         self,
         *,

diff --git a/elasticsearch_serverless/_async/client/ml.py b/elasticsearch_serverless/_async/client/ml.py
@@ -20,7 +20,13 @@
 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,
+    _quote,
+    _rewrite_parameters,
+    _stability_warning,
+)
 
 
 class MlClient(NamespacedClient):
@@ -3919,6 +3925,7 @@ async def update_job(
     @_rewrite_parameters(
         body_fields=("number_of_allocations",),
     )
+    @_stability_warning(Stability.BETA)
     async def update_trained_model_deployment(
         self,
         *,

diff --git a/elasticsearch_serverless/_async/client/search_application.py b/elasticsearch_serverless/_async/client/search_application.py
@@ -20,12 +20,19 @@
 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,
+    _quote,
+    _rewrite_parameters,
+    _stability_warning,
+)
 
 
 class SearchApplicationClient(NamespacedClient):
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.BETA)
     async def delete(
         self,
         *,
@@ -67,6 +74,7 @@ async def delete(
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def delete_behavioral_analytics(
         self,
         *,
@@ -108,6 +116,7 @@ async def delete_behavioral_analytics(
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.BETA)
     async def get(
         self,
         *,
@@ -148,6 +157,7 @@ async def get(
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def get_behavioral_analytics(
         self,
         *,
@@ -193,6 +203,7 @@ async def get_behavioral_analytics(
     @_rewrite_parameters(
         parameter_aliases={"from": "from_"},
     )
+    @_stability_warning(Stability.BETA)
     async def list(
         self,
         *,
@@ -243,6 +254,7 @@ async def list(
     @_rewrite_parameters(
         body_name="search_application",
     )
+    @_stability_warning(Stability.BETA)
     async def put(
         self,
         *,
@@ -299,6 +311,7 @@ async def put(
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def put_behavioral_analytics(
         self,
         *,
@@ -342,6 +355,7 @@ async def put_behavioral_analytics(
         body_fields=("params",),
         ignore_deprecated_options={"params"},
     )
+    @_stability_warning(Stability.BETA)
     async def search(
         self,
         *,

diff --git a/elasticsearch_serverless/_async/client/tasks.py b/elasticsearch_serverless/_async/client/tasks.py
@@ -20,12 +20,19 @@
 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,
+    _quote,
+    _rewrite_parameters,
+    _stability_warning,
+)
 
 
 class TasksClient(NamespacedClient):
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def get(
         self,
         *,