Skip to content

Commit 334380b

Browse files
authored
Merge pull request #1796 from weaviate/docstring_user_create
Improve user create docstring
2 parents 93c865a + c7b8c75 commit 334380b

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

weaviate/users/base.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,10 +349,13 @@ def revoke_roles(
349349
)
350350

351351
def create(self, *, user_id: str) -> executor.Result[str]:
352-
"""Create a new db user.
352+
"""Create a new db user and return its API key.
353353
354354
Args:
355355
user_id: The id of the new user.
356+
357+
Returns:
358+
The API key of the newly created user. This key can not be retrieved later.
356359
"""
357360

358361
def resp(res: Response) -> str:

0 commit comments

Comments
 (0)