diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-22 21:09:52 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-22 21:09:52 +0300 |
| commit | db061f44328ca45f713eaf22d92aae8e76148fda (patch) | |
| tree | 56f1297f970cb41a13e27cae12f5e9665957c885 /doc/development/api_styleguide.md | |
| parent | 7a7345366550f509c03595e0dada7cbd0d73103d (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/api_styleguide.md')
| -rw-r--r-- | doc/development/api_styleguide.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/development/api_styleguide.md b/doc/development/api_styleguide.md index 948644fa786..25c8cbd3fde 100644 --- a/doc/development/api_styleguide.md +++ b/doc/development/api_styleguide.md @@ -100,7 +100,7 @@ Model.create(foo: params[:foo]) ## Using HTTP status helpers -For non-200 HTTP responses, use the provided helpers in `lib/api/helpers.rb` to ensure correct behaviour (`not_found!`, `no_content!` etc.). These will `throw` inside Grape and abort the execution of your endpoint. +For non-200 HTTP responses, use the provided helpers in `lib/api/helpers.rb` to ensure correct behavior (`not_found!`, `no_content!` etc.). These will `throw` inside Grape and abort the execution of your endpoint. For `DELETE` requests, you should also generally use the `destroy_conditionally!` helper which by default returns a `204 No Content` response on success, or a `412 Precondition Failed` response if the given `If-Unmodified-Since` header is out of range. This helper calls `#destroy` on the passed resource, but you can also implement a custom deletion method by passing a block. |