Allow post method validation endpoint #294
Conversation
|
Done in pair with @brunobord |
There was a problem hiding this comment.
Looks good, thank you, guys. I have a few little comments but they are not critical.
Also, you should squash your fixup commit (799536d).
docs/swagger/formidable.yml
Outdated
| /forms/{id}/validate/: | ||
| get: | ||
| summary: Validate a form | ||
| summary: Validate a form (GET method). GET and POST are equivalent. |
There was a problem hiding this comment.
Maybe add some comment that GET method will be removed soon?
Validate a form. GET and POST are equivalent, but GET is deprecated
| return self.form_invalid(form) | ||
|
|
||
| post = get | ||
|
|
There was a problem hiding this comment.
I would like to inverse the methods (as we will remove the GET method soon).
def post(self, request, **kwargs):
# all the code goes here
get = post
There was a problem hiding this comment.
Done, also added a deprecation warning as @brunobord suggested!
formidable/views.py
Outdated
| GET method is deprecated in favor of POST | ||
| """ | ||
| warnings.simplefilter('always', category=DeprecationWarning) |
There was a problem hiding this comment.
why adding a simple filter here? let the user's default, it should be fine.
There was a problem hiding this comment.
It was done this way on PeopleAsk, I removed it
brunobord
left a comment
brunobord
left a comment
There was a problem hiding this comment.
small change in the Changelog to be added.
CHANGELOG.rst
Outdated
| master (unreleased) | ||
| =================== | ||
|
|
||
| - Allow POST method for form validation endpoint. |
There was a problem hiding this comment.
FYI, there's a deprecations.rst document in the docs/ directory. I think we should do the following:
- Add a deprecation note here, in the Changelog, to inform the reader that this version (probably 1.3.0) will be the last to support the GET verb for the validation endpoint.
- When we'll do the release, we'll add this point to the
deprecations.rstdocument with the correct version number.
There was a problem hiding this comment.
The changelog has been updated :)
CHANGELOG.rst
Outdated
| =================== | ||
|
|
||
| - Allow POST method for form validation endpoint. | ||
| - Allow POST method for form validation endpoint. GET method is now deprecated, it's support will be dropped in the next version. |
There was a problem hiding this comment.
I prefer active voice:
Deprecation Warning: This version is the last to support the GET verb for the validation endpoint. We'll drop it in the next version.
|
don't forget to squash these! |
syldb
force-pushed
the
allow-post-method-validation-endpoint
branch
from
1c1f6b0 to
6da054b
Compare
syldb
force-pushed
the
allow-post-method-validation-endpoint
branch
from
6da054b to
42dc9dc
Compare
Review
formidable.ymlfile: runtox -e swagger-staticsto rebuild the swagger static files and commit the diff.CHANGELOG.rstUpdated