Skip to content

Commit 0005280

Browse files
julienbourdeauaseure
authored andcommitted
chore(keys): Rename key to api_key #359
1 parent 2a73791 commit 0005280

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

algoliasearch/client.py

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -364,36 +364,36 @@ def list_api_keys(self, request_options=None):
364364
return self._req(True, '/1/keys', 'GET', request_options)
365365

366366
@deprecated
367-
def getUserKeyACL(self, key):
368-
return self.get_user_key_acl(key)
367+
def getUserKeyACL(self, api_key):
368+
return self.get_user_key_acl(api_key)
369369

370370
@deprecated
371-
def get_user_key_acl(self, key):
371+
def get_user_key_acl(self, api_key):
372372
"""Use `get_api_key_acl`"""
373-
return self.get_api_key_acl(key)
373+
return self.get_api_key_acl(api_key)
374374

375375
@deprecated
376-
def get_api_key_acl(self, key, request_options=None):
376+
def get_api_key_acl(self, api_key, request_options=None):
377377
"""Use `get_api_key`"""
378-
return self.get_api_key(key, request_options)
378+
return self.get_api_key(api_key, request_options)
379379

380380
def get_api_key(self, api_key, request_options=None):
381381
"""'Get ACL of an api key."""
382382
path = '/1/keys/%s' % api_key
383383
return self._req(True, path, 'GET', request_options)
384384

385385
@deprecated
386-
def deleteUserKey(self, key):
387-
return self.delete_user_key(key)
386+
def deleteUserKey(self, api_key):
387+
return self.delete_user_key(api_key)
388388

389389
@deprecated
390-
def delete_user_key(self, key):
390+
def delete_user_key(self, api_key):
391391
"""Use `delete_api_key`"""
392-
return self.delete_api_key(key)
392+
return self.delete_api_key(api_key)
393393

394-
def delete_api_key(self, key, request_options=None):
394+
def delete_api_key(self, api_key, request_options=None):
395395
"""Delete an existing api key."""
396-
path = '/1/keys/%s' % key
396+
path = '/1/keys/%s' % api_key
397397
return self._req(False, path, 'DELETE', request_options)
398398

399399
@deprecated
@@ -470,19 +470,19 @@ def add_api_key(self, obj,
470470
return self._req(False, '/1/keys', 'POST', request_options, data=obj)
471471

472472
@deprecated
473-
def update_user_key(self, key, obj,
473+
def update_user_key(self, api_key, obj,
474474
validity=None,
475475
max_queries_per_ip_per_hour=None,
476476
max_hits_per_query=None,
477477
indexes=None):
478478
"""Use `update_api_key`"""
479479
return self.update_api_key(
480-
key, obj, validity, max_queries_per_ip_per_hour,
480+
api_key, obj, validity, max_queries_per_ip_per_hour,
481481
max_hits_per_query, indexes
482482
)
483483

484484

485-
def update_api_key(self, key, obj,
485+
def update_api_key(self, api_key, obj,
486486
validity=None,
487487
max_queries_per_ip_per_hour=None,
488488
max_hits_per_query=None,
@@ -532,7 +532,7 @@ def update_api_key(self, key, obj,
532532
if indexes:
533533
obj['indexes'] = indexes
534534

535-
path = '/1/keys/%s' % key
535+
path = '/1/keys/%s' % api_key
536536
return self._req(False, path, 'PUT', request_options, data=obj)
537537

538538

0 commit comments

Comments
 (0)