Skip to content

Commit bbca81a

Browse files
miguelgrinbergmiguelgrinberg
authored
Add warnings for private APIs (#3212)
1 parent 42f1834 commit bbca81a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+314
-203
lines changed

‎elasticsearch/_async/client/__init__.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,9 @@
8585
CLIENT_META_SERVICE,
8686
SKIP_IN_PATH,
8787
Stability,
88+
_availability_warning,
8889
_quote,
8990
_rewrite_parameters,
90-
_stability_warning,
9191
client_node_configs,
9292
is_requests_http_auth,
9393
is_requests_node_class,
@@ -4159,7 +4159,7 @@ async def render_search_template(
41594159
@_rewrite_parameters(
41604160
body_fields=("context", "context_setup", "script"),
41614161
)
4162-
@_stability_warning(Stability.EXPERIMENTAL)
4162+
@_availability_warning(Stability.EXPERIMENTAL)
41634163
async def scripts_painless_execute(
41644164
self,
41654165
*,

‎elasticsearch/_async/client/autoscaling.py‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,20 @@
2020
from elastic_transport import ObjectApiResponse
2121

2222
from ._base import NamespacedClient
23-
from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
23+
from .utils import (
24+
SKIP_IN_PATH,
25+
Stability,
26+
Visibility,
27+
_availability_warning,
28+
_quote,
29+
_rewrite_parameters,
30+
)
2431

2532

2633
class AutoscalingClient(NamespacedClient):
2734

2835
@_rewrite_parameters()
36+
@_availability_warning(Stability.STABLE, Visibility.PRIVATE)
2937
async def delete_autoscaling_policy(
3038
self,
3139
*,
@@ -81,6 +89,7 @@ async def delete_autoscaling_policy(
8189
)
8290

8391
@_rewrite_parameters()
92+
@_availability_warning(Stability.STABLE, Visibility.PRIVATE)
8493
async def get_autoscaling_capacity(
8594
self,
8695
*,
@@ -134,6 +143,7 @@ async def get_autoscaling_capacity(
134143
)
135144

136145
@_rewrite_parameters()
146+
@_availability_warning(Stability.STABLE, Visibility.PRIVATE)
137147
async def get_autoscaling_policy(
138148
self,
139149
*,
@@ -186,6 +196,7 @@ async def get_autoscaling_policy(
186196
@_rewrite_parameters(
187197
body_name="policy",
188198
)
199+
@_availability_warning(Stability.STABLE, Visibility.PRIVATE)
189200
async def put_autoscaling_policy(
190201
self,
191202
*,

‎elasticsearch/_async/client/cat.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@
2323
from .utils import (
2424
SKIP_IN_PATH,
2525
Stability,
26+
_availability_warning,
2627
_quote,
2728
_rewrite_parameters,
28-
_stability_warning,
2929
)
3030

3131

@@ -3870,7 +3870,7 @@ async def snapshots(
38703870
)
38713871

38723872
@_rewrite_parameters()
3873-
@_stability_warning(Stability.EXPERIMENTAL)
3873+
@_availability_warning(Stability.EXPERIMENTAL)
38743874
async def tasks(
38753875
self,
38763876
*,

‎elasticsearch/_async/client/connector.py‎

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,17 @@
2323
from .utils import (
2424
SKIP_IN_PATH,
2525
Stability,
26+
Visibility,
27+
_availability_warning,
2628
_quote,
2729
_rewrite_parameters,
28-
_stability_warning,
2930
)
3031

3132

3233
class ConnectorClient(NamespacedClient):
3334

3435
@_rewrite_parameters()
35-
@_stability_warning(Stability.EXPERIMENTAL)
36+
@_availability_warning(Stability.EXPERIMENTAL)
3637
async def check_in(
3738
self,
3839
*,
@@ -77,7 +78,7 @@ async def check_in(
7778
)
7879

7980
@_rewrite_parameters()
80-
@_stability_warning(Stability.BETA)
81+
@_availability_warning(Stability.BETA)
8182
async def delete(
8283
self,
8384
*,
@@ -134,7 +135,7 @@ async def delete(
134135
)
135136

136137
@_rewrite_parameters()
137-
@_stability_warning(Stability.BETA)
138+
@_availability_warning(Stability.BETA)
138139
async def get(
139140
self,
140141
*,
@@ -199,7 +200,7 @@ async def get(
199200
"sync_cursor",
200201
),
201202
)
202-
@_stability_warning(Stability.EXPERIMENTAL)
203+
@_availability_warning(Stability.EXPERIMENTAL, Visibility.PRIVATE)
203204
async def last_sync(
204205
self,
205206
*,
@@ -333,7 +334,7 @@ async def last_sync(
333334
@_rewrite_parameters(
334335
parameter_aliases={"from": "from_"},
335336
)
336-
@_stability_warning(Stability.BETA)
337+
@_availability_warning(Stability.BETA)
337338
async def list(
338339
self,
339340
*,
@@ -416,7 +417,7 @@ async def list(
416417
"service_type",
417418
),
418419
)
419-
@_stability_warning(Stability.BETA)
420+
@_availability_warning(Stability.BETA)
420421
async def post(
421422
self,
422423
*,
@@ -500,7 +501,7 @@ async def post(
500501
"service_type",
501502
),
502503
)
503-
@_stability_warning(Stability.BETA)
504+
@_availability_warning(Stability.BETA)
504505
async def put(
505506
self,
506507
*,
@@ -580,7 +581,7 @@ async def put(
580581
)
581582

582583
@_rewrite_parameters()
583-
@_stability_warning(Stability.BETA)
584+
@_availability_warning(Stability.BETA)
584585
async def sync_job_cancel(
585586
self,
586587
*,
@@ -630,7 +631,7 @@ async def sync_job_cancel(
630631
)
631632

632633
@_rewrite_parameters()
633-
@_stability_warning(Stability.EXPERIMENTAL)
634+
@_availability_warning(Stability.EXPERIMENTAL)
634635
async def sync_job_check_in(
635636
self,
636637
*,
@@ -684,7 +685,7 @@ async def sync_job_check_in(
684685
@_rewrite_parameters(
685686
body_fields=("worker_hostname", "sync_cursor"),
686687
)
687-
@_stability_warning(Stability.EXPERIMENTAL)
688+
@_availability_warning(Stability.EXPERIMENTAL)
688689
async def sync_job_claim(
689690
self,
690691
*,
@@ -753,7 +754,7 @@ async def sync_job_claim(
753754
)
754755

755756
@_rewrite_parameters()
756-
@_stability_warning(Stability.BETA)
757+
@_availability_warning(Stability.BETA)
757758
async def sync_job_delete(
758759
self,
759760
*,
@@ -804,7 +805,7 @@ async def sync_job_delete(
804805
@_rewrite_parameters(
805806
body_fields=("error",),
806807
)
807-
@_stability_warning(Stability.EXPERIMENTAL)
808+
@_availability_warning(Stability.EXPERIMENTAL)
808809
async def sync_job_error(
809810
self,
810811
*,
@@ -863,7 +864,7 @@ async def sync_job_error(
863864
)
864865

865866
@_rewrite_parameters()
866-
@_stability_warning(Stability.BETA)
867+
@_availability_warning(Stability.BETA)
867868
async def sync_job_get(
868869
self,
869870
*,
@@ -911,7 +912,7 @@ async def sync_job_get(
911912
@_rewrite_parameters(
912913
parameter_aliases={"from": "from_"},
913914
)
914-
@_stability_warning(Stability.BETA)
915+
@_availability_warning(Stability.BETA)
915916
async def sync_job_list(
916917
self,
917918
*,
@@ -994,7 +995,7 @@ async def sync_job_list(
994995
@_rewrite_parameters(
995996
body_fields=("id", "job_type", "trigger_method"),
996997
)
997-
@_stability_warning(Stability.BETA)
998+
@_availability_warning(Stability.BETA)
998999
async def sync_job_post(
9991000
self,
10001001
*,
@@ -1066,7 +1067,7 @@ async def sync_job_post(
10661067
"total_document_count",
10671068
),
10681069
)
1069-
@_stability_warning(Stability.EXPERIMENTAL)
1070+
@_availability_warning(Stability.EXPERIMENTAL)
10701071
async def sync_job_update_stats(
10711072
self,
10721073
*,
@@ -1160,7 +1161,7 @@ async def sync_job_update_stats(
11601161
)
11611162

11621163
@_rewrite_parameters()
1163-
@_stability_warning(Stability.EXPERIMENTAL)
1164+
@_availability_warning(Stability.EXPERIMENTAL)
11641165
async def update_active_filtering(
11651166
self,
11661167
*,
@@ -1207,7 +1208,7 @@ async def update_active_filtering(
12071208
@_rewrite_parameters(
12081209
body_fields=("api_key_id", "api_key_secret_id"),
12091210
)
1210-
@_stability_warning(Stability.BETA)
1211+
@_availability_warning(Stability.BETA)
12111212
async def update_api_key_id(
12121213
self,
12131214
*,
@@ -1269,7 +1270,7 @@ async def update_api_key_id(
12691270
@_rewrite_parameters(
12701271
body_fields=("configuration", "values"),
12711272
)
1272-
@_stability_warning(Stability.BETA)
1273+
@_availability_warning(Stability.BETA)
12731274
async def update_configuration(
12741275
self,
12751276
*,
@@ -1328,7 +1329,7 @@ async def update_configuration(
13281329
@_rewrite_parameters(
13291330
body_fields=("error",),
13301331
)
1331-
@_stability_warning(Stability.EXPERIMENTAL)
1332+
@_availability_warning(Stability.EXPERIMENTAL)
13321333
async def update_error(
13331334
self,
13341335
*,
@@ -1387,7 +1388,7 @@ async def update_error(
13871388
@_rewrite_parameters(
13881389
body_fields=("features",),
13891390
)
1390-
@_stability_warning(Stability.EXPERIMENTAL)
1391+
@_availability_warning(Stability.EXPERIMENTAL)
13911392
async def update_features(
13921393
self,
13931394
*,
@@ -1455,7 +1456,7 @@ async def update_features(
14551456
@_rewrite_parameters(
14561457
body_fields=("advanced_snippet", "filtering", "rules"),
14571458
)
1458-
@_stability_warning(Stability.BETA)
1459+
@_availability_warning(Stability.BETA)
14591460
async def update_filtering(
14601461
self,
14611462
*,
@@ -1520,7 +1521,7 @@ async def update_filtering(
15201521
@_rewrite_parameters(
15211522
body_fields=("validation",),
15221523
)
1523-
@_stability_warning(Stability.EXPERIMENTAL)
1524+
@_availability_warning(Stability.EXPERIMENTAL)
15241525
async def update_filtering_validation(
15251526
self,
15261527
*,
@@ -1577,7 +1578,7 @@ async def update_filtering_validation(
15771578
@_rewrite_parameters(
15781579
body_fields=("index_name",),
15791580
)
1580-
@_stability_warning(Stability.BETA)
1581+
@_availability_warning(Stability.BETA)
15811582
async def update_index_name(
15821583
self,
15831584
*,
@@ -1634,7 +1635,7 @@ async def update_index_name(
16341635
@_rewrite_parameters(
16351636
body_fields=("description", "name"),
16361637
)
1637-
@_stability_warning(Stability.BETA)
1638+
@_availability_warning(Stability.BETA)
16381639
async def update_name(
16391640
self,
16401641
*,
@@ -1692,7 +1693,7 @@ async def update_name(
16921693
@_rewrite_parameters(
16931694
body_fields=("is_native",),
16941695
)
1695-
@_stability_warning(Stability.BETA)
1696+
@_availability_warning(Stability.BETA)
16961697
async def update_native(
16971698
self,
16981699
*,
@@ -1748,7 +1749,7 @@ async def update_native(
17481749
@_rewrite_parameters(
17491750
body_fields=("pipeline",),
17501751
)
1751-
@_stability_warning(Stability.BETA)
1752+
@_availability_warning(Stability.BETA)
17521753
async def update_pipeline(
17531754
self,
17541755
*,
@@ -1805,7 +1806,7 @@ async def update_pipeline(
18051806
@_rewrite_parameters(
18061807
body_fields=("scheduling",),
18071808
)
1808-
@_stability_warning(Stability.BETA)
1809+
@_availability_warning(Stability.BETA)
18091810
async def update_scheduling(
18101811
self,
18111812
*,
@@ -1861,7 +1862,7 @@ async def update_scheduling(
18611862
@_rewrite_parameters(
18621863
body_fields=("service_type",),
18631864
)
1864-
@_stability_warning(Stability.BETA)
1865+
@_availability_warning(Stability.BETA)
18651866
async def update_service_type(
18661867
self,
18671868
*,
@@ -1917,7 +1918,7 @@ async def update_service_type(
19171918
@_rewrite_parameters(
19181919
body_fields=("status",),
19191920
)
1920-
@_stability_warning(Stability.EXPERIMENTAL)
1921+
@_availability_warning(Stability.EXPERIMENTAL)
19211922
async def update_status(
19221923
self,
19231924
*,

‎elasticsearch/_async/client/esql.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@
2323
from .utils import (
2424
SKIP_IN_PATH,
2525
Stability,
26+
_availability_warning,
2627
_quote,
2728
_rewrite_parameters,
28-
_stability_warning,
2929
)
3030

3131
if t.TYPE_CHECKING:
@@ -404,7 +404,7 @@ async def async_query_stop(
404404
)
405405

406406
@_rewrite_parameters()
407-
@_stability_warning(Stability.EXPERIMENTAL)
407+
@_availability_warning(Stability.EXPERIMENTAL)
408408
async def get_query(
409409
self,
410410
*,
@@ -449,7 +449,7 @@ async def get_query(
449449
)
450450

451451
@_rewrite_parameters()
452-
@_stability_warning(Stability.EXPERIMENTAL)
452+
@_availability_warning(Stability.EXPERIMENTAL)
453453
async def list_queries(
454454
self,
455455
*,

0 commit comments

Comments
 (0)