sets 204 as default status for delete #1532
Conversation
|
@namusyaka, @dblock … any objections, meanings? |
|
This change looks reasonable. |
| @@ -5,7 +5,7 @@ Next Release | |||
|
|
|||
| * [#1503](https://github.com/ruby-grape/grape/pull/1503): Allow to use regexp validator with arrays - [@akoltun](https://github.com/akoltun). | |||
| * [#1507](https://github.com/ruby-grape/grape/pull/1507): Add group attributes for parameter definitions - [@304](https://github.com/304). | |||
| * Your contribution here. | |||
| @@ -41,6 +41,19 @@ Prior to this version the response would be `one is missing`. | |||
|
|
|||
| See [#1510](https://github.com/ruby-grape/grape/pull/1510) for more information. | |||
|
|
|||
| #### Change default status code of DELETE to 204 | |||
|
|
|||
| **Breaking change**: Sets the default response status code for a delete request to 204. | |||
There was a problem hiding this comment.
I don't think you need to highlight this in an extra way as a breaking change. We have never done this for other breaking changes.
| **Breaking change**: Sets the default response status code for a delete request to 204. | ||
| Doing it makes the response more explicit, cause a delete request returns in most cases an empty body – the resource was deleted/voided. By setting it to 204, other as 200, makes the handling on consumer side easier. | ||
|
|
||
| To achieve the old behaviour, one has to set it explicitly: |
There was a problem hiding this comment.
Lets make this American, so behavior :)
| #### Change default status code of DELETE to 204 | ||
|
|
||
| **Breaking change**: Sets the default response status code for a delete request to 204. | ||
| Doing it makes the response more explicit, cause a delete request returns in most cases an empty body – the resource was deleted/voided. By setting it to 204, other as 200, makes the handling on consumer side easier. |
There was a problem hiding this comment.
How about A status of 204 makes the response more distinguishable and therefore easier to handle on the client side, particularly because a DELETE request typically returns an empty body as the resource was deleted or voided.
| delete :id do | ||
| status 200 | ||
| 'foo successfully deleted' | ||
| end |
There was a problem hiding this comment.
Add a note like For more information see ... referencing this pull request.
| @@ -41,6 +41,19 @@ Prior to this version the response would be `one is missing`. | |||
|
|
|||
| See [#1510](https://github.com/ruby-grape/grape/pull/1510) for more information. | |||
|
|
|||
| #### Change default status code of DELETE to 204 | |||
There was a problem hiding this comment.
Should the change, so The default status code for DELETE is now 204 instead of 200.
|
I support this. Made some minor UPGRADING comments. I think we should document this in README as well, along with the default status code being 200 for the other verbs. |
|
@dblock … please can you provide a sample, how the changelog should looks like, so that danger accept it? |
- adds changelog entry - addresses comments - next try to make danger happy ;)
|
Sounds like you got it, thanks! |
|
I'm merging this. |
|
This seems an odd change to make.. or, IMHO if the request did return a response it should switch back to 200.. (e.g. 204 should only be returned IF there really is no content).. As it is incorrect (according to the HTTP spec) to return ANY body when a 204 response is returned. |
No description provided.