Skip to content

Improve user create docstring #1796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 19, 2025
Merged

Improve user create docstring #1796

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion weaviate/users/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,10 +349,13 @@ def revoke_roles(
)

def create(self, *, user_id: str) -> executor.Result[str]:
"""Create a new db user.
"""Create a new db user and return its API key.

Args:
user_id: The id of the new user.

Returns:
The API key of the newly created user. This key can not be retrieved later.
"""

def resp(res: Response) -> str:
Expand Down