-
Notifications
You must be signed in to change notification settings - Fork 3
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.
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
Implement an API endpoint an admin can use to update a user's password #779
Draft
eecavanna
wants to merge
9
commits into
main
Choose a base branch
from
update_password
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also add some docs to the swagger UI display for users
2 tasks
eecavanna
commented
Nov 18, 2024
eecavanna
commented
Nov 27, 2024
Comment on lines
+197
to
+207
base_url = os.getenv("API_HOST") | ||
|
||
@retry(wait=wait_random_exponential(multiplier=1, max=60), stop=stop_after_attempt(3)) | ||
def get_token(): | ||
""" | ||
Fetch an auth token from the Runtime API, retrying until successful. | ||
|
||
Randomly wait up to 2^x * 1 seconds between each retry until the range reaches 60 | ||
seconds, then randomly up to 60 seconds afterwards | ||
|
||
""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggest omitting the retry-related info from the function's docstring and documenting it at the decoration level instead. In my mental model of the situation, the function, itself, doesn't "know" it has been decorated.
Suggested change
base_url = os.getenv("API_HOST") | |
@retry(wait=wait_random_exponential(multiplier=1, max=60), stop=stop_after_attempt(3)) | |
def get_token(): | |
""" | |
Fetch an auth token from the Runtime API, retrying until successful. | |
Randomly wait up to 2^x * 1 seconds between each retry until the range reaches 60 | |
seconds, then randomly up to 60 seconds afterwards | |
""" | |
base_url = os.getenv("API_HOST") | |
# Try up to three times, waiting for up to 60 seconds between each attempt. | |
@retry(wait=wait_random_exponential(multiplier=1, max=60), stop=stop_after_attempt(3)) | |
def get_token(): | |
""" | |
Fetch an auth token from the Runtime API. | |
""" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this branch, @shreddd implemented an API endpoint that administrators can use to update the password of an existing user.
Details
(TODO)
Related issue(s)
Fixes #778
Related subsystem(s)
docs
directory)Testing
I tested these changes by implementing a
test_update_user
test function and ensuring that it passes.Documentation
docs
directory)This PR is being created by someone other than the branch author. I do not know the extent to which the branch author has considered documentation.
Maintainability
study_id: str
)# TODO
or# FIXME
black
to format all the Python files I created/modifiedThis PR is being created by someone other than the branch author. I do not know which of the above things the branch author has done.