diff options
| author | Sean McGivern <sean@mcgivern.me.uk> | 2017-09-06 10:57:40 +0000 |
|---|---|---|
| committer | Sean McGivern <sean@mcgivern.me.uk> | 2017-09-06 10:57:40 +0000 |
| commit | f497f170697c838747bb7cdaca2d1939f843a00c (patch) | |
| tree | 51b0828080cafe6810b6bfe1c26e7b58f6d3d70c /doc/api/README.md | |
| parent | 7334d718ed079d34fa4e8b376534079e0d4afa60 (diff) | |
| parent | 4dff341af11d651d1ec199d35eebaf4adb92fdd0 (diff) | |
| download | gitlab-ce-f497f170697c838747bb7cdaca2d1939f843a00c.tar.gz | |
Merge branch 'fix-api-docs' into 'master'
Fix wrong API status codes
See merge request !14069
Diffstat (limited to 'doc/api/README.md')
| -rw-r--r-- | doc/api/README.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index a947eed2db8..db61497db53 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -237,8 +237,8 @@ The following table gives an overview of how the API functions generally behave. | ------------ | ----------- | | `GET` | Access one or more resources and return the result as JSON. | | `POST` | Return `201 Created` if the resource is successfully created and return the newly created resource as JSON. | -| `GET` / `PUT` / `DELETE` | Return `200 OK` if the resource is accessed, modified or deleted successfully. The (modified) result is returned as JSON. | -| `DELETE` | Designed to be idempotent, meaning a request to a resource still returns `200 OK` even it was deleted before or is not available. The reasoning behind this, is that the user is not really interested if the resource existed before or not. | +| `GET` / `PUT` | Return `200 OK` if the resource is accessed or modified successfully. The (modified) result is returned as JSON. | +| `DELETE` | Returns `204 No Content` if the resuource was deleted successfully. | The following table shows the possible return codes for API requests. |