Skip to content

Commit 214050b

Browse files
committed
DOC: docstring for 'info_get' API
1 parent 23dad7d commit 214050b

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

src/save_and_restore_api/_api_async.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,8 @@ async def restore_items(self, *, snapshotItems, auth=None):
196196
return await self.send_request(method, url, params=params, auth=auth)
197197

198198

199+
SaveRestoreAPI.info_get.__doc__ = _SaveRestoreAPI_Threads.info_get.__doc__
200+
SaveRestoreAPI.login.__doc__ = _SaveRestoreAPI_Threads.login.__doc__
199201
SaveRestoreAPI.node_get.__doc__ = _SaveRestoreAPI_Threads.node_get.__doc__
200202
SaveRestoreAPI.nodes_get.__doc__ = _SaveRestoreAPI_Threads.nodes_get.__doc__
201203
SaveRestoreAPI.node_add.__doc__ = _SaveRestoreAPI_Threads.node_add.__doc__

src/save_and_restore_api/_api_threads.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,11 @@ def send_request(
4444
# =============================================================================================
4545

4646
def info_get(self):
47+
"""
48+
Returns information about the Save and Restore service.
49+
50+
API: GET /
51+
"""
4752
method, url = self._prepare_info_get()
4853
return self.send_request(method, url)
4954

@@ -52,6 +57,11 @@ def info_get(self):
5257
# =============================================================================================
5358

5459
def login(self, *, username=None, password=None):
60+
"""
61+
Validate user credentials and return user information.
62+
63+
API: POST /login
64+
"""
5565
method, url, params = self._prepare_login(username=username, password=password)
5666
return self.send_request(method, url, params=params)
5767

0 commit comments

Comments
 (0)