Implement users.delete RPC function to replace DELETE /api/ui/v0/users/{userId}/ endpoint #4014
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
mathemancer
requested changes
Nov 5, 2024
There was a problem hiding this comment.
Good start!
Please also:
- satisfy the linter
- add a couple tests (see the other RPC function tests)
- wire this up to the actual API by adding the appropriate line in the
common_settings.pyfile - add a docstring similar to the other RPC functions
- wire this into the project documentation in the
docs/docs/api/rpc.mdfile.
Thanks for your effort so far!
| from django.contrib.auth import get_user_model | ||
| from django.core.exceptions import ObjectDoesNotExist | ||
|
|
||
| from mathesar.api.exceptions import APIError |
There was a problem hiding this comment.
The APIError class is only for use in the (now deprecated) REST API. It's not a good idea here. You should raise a custom error class based on a standard Python Exception instead.
mathesar/api/rpc/users/base.py
Outdated
Comment on lines
38
to
43
| except ObjectDoesNotExist: | ||
| raise APIError( | ||
| f"User with ID {user_id} not found.", | ||
| code="user_not_found", | ||
| status_code=404 | ||
| ) |
There was a problem hiding this comment.
You don't need a custom error here. Just let it fail.
|
Procedural note: In the future, please use the PR template. |
|
okay i will use pr template |
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.
Fixes #4000
This pull request implements the users.delete RPC function to replace the existing DELETE /api/ui/v0/users/{userId}/ endpoint. The function follows the specified signature and includes necessary decorators for authorization and error handling. This change enhances the API's structure by moving user model manipulations to the RPC layer, improving maintainability and scalability.
Checklist
Update index.md).developbranch of the repositoryvisible errors.
Developer Certificate of Origin
Developer Certificate of Origin