Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Recommend synchronous DELETE requests return 204 #41

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Recommend synchronous DELETE requests return 204 #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,10 @@ ordering, and page-walking.
Return appropriate HTTP status codes with each response. Successful
responses should be coded according to this guide:

* `200`: Request succeeded for a `GET` calls, and for `DELETE` or
`PATCH` calls that complete synchronously
* `200`: Request succeeded for a `GET` call, and for `PATCH` calls
that complete synchronously
* `204`: Request succeeded for a `DELETE` call that completed
synchronously
* `201`: Request succeeded for a `POST` call that completes
synchronously
* `202`: Request accepted for a `POST`, `DELETE`, or `PATCH` call that
Expand All @@ -128,13 +130,15 @@ for guidance on status codes for user error and server error cases.

#### Provide full resources where available

Provide the full resource representation (i.e. the object with all
attributes) whenever possible in the response. Always provide the full
resource on 200 and 201 responses, including `PUT`/`PATCH` and `DELETE`
requests, e.g.:
Provide _latest copy_ of the full resource representation (i.e. the
object with all attributes) whenever possible in the response.
Always provide the full resource on 200 and 201 responses, including
`PUT`/`PATCH` requests e.g.:

```
$ curl -X DELETE \
$ curl -X PATCH \
-H "Content-Type: application/json" \
-d '{"hostname":"subdomain.example.com"}' \
https://service.com/apps/1f9b/domains/0fd4

HTTP/1.1 200 OK
Expand All @@ -148,6 +152,16 @@ Content-Type: application/json;charset=utf-8
}
```

204 responses such as `DELETE` should never include any content,
only headers should be sent e.g.:

```
$ curl -X DELETE \
https://service.com/apps/1f9b/domains/0fd4

HTTP/1.1 204 No Content
```

202 responses will not include the full resource representation,
e.g.:

Expand Down