Skip to content

Commit 09e3a0a

Browse files
miguelgrinbergmiguelgrinberg
committed
Add warnings for private APIs (#3212)
1 parent 5e8f23c commit 09e3a0a

39 files changed

+391
-189
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,
@@ -4417,7 +4417,7 @@ async def render_search_template(
44174417
@_rewrite_parameters(
44184418
body_fields=("context", "context_setup", "script"),
44194419
)
4420-
@_stability_warning(Stability.EXPERIMENTAL)
4420+
@_availability_warning(Stability.EXPERIMENTAL)
44214421
async def scripts_painless_execute(
44224422
self,
44234423
*,

‎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

@@ -3455,7 +3455,7 @@ async def snapshots(
34553455
)
34563456

34573457
@_rewrite_parameters()
3458-
@_stability_warning(Stability.EXPERIMENTAL)
3458+
@_availability_warning(Stability.EXPERIMENTAL)
34593459
async def tasks(
34603460
self,
34613461
*,

‎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
*,
@@ -130,7 +131,7 @@ async def delete(
130131
)
131132

132133
@_rewrite_parameters()
133-
@_stability_warning(Stability.BETA)
134+
@_availability_warning(Stability.BETA)
134135
async def get(
135136
self,
136137
*,
@@ -190,7 +191,7 @@ async def get(
190191
"sync_cursor",
191192
),
192193
)
193-
@_stability_warning(Stability.EXPERIMENTAL)
194+
@_availability_warning(Stability.EXPERIMENTAL, Visibility.PRIVATE)
194195
async def last_sync(
195196
self,
196197
*,
@@ -324,7 +325,7 @@ async def last_sync(
324325
@_rewrite_parameters(
325326
parameter_aliases={"from": "from_"},
326327
)
327-
@_stability_warning(Stability.BETA)
328+
@_availability_warning(Stability.BETA)
328329
async def list(
329330
self,
330331
*,
@@ -402,7 +403,7 @@ async def list(
402403
"service_type",
403404
),
404405
)
405-
@_stability_warning(Stability.BETA)
406+
@_availability_warning(Stability.BETA)
406407
async def post(
407408
self,
408409
*,
@@ -486,7 +487,7 @@ async def post(
486487
"service_type",
487488
),
488489
)
489-
@_stability_warning(Stability.BETA)
490+
@_availability_warning(Stability.BETA)
490491
async def put(
491492
self,
492493
*,
@@ -566,7 +567,7 @@ async def put(
566567
)
567568

568569
@_rewrite_parameters()
569-
@_stability_warning(Stability.BETA)
570+
@_availability_warning(Stability.BETA)
570571
async def sync_job_cancel(
571572
self,
572573
*,
@@ -616,7 +617,7 @@ async def sync_job_cancel(
616617
)
617618

618619
@_rewrite_parameters()
619-
@_stability_warning(Stability.EXPERIMENTAL)
620+
@_availability_warning(Stability.EXPERIMENTAL)
620621
async def sync_job_check_in(
621622
self,
622623
*,
@@ -670,7 +671,7 @@ async def sync_job_check_in(
670671
@_rewrite_parameters(
671672
body_fields=("worker_hostname", "sync_cursor"),
672673
)
673-
@_stability_warning(Stability.EXPERIMENTAL)
674+
@_availability_warning(Stability.EXPERIMENTAL)
674675
async def sync_job_claim(
675676
self,
676677
*,
@@ -739,7 +740,7 @@ async def sync_job_claim(
739740
)
740741

741742
@_rewrite_parameters()
742-
@_stability_warning(Stability.BETA)
743+
@_availability_warning(Stability.BETA)
743744
async def sync_job_delete(
744745
self,
745746
*,
@@ -790,7 +791,7 @@ async def sync_job_delete(
790791
@_rewrite_parameters(
791792
body_fields=("error",),
792793
)
793-
@_stability_warning(Stability.EXPERIMENTAL)
794+
@_availability_warning(Stability.EXPERIMENTAL)
794795
async def sync_job_error(
795796
self,
796797
*,
@@ -849,7 +850,7 @@ async def sync_job_error(
849850
)
850851

851852
@_rewrite_parameters()
852-
@_stability_warning(Stability.BETA)
853+
@_availability_warning(Stability.BETA)
853854
async def sync_job_get(
854855
self,
855856
*,
@@ -897,7 +898,7 @@ async def sync_job_get(
897898
@_rewrite_parameters(
898899
parameter_aliases={"from": "from_"},
899900
)
900-
@_stability_warning(Stability.BETA)
901+
@_availability_warning(Stability.BETA)
901902
async def sync_job_list(
902903
self,
903904
*,
@@ -980,7 +981,7 @@ async def sync_job_list(
980981
@_rewrite_parameters(
981982
body_fields=("id", "job_type", "trigger_method"),
982983
)
983-
@_stability_warning(Stability.BETA)
984+
@_availability_warning(Stability.BETA)
984985
async def sync_job_post(
985986
self,
986987
*,
@@ -1052,7 +1053,7 @@ async def sync_job_post(
10521053
"total_document_count",
10531054
),
10541055
)
1055-
@_stability_warning(Stability.EXPERIMENTAL)
1056+
@_availability_warning(Stability.EXPERIMENTAL)
10561057
async def sync_job_update_stats(
10571058
self,
10581059
*,
@@ -1146,7 +1147,7 @@ async def sync_job_update_stats(
11461147
)
11471148

11481149
@_rewrite_parameters()
1149-
@_stability_warning(Stability.EXPERIMENTAL)
1150+
@_availability_warning(Stability.EXPERIMENTAL)
11501151
async def update_active_filtering(
11511152
self,
11521153
*,
@@ -1193,7 +1194,7 @@ async def update_active_filtering(
11931194
@_rewrite_parameters(
11941195
body_fields=("api_key_id", "api_key_secret_id"),
11951196
)
1196-
@_stability_warning(Stability.BETA)
1197+
@_availability_warning(Stability.BETA)
11971198
async def update_api_key_id(
11981199
self,
11991200
*,
@@ -1255,7 +1256,7 @@ async def update_api_key_id(
12551256
@_rewrite_parameters(
12561257
body_fields=("configuration", "values"),
12571258
)
1258-
@_stability_warning(Stability.BETA)
1259+
@_availability_warning(Stability.BETA)
12591260
async def update_configuration(
12601261
self,
12611262
*,
@@ -1314,7 +1315,7 @@ async def update_configuration(
13141315
@_rewrite_parameters(
13151316
body_fields=("error",),
13161317
)
1317-
@_stability_warning(Stability.EXPERIMENTAL)
1318+
@_availability_warning(Stability.EXPERIMENTAL)
13181319
async def update_error(
13191320
self,
13201321
*,
@@ -1373,7 +1374,7 @@ async def update_error(
13731374
@_rewrite_parameters(
13741375
body_fields=("features",),
13751376
)
1376-
@_stability_warning(Stability.EXPERIMENTAL)
1377+
@_availability_warning(Stability.EXPERIMENTAL)
13771378
async def update_features(
13781379
self,
13791380
*,
@@ -1441,7 +1442,7 @@ async def update_features(
14411442
@_rewrite_parameters(
14421443
body_fields=("advanced_snippet", "filtering", "rules"),
14431444
)
1444-
@_stability_warning(Stability.BETA)
1445+
@_availability_warning(Stability.BETA)
14451446
async def update_filtering(
14461447
self,
14471448
*,
@@ -1506,7 +1507,7 @@ async def update_filtering(
15061507
@_rewrite_parameters(
15071508
body_fields=("validation",),
15081509
)
1509-
@_stability_warning(Stability.EXPERIMENTAL)
1510+
@_availability_warning(Stability.EXPERIMENTAL)
15101511
async def update_filtering_validation(
15111512
self,
15121513
*,
@@ -1563,7 +1564,7 @@ async def update_filtering_validation(
15631564
@_rewrite_parameters(
15641565
body_fields=("index_name",),
15651566
)
1566-
@_stability_warning(Stability.BETA)
1567+
@_availability_warning(Stability.BETA)
15671568
async def update_index_name(
15681569
self,
15691570
*,
@@ -1620,7 +1621,7 @@ async def update_index_name(
16201621
@_rewrite_parameters(
16211622
body_fields=("description", "name"),
16221623
)
1623-
@_stability_warning(Stability.BETA)
1624+
@_availability_warning(Stability.BETA)
16241625
async def update_name(
16251626
self,
16261627
*,
@@ -1678,7 +1679,7 @@ async def update_name(
16781679
@_rewrite_parameters(
16791680
body_fields=("is_native",),
16801681
)
1681-
@_stability_warning(Stability.BETA)
1682+
@_availability_warning(Stability.BETA)
16821683
async def update_native(
16831684
self,
16841685
*,
@@ -1734,7 +1735,7 @@ async def update_native(
17341735
@_rewrite_parameters(
17351736
body_fields=("pipeline",),
17361737
)
1737-
@_stability_warning(Stability.BETA)
1738+
@_availability_warning(Stability.BETA)
17381739
async def update_pipeline(
17391740
self,
17401741
*,
@@ -1791,7 +1792,7 @@ async def update_pipeline(
17911792
@_rewrite_parameters(
17921793
body_fields=("scheduling",),
17931794
)
1794-
@_stability_warning(Stability.BETA)
1795+
@_availability_warning(Stability.BETA)
17951796
async def update_scheduling(
17961797
self,
17971798
*,
@@ -1847,7 +1848,7 @@ async def update_scheduling(
18471848
@_rewrite_parameters(
18481849
body_fields=("service_type",),
18491850
)
1850-
@_stability_warning(Stability.BETA)
1851+
@_availability_warning(Stability.BETA)
18511852
async def update_service_type(
18521853
self,
18531854
*,
@@ -1903,7 +1904,7 @@ async def update_service_type(
19031904
@_rewrite_parameters(
19041905
body_fields=("status",),
19051906
)
1906-
@_stability_warning(Stability.EXPERIMENTAL)
1907+
@_availability_warning(Stability.EXPERIMENTAL)
19071908
async def update_status(
19081909
self,
19091910
*,

‎elasticsearch/_async/client/features.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
from elastic_transport import ObjectApiResponse
2121

2222
from ._base import NamespacedClient
23-
from .utils import Stability, _rewrite_parameters, _stability_warning
23+
from .utils import Stability, _availability_warning, _rewrite_parameters
2424

2525

2626
class FeaturesClient(NamespacedClient):
@@ -76,7 +76,7 @@ async def get_features(
7676
)
7777

7878
@_rewrite_parameters()
79-
@_stability_warning(Stability.EXPERIMENTAL)
79+
@_availability_warning(Stability.EXPERIMENTAL)
8080
async def reset_features(
8181
self,
8282
*,

0 commit comments

Comments
 (0)