Change password request from put to post request #1239
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.
Change password request from put to post request
Description
This pull request updates the change password API route in api/v1/routes/auth.py to follow RESTful best practices. Previously, the route used PUT, which is intended for idempotent updates. However, changing a password is an action-based operation, making POST the more appropriate HTTP method.
Related Issue (Link to issue ticket)
#1238
Motivation and Context
The current
PUT
method is inconsistent with common REST API convention.POST
is preferred for actions like password changes, which are not idempotent.POST
signals to integrators that this is a special action, not a regular update.
How Has This Been Tested?
I wrote unit tests to automatically test the fix works as expected
I also tested it manually on postman and got the expected response
Screenshots (if appropriate - Postman, etc):
Types of changes
Checklist: